Использовать сторонний сервис через API

Вы можете обращаться в диалоге к любому сервису, имеющему публичный API. Например, передавать заявки в CRM или создавать тикеты в системе управления задач и проектов на основе собранных данных.

Для этого используйте блок Webhook.

Настройки блока Webhook

На боковой панели доступны настройки блока:

Настройка Описание Пример

Настройка	Описание	Пример
Название	Название блока, может содержать только цифры и латинские буквы. Название позволит идентифицировать информацию, полученную в результате запроса, в данных диалога. Кроме того, вы можете использовать название как переменную для публикации данных в диалоге	example
URL	URL запроса	https://local.doc.one/api/v2/documents https://local.doc.one/api/v2/documents?@id
Метод	Метод запроса (обычно указан в описании запроса): GET – для получения информации от сервиса POST – для добавления информации на сервис PUT – для обновления информации на сервисе
Тип	Тип контента в теле запроса Body (доступно только для POST и PUT)
	JSON – соответствует типу `application/json`. Используется для описания данных и рядов данных	{"Data": { "Помещение сдается с мебелью?": ["Нет"], "Тип помещения": ["Жилое"], "Количество дней": [17], } }
	Form – соответствует типу `application/x-www-form-urlencoded`. Используется в небольших запросах. Значения кодируются в кортежах с ключом, разделённых символом `&`, с `=` между ключом и значением	'Тип помещения=Жилое'&'Количество дней=17'
	Multipart – соответствует типу `multipart/form-data`. Используется, если нужно отправить данные разных форматов.	--form 'Тип помещения="Жилое"' / --form 'Схема=@"/C:/Изображения/picture.jpeg"'
Базовая авторизация	Авторизация необходима, чтобы отправлять запрос к сервису. Если сервис поддерживает базовую авторизацию, укажите логин и пароль через разделитель.	login\|password
Содержимое	Укажите параметры заголовка и тела запроса

Название

Название блока, может содержать только цифры и латинские буквы. Название позволит идентифицировать информацию, полученную в результате запроса, в данных диалога. Кроме того, вы можете использовать название как переменную для публикации данных в диалоге

example

URL

URL запроса

https://local.doc.one/api/v2/documents
https://local.doc.one/api/v2/documents?@id

Метод

Метод запроса (обычно указан в описании запроса):

GET – для получения информации от сервиса
POST – для добавления информации на сервис
PUT – для обновления информации на сервисе

Тип

Тип контента в теле запроса Body (доступно только для POST и PUT)

JSON – соответствует типу application/json. Используется для описания данных и рядов данных

{"Data": {
        "Помещение сдается с мебелью?": ["Нет"],
        "Тип помещения": ["Жилое"],
        "Количество дней": [17],
    }
}

Form – соответствует типу application/x-www-form-urlencoded. Используется в небольших запросах. Значения кодируются в кортежах с ключом, разделённых символом &, с = между ключом и значением

'Тип помещения=Жилое'&'Количество дней=17'

Multipart – соответствует типу multipart/form-data. Используется, если нужно отправить данные разных форматов.

--form 'Тип помещения="Жилое"' /
--form 'Схема=@"/C:/Изображения/picture.jpeg"'

Базовая авторизация

Авторизация необходима, чтобы отправлять запрос к сервису. Если сервис поддерживает базовую авторизацию, укажите логин и пароль через разделитель.

login|password

Содержимое

Укажите параметры заголовка и тела запроса

Note

Вы можете использовать переменные в URL запроса, в базовой авторизации, в Headers и Body. Для выбора доступной переменной, введите символ @ и найдите значение в списке. Автоматически сгенерированные переменные отображаются в списке, только если был отправлен проверочный запрос и был получен успешный ответ на него.

Проверка запроса

Для проверки запроса:

Нажмите кнопку Тест запроса на боковой панели
Появится сообщение об успешном или ошибочном выполнении запроса. Нажмите кнопку Подробнее для просмотра результата
Появится окно Отладчик.

Если запрос выполнен успешно, в окне отобразится ответ запроса. Новые переменные из этого запроса будут доступны в блоке Webhook.

Если запрос ошибочный – подробное описание ошибки. Поправьте запрос и повторите попытку.

Результаты запроса

В результате запроса Bot.one получит данные или отправит данные в сторонний сервис. Эти данные или ответ сервиса будут записаны в переменную с названием блока (поле Название на боковой панели).

Чтобы опубликовать эти данные в диалоге, добавьте в бот блок Сообщение и укажите в сообщении переменную.

Публикация результатов запроса в диалоге

Результаты запроса также доступны в данных диалога.

Как передать файл из диалога в другой сервис

Чтобы передать файл из диалога в другой сервис:

Добавьте блок, который позволит запросить у респондета файл. Например, блок Сбор данных с типом Файл.
Задайте для этого блока переменную, например, file
Добавьте блок Webhook и укажите в нем настройки: Метод – POST, Тип – Multipart
В теле запроса укажите через переменную файл, который нужно прикрепить. Например, file: @file

Файл, который респондент загрузит в диалог, будет передан в другой сервис.