API
Налаштування webhook

API url: https://voip-dev.mik.ua/api.php?set-webhook

Приклад запиту:

{ "url":"https://my.example.com", "events":[ "call", "internal" ], "actionid": "id-1", "pbx": "mypbxname", "timestamp": 1613125191.2345, "hash": "afe6c0b121ce90e7c38328d875c4e272" }

Параметри:

Назва Опис Допустимі значення
url URL адреса для отримання повідомлень про події. Обов'язкове поле. підтримується тільки https
events Про які події повідомляти. Обов'язкове поле. call сповіщення про виклики
internal сповіщення про зміну статусу телефонів
actionid ідентифікатор запиту, буде повернуто у відповіді текстова строка до 32 символів
pbx Назва АТС для запиту. Обов'язкове поле.
timestamp Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash md5(pbx:timestamp:apikey). Обов'язкове поле. строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Відповідь:

{ "status": 0, "status_message": "success", "actionid": "id-1", "pbx": "mypbxname", "timestamp": 1613125191.2345, "hash": "afe6c0b121ce90e7c38328d875c4e272" }

Параметри відповіді:

Назва Опис Можливі значення
status Код відповіді. 0 - успіх, все інше помилка. Обов'язкове поле. 0 або додатне ціле число
status_message Опис коду відповіді. Обов'язкове поле.
actionid Ідентифікатор запиту, якій було передано в запиті. текстова строка до 32 символів
pbx Назва АТС для запиту. Обов'язкове поле коли status=0.
timestamp Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле коли status=0.
hash md5(pbx:timestamp:apikey). Обов'язкове поле коли status=0. строка 32 символа. API Key можна подивитися в налаштуванні АТС.