Создание и запуск нового диалога

POST /v2/dialog/{BotID}/create

Запрос позволяет создать новый диалог по идентификатору бота и запустить его. То есть бот сразу начнет публиковать сообщения в диалоге. Вы можете указать переменные для передачи их в диалог.

Запрос

Параметры пути

НазваниеТипОбязательныйОписаниеПример
BotIDintegerДаИдентификатор бота1446

Query параметры

НазваниеТипОбязательныйОписаниеПример
responsebooleanНет'true' — в ответе вернется идентификатор созданного диалога, 'false' — в ответе не будет возвращаться идентификатор созданного диалогаtrue
variablesstringНетПеременные, которые можно передать в диалог (например, имя респондента, номер договора и прочее){"name":"Dasha"}

Тело запроса

В теле запроса вы можете указать:

  • variables — переменные для передачи их в диалог;
  • response — получать в ответе id и uuid созданного диалога (true) или нет (false).
{
    "response": true,
    "variables": "{ \"name\": \"User\" }"
}

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

curl --location -g --request POST 'https://manual.bot.one/api/v2/dialog/1446/create?variables={"name":"Dasha"}&response=true' \
--header 'Authorization: Basic ZC5keW1icnlsb3ZhQHByvLnRlY2g6Q2F2ZTIwMTY=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "response": true,
    "variables": "{ \"name\": \"User\" }"
}'

Ответ

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

200 - Успешное выполнение запроса. Если в теле запроса вы передали параметр 'response': true, в ответе вернется идентификатор (id) и уникальный идентификатор (uuid) созданного диалога.

{
    "dialogId": 371,
    "dialogUUID": "4c9b89a3-0fbc-4b01-9d9b-63a7b1ca4ffa"
}

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

НазваниеОписание
dialogIdИдентификатор созданного диалога
dialogUUIDУникальный идентификатор созданного диалога

Коды ошибок

Код ошибкиНаименованиеОписание
401UnauthorizedПроверьте логин и пароль для авторизации в системе
403ForbiddenПроблема с подключением к инстансу или диалогу. Это может быть связано с невалидным токеном, блокировкой инстанса, остановкой сервиса, удалением или завершением диалога и пр.
404Not FoundОбъект не найден. Проверьте, правильно ли указаны значения параметров