Chat bot / Message

Sends a follow-up message in an existing chat-bot session.

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/chat_bot/message

Method: POST

Authorisation: No authentication needed

Request Arguments
Name Type Source
inputDTO_chat_bot_message_inputBody

  Request body example

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_message_input
NameTypeReadOnlyDescription
form_keyStringForm key
ticket_idInt32Ticket id
session_tokenStringSession token
messageStringMessage
DTO_chat_bot_response
NameTypeReadOnlyDescription
foundBooleanTrue when the bot found knowledge and produced a reply. False = show the classic form.
replyStringReadOnlyReply
ticket_idInt32The chat session ticket (local id). Set once the first bot reply exists.
session_tokenStringSecret session token. Required on follow-up messages, rating and form promotion.