Документація

API

Налаштування webhook
Отримання webhook
Видалення webhook
Повідомлення статусу внутрішнього телефону
Повідомлення про виклик
Повідомлення ping
Відомості про стан телефону
Відомості про дзвінок
Отримання запису розмови
Створення виклику
Отримання Контакту
Створення або оновлення Контакту
Видалення Контакту
Команда віртуального діалплану IfAPI
Створення АТС
Зміна налаштувань АТС

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

API url: https://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 можна подивитися в налаштуванні АТС.

Отримання webhook

API url: https://mik.ua/api.php?get-webhook

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

{
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

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

Відповідь:

{
   "status": 0,
   "status_message": "success",
   "webhooks":[
      {"url":"https://www1.example.com", "active":true, "events"=["call"]},
      {"url":"https://www2.example.com", "active":false, "events"=["call","internal"]}
   ],
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

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

Назва	Опис	Можливі значення
status	Код відповіді. 0 - успіх, все інше помилка. Обов'язкове поле.	0 або додатне ціле число
status_message	Опис коду відповіді. Обов'язкове поле.
webhooks.url	URL адреса для отримання повідомлень про події
webhooks.active	признак працездатности. false в разі неможливості виконати запит URL або отримання будь якої HTTP-помилки.	true or false
webhooks.events	на які події підписано webhook	call сповіщення про виклики internal сповіщення про зміну статусу телефонів
actionid	Ідентифікатор запиту, якій було передано в запиті.	текстова строка до 32 символів
pbx	Назва АТС для запиту. Обов'язкове поле коли status=0.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле коли status=0.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле коли status=0.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Видалення webhook

API url: https://mik.ua/api.php?del-webhook

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

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

Параметри:

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

Відповідь:

{
   "status": 0,
   "status_message": "success",
   "url":"https://my.example.com",
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

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

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

Повідомлення статусу внутрішнього телефону (internal)

Приклад повідомлення:

{
   "event": "internal",
   "phonenumber": "1001",
   "status": "Idle",
   "call": {
      "uniqueid": "1613123141.17",
      "src": "+380441234567",
      "dst": "1001"
   },
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

Назва	Опис	Допустимі значення
event	Тип повідомлення. Обов'язкове поле.	завжди internal
phonenumber	Номер внутрішнього телефону. Обов'язкове поле.	цифры
status	Текущий статус телефону. Обов'язкове поле.	Idle, InUse, Busy, Unavailable, Ringing, InUse&Ringing, Hold, InUse&Hold, Ring.
call	Поточний дзвінок.
pbx	Назва АТС для запиту. Обов'язкове поле.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Відповідь.

На будь яке повідомлення необхідно надати відповідь - підпис (pbx+timestamp+hash), інакше webhook буде вважатись не працюючим.

{
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Повідомлення виклику (call)

Приклад повідомлення:

{
   "event": "call",
   "uniqueid": "1613123141.17",
   "src": "+380441234567",
   "dst": "1001",
   "status": "Hold",
   "direction": "INCOMING",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

Назва	Опис	Допустимі значення
event	Тип повідомлення. Обов'язкове поле.	завжди call
uniqueid	Унікальний ідентифікатор виклику. Обов'язкове поле.	timestamp у форматі float
src	Номер телефону викликаючого абонента. Обов'язкове поле.
dst	Номер телефону, що викликається. Обов'язкове поле.
status	Текущий статус каналу виклику. Обов'язкове поле.	Up, Busy, Hold, Down, Ring, Completed.
direction	Напрямок виклику. Обов'язкове поле.	UNCLEAR, INTERNAL, INCOMING, OUTGOING, TRANSIT.
pbx	Назва АТС для запиту. Обов'язкове поле.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Відповідь.

{
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Повідомлення-перевірка працездатності webhook (ping)

Приклад повідомлення:

{
   "event": "ping",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

Назва	Опис	Допустимі значення
event	Тип повідомлення. Обов'язкове поле.	завжди ping
pbx	Назва АТС для запиту. Обов'язкове поле.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Відповідь.

{
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Відомості про стан телефону

API url: https://mik.ua/api.php?get-internal

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

{
   "phonenumber": "1001",
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

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

Відповідь:

{
   "status": 0,
   "status_message": "success",
   "phonenumber": "1001",
   "phonestatus": "Idle",
   "callerid": "Богдан Миколайович",
   "deviceaddr": "IPV4/TLS/192.168.1.1/38608",
   "forwardnumber": "+380501234567",
   "forward": [
      "always",
      "busy",
      "noanswer",
      "unavailable",
      "together"
   ],
   "email": "user@example.com",
   "voicemail": true,
   "announce": true,
   "trunk": "gsm1",
   "useragent": "Cisco/SPA514G-7.6.2f",
   "ACL": [
      "10.1.1.1",
      "192.168.1.0/24",
      "2001:db8::/32"
   ],
   "call": {
      "uniqueid": "1613123141.17",
      "src": "+380441234567",
      "dst": "1001"
   },
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

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

Назва	Опис	Можливі значення
status	Код відповіді. 0 - успіх, все інше помилка. Обов'язкове поле.	0 або додатне ціле число
status_message	Опис коду відповіді. Обов'язкове поле.
phonenumber	Номер внутрішнього телефону.	цифры
phonestatus	Текущий статус телефону.	Idle, InUse, Busy, Unavailable, Ringing, InUse&Ringing, Hold, InUse&Hold, Ring.
callerid	Ідентифікатор абонента, що буде відображатися при виклику від цього телефону
deviceaddr	Інформація про останнє мережеве підключення: Версія інтернет протоколу, тип підключення, IP-адреса, порт.	IPV6/TLS/2001:db8::1/37578 IPV4/TCP/10.1.1.1/37364 IPV6/UDP/2001:db8::1/37578
forwardnumber	Номер для переадресації викликів.
forward	В яких випадках робити переадресацію викликів. Якщо обрано "together", виклик буде одночасно направлено на цей телефон та на номер для переадресації.	always, busy, noanswer, unavailable, together
email	Адреса електронної пошти для голосової пошти та повідомлень.
voicemail	Увімкнення Голосової пошту. Відправка на email.	true, false
announce	Надсилання повідомлень про пропущені дзвінки та статус реєстрації телефону на електронну пошту	true, false
trunk	Бажана зовнішня лінія для вихідних дзвінків. Бажана лінія буде обрана якщо є кілька зовняшніх лінії з однаковим шаблоном зовняшньго номеру.
useragent	Строка useragent отримана при останньої реєстрації
ACL	IP-адреси з яких дозволена реєстрація телефону
call	Поточний дзвінок за наявності.
actionid	Ідентифікатор запиту, якій було передано в запиті.	текстова строка до 32 символів
pbx	Назва АТС для запиту. Обов'язкове поле коли status=0.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле коли status=0.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле коли status=0.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Відомості про дзвінок

API url: https://mik.ua/api.php?get-call

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

{
   "uniqueid": "1613123141.17",
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

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

Відповідь:

{
   "status": 0,
   "status_message": "success",
   "uniqueid": "1613123141.17",
   "src": "+380441234567",
   "dst": "1001",
   "callstatus": "Completed",
   "direction": "INCOMING",
   "disposition": "ANSWERED",
   "start": "2021-02-15 17:18:51+02",
   "answer": "2021-02-15 17:18:53+02",
   "end": "2021-02-15 17:19:20+02",
   "duration": 29,
   "billsec": 26,
   "talksec": 26,
   "waitsec": 1,
   "priorsec": 2,
   "callcenter": "support",
   "cost": 3.23,
   "currency": "UAH",
   "missed": true,
   "record": true,
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

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

Назва	Опис	Можливі значення
status	Код відповіді. 0 - успіх, все інше помилка. Обов'язкове поле.	0 або додатне ціле число
status_message	Опис коду відповіді. Обов'язкове поле.
uniqueid	Унікальний ідентифікатор виклику.	timestamp у форматі float
src	Номер телефону викликаючого абонента.
dst	Номер телефону, що викликається.
callstatus	Текущий статус каналу виклику.	Up, Busy, Hold, Down, Ring, Completed.
direction	Напрямок виклику.	UNCLEAR, INTERNAL, INCOMING, OUTGOING, TRANSIT.
disposition	Підсумковий стан виклику.	NO ANSWER, FAILED, BUSY, ANSWERED, CONGESTION, BLACKLIST, LIMIT, VOICEMAIL, SMS.
start	Початок виклику.	2021-02-15 17:18:51+02
answer	Час відповіді на дзвінок.	2021-02-15 17:18:51+02
end	Час завршення виклику.	2021-02-15 17:18:51+02
duration	Тривалість дзвінка в секундах.
billsec	Тривалість оплатного часу дзвінка в секундах.
talksec	Час розмови в секундах.
waitsec	Час очікування в черзі колцентру, в секундах.
priosec	Час до надходження дзвінка в чергу колцентру, в секундах.
callcenter	Назва Кол-Центру
cost	розрахункова вартість виклику
currency	код валюти для cost	USD, UAH, EUR
missed	признак пропущеного дзвінка	true, false
record	наявність запису розмови.	true, false
actionid	Ідентифікатор запиту, якій було передано в запиті.	текстова строка до 32 символів
pbx	Назва АТС для запиту. Обов'язкове поле коли status=0.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле коли status=0.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле коли status=0.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Отримання запису розмови

API url: https://mik.ua/api.php?get-record

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

{
   "uniqueid": "1613123141.17",
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

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

Відповідь:

бінарний аудіофайл у форматі ogg

Створення виклику

API url: https://mik.ua/api.php?dial

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

{
   "phonenumber": "1001",
   "dial": "+380501234567"
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

Назва	Опис	Допустимі значення
phonenumber	Номер внутрішнього телефону. Обов'язкове поле.
dial	Номер абонента який треба набрати з phonenumber. Обов'язкове поле.	тільки цифри, можливо з ведучим "+": +380441234567 1234567 00380441234567 0441234567
actionid	ідентифікатор запиту, буде повернуто у відповіді	текстова строка до 32 символів
pbx	Назва АТС для запиту. Обов'язкове поле.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Відповідь:

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

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

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

Отримання Контакту

API url: https://mik.ua/api.php?get-contact

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

{
   "contactid": 4383, 
   "phonenumber": "0501234567",
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Обов'язкове треба зазначити contactid або phonenumber. Параметри:

Назва	Опис	Допустимі значення
contactid	Пошук Контакту за уникальним ідентифікатор контакту.	число
phonenumber	Пошук Контакту за номером телефону.	тільки цифри, можливо з ведучим "+": +380441234567 1234567 00380441234567 0441234567
actionid	ідентифікатор запиту, буде повернуто у відповіді	текстова строка до 32 символів
pbx	Назва АТС для запиту. Обов'язкове поле.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Відповідь:

{
   "status": 0,
   "status_message": "success",
   "contactid": 3792,
   "name": "Іван Іванович",
   "phonenumbers": ["+380441234567","00380441234567","0441234567"],
   "personalmanager": 1002,
   "custom": {"e-mail":"user@example.com", "фірма":"Рога та Копита"},
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

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

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

Створення або оновлення Контакту

API url: https://mik.ua/api.php?set-contact

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

{
   "contactid": 4383,
   "phonenumber": "0501234567",
   "name": "Іван Іванович",
   "personalmanager": 1002,
   "phonenumbers": ["0501234567","5555555"],
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Обов'язкове треба зазначити contactid або phonenumber. Параметри:

Назва	Опис	Допустимі значення
contactid	Оновити Контакт за уникальним ідентифікатором.	число
phonenumber	Додати номер телефону до контакту або оновити контакт з таким номером телефону	тільки цифри, можливо з ведучим "+": +380441234567 1234567 00380441234567 0441234567
name	І'мя контакту. Обов'язкове поле у разі створення нового контакту.	UTF-8 текстова строка до 32 символів
personalmanager	Внутрішній номер телефону призначеного менеджера.
phonenumbers	Список телефонних номерів контакту. Відсутні в цьому списку номери будуть видалені з Контакту	тільки цифри, можливо з ведучим "+": +380441234567 1234567 00380441234567 0441234567
actionid	ідентифікатор запиту, буде повернуто у відповіді	текстова строка до 32 символів
pbx	Назва АТС для запиту. Обов'язкове поле.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

Відповідь:

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

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

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

Видалення Контакту

API url: https://mik.ua/api.php?del-contact

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

{
   "contactid": 4383,
   "actionid": "id-1",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

Назва	Опис	Допустимі значення
contactid	Видалити Контакт за уникальним ідентифікатором. Обов'язкове поле.	число
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 можна подивитися в налаштуванні АТС.

Команда віртуального діалплану IfAPI

При виконанні команди IfAPI здійснюється запит вказаної в команді URL з наступним інформуванням методом POST (приклад):

{
   "event": "ifapi",
   "uniqueid": "1613123141.17",
   "src": "+380441234567",
   "dst": "1001",
   "status": "Hold",
   "start": "2021-02-15 17:18:51+02",
   "answer": "2021-02-15 17:18:53+02",
   "direction": "INCOMING",
   "pbx": "mypbxname",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

Назва	Опис	Допустимі значення
event	Тип повідомлення. Обов'язкове поле.	завжди ifapi
uniqueid	Унікальний ідентифікатор виклику. Обов'язкове поле.	timestamp у форматі float
src	Номер телефону викликаючого абонента. Обов'язкове поле.
dst	Номер телефону, що викликається. Обов'язкове поле.
status	Текущий статус каналу виклику. Обов'язкове поле.	Up, Busy, Hold, Down, Ring, Completed.
start	Початок виклику.	2021-02-15 17:18:51+02
answer	Час відповіді на дзвінок.	2021-02-15 17:18:51+02
direction	Напрямок виклику. Обов'язкове поле.	UNCLEAR, INTERNAL, INCOMING, OUTGOING, TRANSIT.
pbx	Назва АТС для запиту. Обов'язкове поле.
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

У разі відповіді true або 1 - команда IfAPI виконує основну гілку команд, при будь якої іншої відповіді або помилки виконується гілка "ELSE"

true

Створення або налаштування АТС

API url Створення АТС: https://mik.ua/api.php?create-pbx

API url Зміни налаштувань АТС: https://mik.ua/api.php?set-pbx

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

{
   "name": "newpbx",
   "max_internal": 10,
   "records_quota": "10G",
   "actionid": "id-1",
   "pbx": "GLOBAL",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

Параметри:

Назва	Опис	Допустимі значення
name	назва АТС. Обов'язкове поле.	текстова строка до 10 символів. Може містити виключно літери латинського алфавіту a-z та цифри 0-9.
description	Опис АТС.	UTF-8 текстова строка
max_internal	Максимальна кількість внутрішніх телефонів. За замовчуванням 100.	число
max_virtual	Максимальна кількість віртуальних номерів (діалпланів). За замовчуванням 100.	число
max_external	Максимальна кількість зовнішніх ліній. За замовчуванням 10.	число
max_callcenters	Максимальна кількість КолЦентрів. За замовчуванням 5.	число
store_log_days	Скільки днів буде зберігатися журнал викликів. За замовчуванням 90.	число
records_quota	Максимальний об'єм пам'яті для зберігання записів розмов. 0 запис заборонена. Можливо вказувати об'єм в M - мегабайтах або G гігабайтах. За замовчуванням запис заборонено.	строка або число. Наприклад: 100, 500M, 10G.
language	Мова АТС за замовчуванням. Може бути змінена в віртуальному діалплане. За замовчуванням Українська.	Двобуквений код мови: uk - Українська, en - English, ru - руська
limit_out_connections	Максимальна кількість дозволених вихідних одночасних з'єднань. За замовчуванням 10.	число
limit_out_daily_duration	Максимальна тривалість в хвилинах вихідних викликів протягом доби. За замовчуванням 180.	число
limit_daily_cost	Максимальна вартість вихідних викликів протягом доби. За замовчуванням 1000.	число
currency	Валюта для розрахунку вартості викликів. За замовчуванням UAH.	UAH, USD або EUR
limit_action	Дія в разі перевищення limit_out_connections, limit_out_daily_duration або limit_daily_cost. За замовчуванням 3.	число від 1 до 3. 1 - повідомити на admin email, 2 - скидати вихідні виклики, 3 - заборонити вихідні виклики.
active	АТС активна (true) чи відключена (false). За замовчуванням true.	true або false
actionid	ідентифікатор запиту, буде повернуто у відповіді	текстова строка до 32 символів
pbx	Обов'язкове поле.	GLOBAL
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле.	строка 32 символа. Глобальний ключ API Key.

Відповідь:

{
   "status": 0,
   "status_message": "success",
   "name": "newpbx",
   "apikey": "sjk6c0b121ce90e7c38328d875c4ee54",
   "actionid": "id-1",
   "pbx": "GLOBAL",
   "timestamp": 1613125191.2345,
   "hash": "afe6c0b121ce90e7c38328d875c4e272"
}

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

Назва	Опис	Можливі значення
status	Код відповіді. 0 - успіх, все інше помилка. Обов'язкове поле.	0 або додатне ціле число
status_message	Опис коду відповіді. Обов'язкове поле.	"success" - у разі успіху. Або короткий опис номера коду помилки у полі відповіді "status".
name	Назва створеної АТС	Ім'я PBX повинна складатися з літер латинського алфавіту та(або) цифр (Довжина 10 символів). Якщо Ви вказали некоректну назву PBX, отримаєте у відповіді у полі "status" помилку номер 6.
apikey	API-key створеної АТС. Може використовуватися для подальшого налаштування АТС.
actionid	Ідентифікатор запиту, якій було передано в запиті.	текстова строка до 32 символів
pbx	GLOBAL
timestamp	Поточний час у форматі UNIX-TIMESTAMP. Обов'язкове поле коли status=0.
hash	md5(pbx:timestamp:apikey). Обов'язкове поле коли status=0.	строка 32 символа. API Key можна подивитися в налаштуванні АТС.

IP АТС MIK® PBX	Документація
Корпоративним клієнтам	Про компанію
Кол-центрам	Партнерство
Операторам	Контакти
Новини	Демо аккаунт
Тарифи

	IP АТС MIK® PBX	Документація
	Корпоративним клієнтам	Про компанію
	Кол-центрам	Партнерство
	Операторам	Контакти
	Новини	Тарифи