Interaction with bot

post

https://example.com/gateway/stream

Endpoint used to conduct conversation with bot. It accepts user input and responds with bot answers. Returns response in Sever-sent events format. Stream contains zero or more PartialResponse events followed by exactly one Response or StreamError event. The final Response event contains all partial responses.

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

object

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Bad Request