Веб-хуки (WebHooks) — это механизм оповещения системы о событиях. Например, когда происходит событие в MCN Telecom, веб-хук запрашивает адрес и параметры этого события, а затем предаёт их стороннему приложению.
Обычно «пользовательские обратные вызовы по HTTP» запускаются каким-либо событием, например, переводом звонка на другого внутреннего абонента или входящим звонком на виртуальную АТС. Когда происходит это событие, исходный сайт отправляет HTTP-запрос на URL-адрес, указанный для веб-хука. Пользователи могут настроить их так, чтобы события на одном сайте вызывали действия на другом.
Чтобы создать Веб-хук на сайте MCN Telecom, перейдите в раздел «Интеграции» >> вкладку «Веб-хуки» и нажмите «Новый веб-хук».
В открывшемся модальном окне выберите тип события веб-хука и нажмите кнопку «Создать».
Наиболее распространённые типы событий, на которые можно создать веб-хук:
- Звонки телефонии (входящие, исходящие, ответ на звонок, начало / конец звонка и т.д.)
- Звонки ВАТС;
- Авторизационные звонки (Password Call, Flash Call и т.д.);
- СМС;
- Calltracking;
- Звонки голосового робота;
Весь список событий можно посмотреть в окне создания веб-хука. При создании, веб-хук подписывается на нужное событие и при возникновении события, отправляет запрос на указанный адрес.
Поля настройки веб-хука
- Название — название веб-хука;
- URL — адрес, на который, будет отправляться веб-хук;
- Повторять в случае ошибки — по умолчанию функция включена. при проставленной галочке, в случае ошибки при отправки веб-хука на заданный URL повторит его отправку (Рекомендуется оставлять эту функцию включённой).
- Выберите метод — типы запроса GET или POST:
- GET - запрос запрашивает данные с определенного ресурса (сайта);
- POST - запрос отправляет данные на сервер для последующей их обработки;
- Выберите тип данных — типы данных JSON или Text:
- JSON - структура данных в формате JSON.
- Text - вольное заполнение. можно заполнить по своему усмотрению и под свои нужны в любом формате и любой структуре.
6. Доступные параметры — параметры, которые зависят от типа события. Доступные параметры можно добавлять в любое место настроек веб-хуков простым кликом по ним.
7. Пользовательские параметры — дополнительные параметры которые добавятся в структуру JSON в дополнение к отмеченными галочками синими переменными выше.
8. Query параметры — параметры запроса URL (URL Query Parameters) являются дополнительной информацией, которую можно добавить в URL-адрес. Состоит из двух обязательных элементов - из самого параметра и его значения, разделенных знаком равенства (=).
9. Заголовки HTTP (HTTP Headers) — несколько строчек текста в определенном формате, которые либо уточняют запрос, либо описывают содержимое тела сообщения.
Более подробней о типах запросов см.:
Статья помогла?
Отлично!
Спасибо за ваш отзыв
Извините, что не удалось помочь!
Спасибо за ваш отзыв
Комментарий отправлен
Мы ценим вашу помощь и постараемся исправить статью