Request / Response Format
The following are the Request and Response format of the bot:
Request payload when a visitor lands on the website
| Inputs | Type | Description |
| visitor | Map | Details of the website visitor |
| handler | String | A trigger handler is initiated (Value: trigger) |
| org_id | String | Which will contain the org ID of the portal |
| request | Map | Details of the chat message request |
| Inputs | Type | Description |
| message | Map | Details of the message in the conversation (Attribute: text) |
| visitor | Map | Details of the website visitor |
| operation | String | Details of the operations happen during the chat conversation (values: chat, message) chat -For the first message of the visitor message - For subsequent replies from visitor |
| handler | String | The message handler is initiated (Value : message) |
| org_id | String | Which will contain the org ID of the portal |
| request | Map | Details of the chat message request |
| attachments | Array | List of files attached in the chat message request. Note: If this is not added, an empty array will be returned. |
Request payload when a context gets completed
| Inputs | Type | Description |
| answers | String | Details of the message in the conversation (Attribute: text) |
| visitor | Map | Details of the website visitor |
| context_id | String | ID of the context currently used |
| handler | String | The context handler is initiated (Value : context) |
| org_id | String | Which will contain the org ID of the portal |
Visitor Objects Format:
The visitor object is a map containing the profile information of the website visitor. Learn More
Attachment Object format
The attachment is a collection object, which contains the files that are shared by the visitor during the conversation as a message. Learn More
Message Object Format
Each text message in the conversation will be considered as the message object. Learn More
Response format
The input and output responses given by the bot during the conversation. Learn More