Interaction with bot

post

https://example.com/gateway

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Bot gateway request

text

string

required

Message sent by user

source_type

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

author

string

required

length ≤ 128

Name of the author of the message.

uuid

string

required

length ≤ 64

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

suid

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

Additional, optional data attached to the request and usable by the bot. Two forms are accepted:
(1) an object of key/value pairs - every value is treated as non-sensitive and kept for the whole conversation;
(2) an array of self-describing entries, where each entry declares its own sensitivity and lifetime.
A sensitive value may be used by the bot but is never shown in cleartext (masked in analytics and logs, encrypted at rest).
A request-lifetime value is available only for the current turn and is not persisted.

Responses

200Success

400Bad Request

401Unauthorized

429Too Many Requests - rate limit exceeded (per IP or per session)