Оповещение о событиях¶
Получение перечня событий¶
Наименование метода в API: webhook/get-events. В метод входные параметры не передаются
В случае успеха возвращается массив со следующими параметрами:
Параметр | Описание | Пример |
---|---|---|
id | ID события | 1 |
event | Название события | call-start |
description | Описание события |
Добавление оповещения о сабытии¶
Наименование метода в API: webhook/add. Список передаваемых параметров:
Параметр | Описание | Пример |
---|---|---|
event_id | ID союытия | 1 |
url | Адрес для уведомления | http://test.url |
params | Массив с дополнительными параметрами | array(„key“=>„1234“) |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение | Описание |
---|---|
1 | Оповещение добавилось |
Обновление оповещения о сабытии¶
Наименование метода в API: webhook/update. Список передаваемых параметров:
Параметр | Описание | Пример |
---|---|---|
event_id | ID союытия | 1 |
url | Адрес для уведомления | http://test.url |
params | Массив с дополнительными параметрами | array(„key“=>„1234“) |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение | Описание |
---|---|
1 | Оповещение обновилось |
Удаление оповещения о событии¶
Наименование метода в API: webhook/delete. Список передаваемых параметров:
Параметр | Описание | Пример |
---|---|---|
event_id | ID союытия | 1 |
Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):
Значение | Описание |
---|---|
1 | Оповещение удалилось |
Получить информацию о текущем оповещении¶
Наименование метода в API: webhook/get. Список передаваемых параметров:
Параметр | Описание | Пример |
---|---|---|
event_id | ID союытия | 1 |
Метод возвращает массив следующего содержимого или ошибку:
Параметр | Описание | Пример |
===================== 1 | ||
url | Адрес для уведомления | http://test.url |
params | Массив с дополнительными параметрами | array(„key“=>„1234“) |