Завершение работы кастомного блока

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

Запрос

Тело запроса

В теле запроса (body) нужно указать:

• data — данные, которые можно получить по результатам работы блока;
• token — токен интеграции, обязательный параметр. Приходит на внешний сервис, который был указан в поле URL блока при его выполнении.

{
  "data": {},
  "token": "kmijwgrcjadyqncipfxbmkreewcgqfgaogdwvcgxnjkvhcrjmhurtwelwyl"
}

Пример запроса

curl --location --request POST 'manual.bot.one/api/vertex/v1/complete' \
--header 'Cookie;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpbnN0YW5jZSI6IjI3cmVncmVzcyIsImRpYWxvZ19pZCI6MzE0LCJ2ZXJ0ZXhfaWQiOjI0MDg5LCJzZXNzaW9uX2lkIjoyOTU3fQ.OGXArnLTIsyIYA269mbTEVl_TMqcz_yTAjd5ES31tl0",
    "data": null

Ответ

Успешный ответ

204 — Успешное выполнение запроса. Работа блока завершена.

Коды ошибок

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

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

Запрос

Тело запроса

В теле запроса (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
}

Параметры ответа

Коды ошибок