Внешний запрос

В этой инструкции мы расскажем вам о функции «Внешний запрос». Это действие позволяет нам создавать интеграции с любыми сервисами, у которых есть открытое API. В этой инструкции будет пример интеграций с «SMS aero» и «Звонок» .

Для настройки любого запроса, нужно найти API-документацию сервиса.
SMS aero - https://smsaero.ru/cabinet/settings/apikey/

На этой странице мы уже видим Api key (текущий ключ) и вашу почту в шапке страницы. Их нужно запомнить, т.к. они пригодятся в будущем.

В документации пролистываем до нужного вам запроса. Мы приведем пример на отправке одного сообщения

https://email:api_key@gate.smsaero.ru/v2/sms/send?number=79990000000&text=your+text&sign=SMS Aero

вам нужно будет заменить:

1. email - вашу почту, которую мы записали чуть раньше
2. api_key - текущий ключ
3. 79990000000 - {%phone%} переменная в botman
4. your+text - ваш текст sms
5. SMS Aero - Имя отправителя

Далее вставляем получившийся url в настройки внешнего запроса

Сохраняем и можем тестировать. 

У нас получилось отправить сообщение. Надпись "на модерации" означает, что сообщение скоро отправиться

Звонок

Далее настроим интеграцию с сервисом «Звонок»
Документация: https://api-docs.zvonok.com

Простой пример url: 

https://zvonok.com/manager/cabapi_external/api/v1/phones/call/?public_key=your_public_key&phone=customer_phonenumber&campaign_id=your_campaign_id

1. your_public_key - найдете в настройках (https://zvonok.com/manager/users/profile-settings/)
2. customer_phonenumber - {%phone%} или любой номер телефона
3. your_campaign_id - id компании (https://zvonok.com/manager/phones/all/)

Получившийся url вставляем в URL запроса. 

Вы можете протестировать запрос прямо в действии. Ошибка будет обозначена так:

В теле ответа чаще всего будет выведено описание ошибки.

если запрос отправлен успешно, будет выведен код 200 в зеленом блоке

Заголовки

В этом разделе задаются Заголовки для отправляемого запроса.

Вы можете:

• Добавлять/удалять заголовки
• Добавлять пользовательские поля в Value. При использовании переменных значение заголовка будет свое для каждого подписчика

Тело

В этом разделе описывается тело запроса. Код для раздела Тело нужно взять из настроек стороннего сервиса.

Тело должно быть описано в формате JSON. 

При заполнении тела запроса можно использовать пользовательские поля.

В правой части "Предпросмотр" выполняется автоматическая валидация и форматирование введенного тела.

ВАЖНО! Данный раздел недоступен для запросов с типом GET

Сопоставление ответов

В этом разделе вы можете сохранить ответ сервера в пользовательские поля

Для этого нужно:

• Добавить правило сопоставления, нажав на кнопку «Добавить правило сопоставления»
• Указать JSON Path - путь в теле ответа, по которому можно получить конкретное значение ответа. Сайт JSON Path: https://jsonpath.com/  
• Указать пользовательское поле, в которое будет сохраняться полученное в ответе значение

Если вы не нашли ответ на свой вопрос, то напишите нам в техподдержку ВК

Зарегистрироваться в сервисе