API Documentation
Chatbot Appearance
Chatbot Custom Content
Chatbot Follow Up Prompts
Chatbot Icons
Chatbot Links
Chatbot Messages
Chatbot Personas
Chatbot Prompts
Chatbot Quick Prompts
Chatbot Settings
Chatbot Threads
Create Thread
Create an empty thread of the chatbot.
{
"success": true,
"message": "Created the chatbot thread successfully",
"data": {
"thread": {
"threadId": "d2cd2d88-bac1-48de-a7b4-19797451f47g",
"mode": "AI",
"messages": [],
"startedAt": "2024-05-07T06:26:01.674375Z",
"updatedAt": "2024-05-07T06:26:01.674375Z",
"chatUserId": null,
"chatbotId": "361628903185318481",
"chatUser": null
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Id of the chatbot
Body
Email of the user that is going to chat in the thread.
Mode of the chat
AI, AGENT If you pass the threadId, new thread will be created with this threadId. Otherwise, random threadId will be generated.
Response
Data returned from the server
Chatbot Thread
Id of the chatbot
Chat User
Timestamp indicating when the user is created
Email Id of the user
Id of the user
Name of the user
Phone Number of the user
Timestamp indicating when the user is last updated
Indicates whether the user is verified or not
Id of the user chatting in the thread
Timestamp indicating when the thread has been ended
Indicates whether conversation has been escalated or not
Messages of the thread
Indicates whether this message is escalated or not
GPT Model used to answer the question
Url of the icon used in this message
Id of the message
Type of the message in the thread
NORMAL_MESSAGE, USER_MESSAGE, AGENT_MESSAGE, SYSTEM_MESSAGE Quick prompts that have been configured by chatbot owner
Description of the quick-prompt. This is the message that will be sent to the chatbot when you click on the quick-prompt inside the chatbot.
Id of the quick-prompt
Link of the quick prompt. If this link is not null, then when you click on the quick prompt in the chatbot, this link will be opened instead of sending a message to the chatbot.
Title of the quick-prompt. This is the text that is shown as button in the chatbot.
User's reaction to the message
POSITIVE, NEGATIVE, NEUTRAL Sources used to answer the question
Type of the message if type of the message is SYSTEM_MESSAGE
CONVERSATION_ESCALATED, EXCEEDED_USAGE_LIMITS, EMAIL_VERIFIED, ENTERED_WRONG_OTP, PROVIDED_EMAIL, PERSONA_SELECTED, PROBLEMS_WITH_UPSTREAM_PROVIDER Mode of the thread
AI, AGENT Timestamp indicating when the thread has been started
Id of the chatbot thread
Number of messages that are read in this thread
Timestamp indicating when the thread has been last updated
The token which is sent in header in the calls made to the above webhook url for all messages
All messages are sent to this webhook url
Overall message regarding the operation performed
Indicates whether this is success response or error response
Was this page helpful?
{
"success": true,
"message": "Created the chatbot thread successfully",
"data": {
"thread": {
"threadId": "d2cd2d88-bac1-48de-a7b4-19797451f47g",
"mode": "AI",
"messages": [],
"startedAt": "2024-05-07T06:26:01.674375Z",
"updatedAt": "2024-05-07T06:26:01.674375Z",
"chatUserId": null,
"chatbotId": "361628903185318481",
"chatUser": null
}
}
}