Создание нового диалога

GET /v2/dialog/{BotID}/create

Запрос позволяет создать новый диалог по идентификатору бота. Диалог будет создан, но не начат — то есть бот не будет публиковать сообщения.

Запрос

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

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

Query параметры

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

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

curl --location -g --request GET 'https://manual.bot.one/api/v2/dialog/1446/create?variables={"name":"Dasha"}' \
--header 'Authorization: Basic ZC5keW1icnlsb3ZhQHByvLnRlY2g6Q2F2ZTIwMTY='

Ответ

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

200 - Успешное выполнение запроса — возвращается уникальный идентификатор (uuid) созданного диалога.

{
    "dialogId": "ef313216-e8d9-46a9-b95e-8060058bd43f"
}

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

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

Коды ошибок

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