Отправка сообщения боту

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

POST

/chatapi/bot/{token}

Отправка запроса клиента или события в чат-приложении.

Запрос

Path Parameters

token

string

required

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

• application/json

Body

oneOf

• Query
• Event

query

string

required

Текст запроса клиента.

clientId

string

required

Идентификатор клиента.

clientInfo

object

Информация о клиенте для передачи в операторский чат.

firstName

string

Имя клиента.

lastName

string

Фамилия клиента.

userPic

uri

Ссылка на аватар клиента.

questionId

uuid

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

data

object

Произвольный объект для передачи дополнительных данных в сценарий. Данные доступны в сценарии в поле $request.rawRequest.data.

timestamp

string

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

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

cid

string

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

event

string

required

Название события.

clientId

string

required

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

clientInfo

object

Информация о клиенте для передачи в операторский чат.

firstName

string

Имя клиента.

lastName

string

Фамилия клиента.

userPic

uri

Ссылка на аватар клиента.

questionId

uuid

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

data

object

Произвольный объект для передачи дополнительных данных в сценарий. Данные доступны в сценарии в поле $request.rawRequest.data.

timestamp

string

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

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

cid

string

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

Ответы

• 200

OK

• application/json

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

Schema

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

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

{}

Loading...

Loading...