Получение асинхронных событий

Обновлено 6 марта 2025

GET

/chatapi/bot/{token}/events

Получение асинхронных событий от сервера.

Запрос

Path Parameters

token

string

required

Токен канала Chat API. Значение токена можно получить при добавлении интеграции в проекте SaluteBot в Studio.

Query Parameters

clientId

string

required

Идентификатор клиента.Значение clientId генерируется клиентом(вашим приложением). Произвольная строка.

all

boolean

Если true, возвращает в ответе все типы сообщений - сообщение пользователя, ответы бота и state. Если false возвращает только сообщения пользователя и ответы бота.

cid

string

Идентификатор соединения. Это идентификатор, по которому можно определить, откуда именно было отправлено сообщение. Например, с веб-версии или мобильного приложения и т.д.

ts

string

Значение должно соответствовать регулярному выражению ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}$

Время, начиная с которого нужно фильтровать события. Формат: Unix-время или строка.

Ответы

• 200

OK

• application/json

• Схема
• Пример из схемы

Schema

hasMore

boolean

required

По умолчанию: false

Есть ли на сервере события, которые не вместились в ответ. Метод возвращает в одном ответе не более 250 событий.

events

object[]

required

Список полученных событий.

Array [

type

EventType (string)

required

Возможные значения: [request, botResponse, humanResponse, state]

Тип события

event

object

required

oneOf

• BotResponse
• HumanResponse

token

string

Токен канала Chat API.

clientId

string

required

Значение clientId генерируется клиентом(вашим приложением). Произвольная строка.

questionId

uuid

required

Идентификатор сообщения. Значение должно быть уникально в рамках вашей интеграции, рекомендуется uuid v4.

data

object

required

Содержимое ответа бота. JSON объект может быть расширен из сценария любыми дополнительными полями. По умолчанию содержит список реплик бота и текстовый ответ. Возможные типы реплик описаны в https://developers.sber.ru/docs/ru/salutebot/chatapi-integration.

replies

object[]

Список реплик сформированных в рамках обработки запроса клиента

answer

string

Текст ответа бота на запрос клиента. Содержит склеенный список текстовых фраз.

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}$

Время отправки запроса по часовому поясу UTC.

token

string

Токен канала Chat API.

clientId

string

required

Значение clientId генерируется клиентом(вашим приложением). Произвольная строка.

questionId

uuid

required

Идентификатор сообщения. Значение должно быть уникально в рамках вашей интеграции, рекомендуется uuid v4.

data

object

required

Содержимое кастомного ответа бота, отправленного с помощью reply с типом raw.

timestamp

string

required

Значение должно соответствовать регулярному выражению ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}$

Время отправки запроса по часовому поясу UTC.

endSession

boolean

required

Завершена ли текущая сессия.

]

{
  "hasMore": false,
  "events": [
    {
      "type": "request",
      "event": {
        "query": "string",
        "clientId": "string",
        "clientInfo": {
          "firstName": "string",
          "lastName": "string",
          "userPic": "string"
        },
        "questionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "data": {},
        "timestamp": "2020-04-01T12:30:00.000",
        "cid": "string"
      }
    }
  ]
}

Loading...

Loading...