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

POST /vertex/v1/dialog/send_message

Запрос позволяет отправить в диалог текстовое сообщение от лица бота во время выполнения кастомного блока.

Запрос
Тело запроса
В теле запроса (body) нужно указать:
  • token — токен интеграции. Приходит на внешний сервис, который был указан в поле URL блока при его выполнении;

  • text — текст сообщения, которое будет отправлено;

  • typing — отображать, что бот набирает сообщение true или нет false.

Обязательный параметр.

{
  "token": "kmijwgrcjadyqncipfxbmkreewcgqfgaogdwvcgxnjkvhcrjmhurtwelwyl",
  "text": "Сообщение, которое будет отправлено",
  "typing": true
}
Пример запроса
curl --location --request POST 'manual.bot.one/api/vertex/v1/dialog/send_message' \
--header 'Cookie;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "token": "kmijwgrcjadyqncipfxbmkreewcgqfgaogdwvcgxnjkvhcrjmhurtwelwyl",
  "text": "Сообщение, которое будет отправлено",
  "typing": true
}'
Ответ
Успешный ответ

200 - Успешное выполнение запроса. В ответе вернется идентификатор сообщения и временная метка (timestamp).

{
  "message_id": 123,
  "created_at": 1669947527
}
Параметры ответа
НазваниеОписание

message_id

Идентификатор отправленного сообщения

created_at

Временная метка (timestamp) отправки сообщения

Коды ошибок
Код ошибкиНаименованиеОписание

400

Bad Request

Убедитесь, что все параметры запроса имеют нужный формат

403

Forbidden

Проблема с подключением к инстансу или диалогу. Это может быть связано с невалидным токеном, блокировкой инстанса, остановкой сервиса, удалением или завершением диалога и пр.

Статья помогла вам?