Interaction with bot

"Endpoint used to conduct conversation with bot. It accepts user input and responds with bot answers."

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Bot gateway request

string
required

Message sent by user

string
enum
required

Type of the source by which user is contacting. For example:
- phone - user is contacting by phone
- twitter - user message comes from twitter integration

string
required
length ≤ 128

Name of the author of the message.

string
required
length ≤ 64

Project identifier - uuid of a project for which bot has to respond

string
required
length ≤ 64

Session identifier. Session is unique identifier for one particular session. It can be an uuid or just random string.
If bot responds to user and integrator wants to send another message in the same context it has to attach the same suid
Example:
1. User sends first message in the conversation - set the suid for ex. "r123111-a99c-480c-89e1-e26b2f3f76b7"
2. Gateway returns message to user
3. User says something more in that particular conversation - use the same suid as before "r123111-a99c-480c-89e1-e26b2f3f76b7"

extra_data
object

This is additional and optional field, could be used for additional integration

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json