Chat bot / Start
Starts a chat-bot session with the visitor's first message.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/chat_bot/start
Method: POST
Authorisation: No authentication needed
Response object
Response status: 200 (OK)
Response type: DTO_chat_bot_response
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest)
Response body example
DTO_chat_bot_start_input
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| form_key | String | Form key | |
| message | String | Message | |
| sys_submitted_from | String | Host page url the form is embedded on (same source as the form's sys_submitted_from) |
DTO_chat_bot_response
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| found | Boolean | True when the bot found knowledge and produced a reply. False = show the classic form. | |
| reply | String | ReadOnly | Reply |
| ticket_id | Int32 | The chat session ticket (local id). Set once the first bot reply exists. | |
| session_token | String | Secret session token. Required on follow-up messages, rating and form promotion. |
