Создание нового диалога
Запрос позволяет создать новый диалог по идентификатору бота. Диалог будет создан, но не начат — то есть бот не будет публиковать сообщения.
Запрос
Параметры пути
Название | Тип | Обязательный | Описание | Пример |
---|---|---|---|---|
BotID | integer | Да | Идентификатор бота | 1446 |
Query параметры
Название | Тип | Обязательный | Описание | Пример |
---|---|---|---|---|
variables | string | Нет | Переменные, которые можно передать в диалог (например, имя респондента, номер договора и пр) | {"name":"Dasha"} |
Пример запроса
curl --location --request GET 'manual.bot.one/api/v1/dialog/1446/create' \
--header 'Authorization: Basic ZC5keW1icnlsb3ZhQHByvLnRlY2g6Q2F2ZTIwMTY='
Ответ
Успешный ответ
200 - Успешное выполнение запроса — возвращается уникальный идентификатор (uuid) созданного диалога.
{
"dialogId": "db193a50-6d43-4954-9ef5-8f1fa79dd38b"
}
Параметры ответа
Название | Описание |
---|---|
dialogId | Уникальный идентификатор созданного диалога |
Коды ошибок
Код ошибки | Наименование | Описание |
---|---|---|
401 | Unauthorized | Проверьте логин и пароль для авторизации в системе |
403 | Forbidden | Проблема с подключением к инстансу или диалогу. Это может быть связано с невалидным токеном, блокировкой инстанса, остановкой сервиса, удалением или завершением диалога и пр. |
404 | Not Found | Объект не найден. Проверьте, правильно ли указаны значения параметров |