Загальні відомості про API#
API дозволяє підключити до LiraX любой ваш програмний продукт (ВПП).
Інтеграція до LiraX вирішує кілька бізнес-завдань:
- отримання імені абонента, що телефонує, за номером телефону;
- отримання номера менеджера, який закріплений за клієнтом;
- відображення інформації прпро вхідний дзвінку безпосередньо всередині ВПП;
- збереження всередині ВПП історії усіх дзвінків і посилань на записі розмов;
- створення Контакту:
- Створення завдання для Контакту й менеджера;
- Створення нотатки для Контакту;
- Створення Угоди для контакту;
- Оновлення Угоди
- здійснення вихідних дзвінків одразу з інтерфейсу ВПП.
Інтеграція має бути двосторонньою. Тому частина запитів LiraX надсилає у бік ВПП на зазначені крапки входу, а частина запитів, навпаки, ВПП надсилає у бік LiraX на єдину точку входу.
Взаємодія здійснюється за протоколом HTTPS. Авторизація здійснюється по адресу LiraX або ВПП відповідно і авторизаційному ключу, отриманим у процесі налаштування інтеграції.
Принцип авторизації та взаємодії#
HTTPS:
- Запити до LiraX приймаються лише за протоколом HTTPS. Це забезпечує достатній рівень безпеки для взаємодії систем через Інтернет.
- З метою безпеки ваших даних, будь ласка, реалізуйте приймання запитів на стороні ВПП також с використанням HTTPS.
Ключ (token):
- Додатково для авторизації кожного запиту до LiraX використовується спеціальний ключ (token). Отримати його можна в налаштуваннях інтеграції.
- Будь ласка, реалізуйте приймання запитів на стороні ВПП також с використанням ключа (token). Згенеруйте ключ і вставте його у відповідне полі в розділі налаштування інтеграції.
- Ключі створюються один раз під час налаштування інтеграції. За потреби, ви можете змінити ключ на своїй стороні і оновити його в інтерфейсі LiraX.
Запити від LiraX до ВПП:
- Запити необхідно надсилати на зазначену в налаштуваннях інтеграції адресу для приймання повідомлень, наприклад https://domain/LiraX.
- У тілі запиту в спеціальному полі «token» необхідно завжди передавати спеціальний ключ.
- Запити передаються у форматі application/x-www-form-urlencoded
Запити від ВПП до LiraX:
- ВПП має надсилати усі запити на зазначену в налаштуваннях інтеграції адрес
- В тілі повідомлень ВПП має передавати зазначену вами в вебкабінеті ключ (token).
- Запити передаються у форматі application/x-www-form-urlencoded
Відповіді
- Усі відповіді на запити LiraX ВПП має надсилати у форматі JSON у тілі відповіді.
- Усі відповіді на запити ВПП LiraX надсилає у форматі JSON у тілі відповіді.
Список команд API#
Від ВПП до LiraX:
- makeCall (POST,GET)
- killCall (POST,GET)t
- make2Calls (POST)
- AskQuestion (POST)
- AddTag (POST)
- DelTag (POST)
- get_sip_route_in (POST)
- set_sip_route_in (POST)
- getUserSips (POST)
- IsFreeUsers (POST)
- IsCalling (POST)
- AddCampaign (POST)
- AddPhoneCampaign (POST)
- checkContact (POST)
- getContact (POST)
- getStatInfo (POST)
- createTask (POST)
- AddTaskResult (POST)
- GetTask (POST)
- createNote (POST)
- createDeal (POST)
- updateDeal (POST)
- addBlackPhone (POST,GET)
- addBlackIP (POST,GET)
- getStages (POST)
- getShops (POST)
- getUserStatuses (POST)
- getUsers (POST)
- initStatuses (POST)
- sendMsg (POST)
- send_cloud_message (POST)
- sendSMS (POST)
- checkSMS (POST)
- EncodePhone (POST)
- DecodePhone (POST)
- set_call_lost (POST)
- get_makecall_data(POST)
- get_calls
- set_webhook
- Завантаження історії дзвінків
Від LiraX до ВПП:
- staton (POST)
- smsDelivered (POST)
- smsReceived (POST)
- contact (POST)
- event (POST)
- record (POST)
*Усі запити з Content-Type: application/x-www-form-urlencoded
Команди API та приклади доступних сценаріїв#
Команди від ВПП до LiraX#
makeCall#
Команда необхідна для того, щоб ініціювати дзвінок від менеджера клієнту. В результаті успішного виконання команди, LiraX спочатку здійснить дзвінок на телефон менеджера, а потім зʼєднає його з клієнтом.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку makeCall | string | |
| from | короткий номер співробітника осуществляющего вихідний виклик | string | |
| to | номер, на який здійснюється вихідний виклик | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| idshop | Необовʼязковий параметр, зазначає id магазину, від якого буде дзвінок | integer | ( список id можна отримати функцією GetShops) |
Приклад запиту:
POST https://api.lirax.net/general
cmd=makeCall
from=101
to=19101234567
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"id_makecall":"$id_makecall"} | OK, $id_makecall – використовується під час отримання вебхука makecall_finished |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
killCall#
Команда необхідна для того, щоб примусово завершити дзвінок від менеджера клієнту.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку killCall | string | |
| Call_id | id дзвінка, отриманого в події makecall_finished | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=killCall
Call_id=101234234234s3
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
make2Calls#
Команда необхідна для того, щоб зʼєднати между собою два абонента. В результаті успішного виконання команди, LiraX спочатку здійснить дзвінок на телефон to1, а потім зʼєднає його з to2. From необхідний для правильної маршрутизації викликів.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку make2Calls | string | |
| from | короткий номер співробітника, від імені якого осуществляются вихідні викликы | string | |
| to1 | номер, на який делается первый виклик | string | |
| to2 | номер, на який делается другийй виклик або url звукового файлу(mp3,wav) в випадку якщо необхідно відтворити лише звуковой файл | string | |
| speech | Текст який має проговориться після підняття слухавки to1. Текст має складатися з мови( “uk “, “en “, “ru “) і самого текста | string | Необовʼязковий |
| atempo | Необовʼязковий параметр, зазначає швидкість відтворення від 0.5 до 2.0 | string | Необовʼязковий |
| timeout | Час в хвилинах (якщо більше 10 каждые 10 хвилин будут повторы до підняття слухавки обоими абонентами). За замовчуванням 0 – лише одна спроба | string | Необовʼязковий |
| successtime | Час в секундах – Скільки секунд, має складатисяся розмова, щоб вважати, что дзвінок успішний . За замовчуванням 0 | string | Необовʼязковий |
| notbefore | Час в часах – До какого години не можна телефонувати. За замовчуванням 08 | string | Необовʼязковий |
| notafter | Час в часах – Після якої години не можна телефонувати, За замовчуванням 20 | string | Необовʼязковий |
| try | ДОількість спроб додзвону на першу сторону с інтервалом 10 хвилин | integer | Необовʼязковий =1 |
| vtime | Час в часах і хвилинах – hh:mm. Параметр может використовуватися для IVR | string | Необовʼязковий |
| vdate | Дата – ”dd.mm.YYYY”, ”today” або ”tomorrow” . Параметр может використовуватися для IVR | string | Необовʼязковий |
| vmoney | Значення суми грошей типа float 0.00 с двома цифрами після крапки. Параметр може використовуватися для IVR | string | Необовʼязковий |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| idshop | Необовʼязковий параметр, зазначає id магазину, від якого буде дзвінок | integer | ( список id можна отримати функцією GetShops) |
| FirstInternal | Необовʼязковий параметр, зазначає, что перше плече внутрішній дзвінок якщо =1 | integer | Необовʼязковий |
| SecondInternal | Необовʼязковий параметр, зазначає, что друге плече внутрішній дзвінок якщо =1 | integer | Необовʼязковий |
| SpeechNoWait | Необовʼязковий параметр, якщо =1, зазначає, что speech відтворюється замість гудків при виклику сторони to2 | integer | Необовʼязковий |
Приклад запиту:
POST https://api.lirax.net/general
cmd=make2Calls
from=101
to1=19101234561
to2=19101234567
speech=en Hello Customer
timeout=60
successtime=30
notbefore=18
notafter=21
token=202cb962ac59075b964b07152d234b70
cmd=make2Calls
from=201
to1=19101234567
to2=https://www.test.mp3/tttt.mp3
timeout=60
successtime=30
notbefore=18
notafter=21
try=4
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"id_make2calls":"$id_make2calls"} | OK, $id_make2calls – використовується під час отримання вебхука make2calls_finished |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
AskQuestion#
Команда необхідна для того, щоб поставити запитання абоненту і отримати відповідь. В результаті успішного виконання команди, LiraX спочатку здійснить дзвінок на телефон to1, а потім відтворить привітання «hello», за потреби можливо додатково відтворити до 4 повідомлень «text1-4» вибраною мовою (потрібні якщо потрібні паузи). Дальше відтворюється запитання, якщо включена опція розпізнавання голосу, очікує правильних слів в відповіді «ok», якщо немає розпізнавання, очікуємо натискання кнопки. «From» необхідний для правильної маршрутизації викликів. Реакція аналогічна команді make2calls
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку AskQuestion | string | |
| from | короткий номер співробітника, від імені якого осуществляются вихідні викликы | string | |
| to1 | номер, на який делается первый виклик | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| hello | Необовʼязковий параметр, предложение необхідно как привітання (типа Вітаємо) | string | |
| text1 | Необовʼязковий параметр, Повідомлення 0 | string | |
| text2 | Необовʼязковий параметр, Повідомлення 0 | string | |
| text3 | Необовʼязковий параметр, Повідомлення 0 | string | |
| text4 | Необовʼязковий параметр, Повідомлення 0 | string | |
| bye | Необовʼязковий параметр, Повідомлення типу допобачення, працює після питання | string | |
| ask | Повідомлення питання | String | |
| ok | Слова через пробел, які мы надеемся отримати в позитивній відповіді (наприклад: так ок) | String | |
| cburl | Необовʼязковий параметр, url для webhook с сообщением make2calls_finished, в якому передаються дані с відповіддю абонента | String |
Приклад запиту:
POST https://api.lirax.net/general
cmd=AskQuestion
from=101
cburl=https://mydomain.co/
to1=19101234561
token=202cb962ac59075b964b07152d234b70
hello=ru Вітаємо
text1=ru Пропонується нова послуга
ask=ru Якщо бажаєте її отримати, скажіть так
ok=ru так бажаю хочу
bye=ru До побаченняВаріанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"id_make2calls":"$id_make2calls"} | OK, $id_make2calls – використовується під час отримання вебхука make2calls_finished |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
AddTag#
Команда додає тег контакту
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку AddTag | string | |
| ani | номер телефону Контакту | string | Необовʼязковий |
| tag | тег | string | Необовʼязковий |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=AddTag
ani=19101234567
tag=OK
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
DelTag#
Команда видаляє тег в контакті
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку DelTag | string | |
| ani | номер телефону Контакту | string | Необовʼязковий |
| tag | тег | string | Необовʼязковий |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=DelTag
ani=19101234567
tag=OK
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
get_sip_route_in#
Команда необхідна для того, щоб визначити список sip номерів для внутрішнього номера phone
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку get_sip_route_in | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| phone | Внутрішній номер | string | Приклад: 302 |
Приклад запиту:
POST https://api.lirax.net/general
cmd=get_sip_route_in
phone=302token=202cb962ac59075b964b07152d234b70#
Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | { "N":2, "description":"route_in_sip.", "results":[ { "sip_name":"Test", "sip_number":"1115", "user_name":"User", "ext":"222", "priority":"0", "time_plan":"1" }, { "sip_name":"Test1", "sip_number":"1156", "user_name":"User1", "ext":"223", "priority":"0", "time_plan":"1" } ] } | OK, якщо немає сіпов отримаємо “N”:0, N-кількість сіпов, sip_name імʼя SIP, sip_number – номер SIP, user_name – Імʼя користувача, ext – внутрішній номер користувача, priority – поточний пріоритет SIP, time_plan – id тижневого плану (робочий=1, вечірній=2, нічний=3, свято=4) |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) | |
| 402 | Внутрішня помилка |
set_sip_route_in#
Команда необхідна для того, щоб встановити пріоритет sip номера для внутрішнього номера phone
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку set_sip_route_in | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| phone | Внутрішній номер | string | Приклад: 302 |
| sip_number | номер SIP | string | Приклад: 1115 |
| time_plan | id тижневого плану (робочий=1, вечірній=2, нічний=3, свято=4) | string | Приклад: 1 |
| priority | пріоритет сіпа во внутрішньому номері | string | Приклад: 1 |
Приклад запиту:
POST https://api.lirax.net/general
cmd=set_sip_route_in
phone=302
sip_number=1115
priority=0
time_plan=1token=202cb962ac59075b964b07152d234b70#
Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"result":"1"} | OK, при успішному оновленні, result=1, при відсутності сіпа result=0 |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) | |
| 402 | Внутрішня помилка |
getUserSips#
Команда необхідна для того, щоб визначити есть ли доступні телефони для внутреннего номера ext.
Команда кешує дані і оновлює їх 1 раз на годину
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку getUserSips | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| ext | Внутрішній номер | string | Приклад: 302 |
| web | Якщо установлено > 0, тогда видаються лише web телефоны | integer | Необовʼязковий |
Приклад запиту:
POST https://api.lirax.net/general
cmd=getUserSips
ext=302token=202cb962ac59075b964b07152d234b70#
Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"user_sips":[{"phone":"10000","user_id":"1111","ext":"302"}]} | OK, якщо немає доступних сіпів отримаємо {"user_sips":[]} |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
IsFreeUsers#
Команда необхідна для того, щоб визначити, чи можливо, щоб користувач на Веб телефоне прийняв дзвінок.
Команда проверяет: - чи включений Веб телефон; - чм немає розмови з користувачем і вертає перший номер з вільних
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку IsFreeUsers | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| phones | Список внутрішніх або сіп номерів телефонов | string | Приклад: 1212121, 1212123,302 |
| amo | Якщо установлено в 1, тогда номера Використовуються как amocrm user_id | string | Необовʼязковий |
Приклад запиту:
POST https://api.lirax.net/general
cmd=IsFreeUsers
Phones=1212121,1212123,302token=202cb962ac59075b964b07152d234b70#
Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"result":"phoneFromPhones","sip":"sip_number", "ext":"number"} | OK, якщо усі номера зайняті отримаємо {"result":null} |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
IsCalling#
Команда проверяет, нет ли розмови с сіп номером і возвращает перший номер без раговора(проверяет реєстрацію)
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку IsFreeUsers | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| phones | Список внутрішніх або сіп номерів телефонов | string | Приклад: 1212121, 1212123 |
Приклад запиту:
POST https://api.lirax.net/general
cmd=IsCalling
Phones=1212121,1212123token=202cb962ac59075b964b07152d234b70#
Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"result":"phoneFromPhones","ext":"number"} | OK, якщо усі номера зайняті отримаємо {"result":null} |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
AddCampaign#
Команда необхідна для того, щоб Створити або встановити кампанію для обдзвону абонентів або надсилання SMS.
При обзвоні абонентів спочатку дзвінок йде до користувача, а потік до абоненту
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку AddCampaign | string | |
| from | короткий номер співробітника, від імені якого відбувається кампанія | string | |
| ext | короткий номер співробітника, на якому буде прийматися виклик співробітниками (за замовчуванням равен from) | string | Необовʼязковий |
| days | Список дней(0-Воскресенье,6-Субота) | string | За замовчуванням: 1,2,3,4,5 |
| time | Діапазон часу | string | По молчанию: 10:00-18:00 |
| pdd | Час на постобробку(секунди) | integer | За замовчуванням: 5 |
| preview_timeout | Затримка вихідного дзвінка, після підняття слухавки співробітником (за замовчуванням 0) | integer | Необовʼязковий |
| try | кількість спроб | integer | За замовчуванням: 1 |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| type | Тип кампанії 1 - Телефонна, 2 - SMS | integer | За замовчуванням: 1 |
| phones | Список номерів телефонів(якщо список буде пуст, компания останавливается) | string | Приклад: 12121234567, 12121234568 |
| message | Текст повідомлення, для type=1 має бути перше слово мова {en,uk,ru,…} (в этом випадку буде спочатку телефонувати абоненту і preview_timeout ігнорується) | string | Обовʼязковий для type=2 |
| idshop | Необовʼязковий параметр, зазначає id магазину, від якого буде дзвінок | integer | Необовʼязковий ( список id можна отримати функцією GetShops) |
Примітка: Для type=1 кількість одночасних дзвінків визначається в налаштуваннях кампании в кабінеті пользовтеля
Для превью режима спочатку дзвінок идет до користувачу, а потім до абоненту, при message!=NULL навпаки
Приклад запиту:
POST https://api.lirax.net/general
cmd=AddCampaign
from=101
days=1,2
time=10:00-11:00
timeout=60
pdd=30
try=2
idshop=2
type=2
message=Hello
Phones=12121234567,12121234568,12121234569
token=202cb962ac59075b964b07152d234b70
або
cmd=AddCampaign
from=101
days=1,2
time=10:00-11:00
timeout=60
pdd=30
try=2
idshop=2
type=1
message=en Hello
Phones=12121234567,12121234568,12121234569
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
AddPhoneCampaign#
Команда необхідна для того, щоб додати телефонні номера в кампанію для обдзвону абонентів або надсилання SMS.
при обзвоне абонентов спочатку дзвінок йде до користувача, а потім до абоненту для превью режима, при message!=NULL навпаки
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку AddPhoneCampaign | string | |
| from | короткий номер співробітника, від імені якого відбувається кампанія | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| phones | Список номерів телефонів | string | Приклад: 12121234567, 12121234568 |
Приклад запиту:
POST https://api.lirax.net/general
cmd=AddPhoneCampaign
from=101
Phones=12121234567,12121234568,12121234569
token=202cb962ac59075b964b07152d234b70checkContact#
Команда необхідна для того, щоб вставити Новий або оновити наявний контакт, оновлюється Імʼя контакту і Відповідальний співробітник.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку checkContact | string | |
| ext | короткий номер співробітника відповідального за контакт | string | |
| ani | Основний номер телефону Контакту | string | |
| name | Імʼя Контакту | string | |
| add_phone | Список додаткових телефонів | string | Необовʼязковий |
| emails | Список e-mail | string | Необовʼязковий |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| trackid | Google tracking id for site | string | Необовʼязковий |
| clientid | Google Client id | string | Необовʼязковий |
| sitename | Імʼя сайта | string | Необовʼязковий |
| source | Джерело | string | Необовʼязковий |
| stype | Тип Джерола (Medium | string | Необовʼязковий |
| campain | Кампанія | string | Необовʼязковий |
| Term | Ключове слово | string | Необовʼязковий |
| tag | Тег (при наличии вставляется тег) | string | Необовʼязковий |
Приклад запиту:
POST https://api.lirax.net/general
cmd=checkContact
ext=101
ani=19101234567
Name=Dima
token=202cb962ac59075b964b07152d234b70
add_phone=380123456789,380234567890,380112345678
emails=a@a.com,b@b.comВаріанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
getContact#
Команда необхідна для того, щоб отримати информацию про наявному контакті і його Відповідального співробітника.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку getContact | string | |
| ani | номер телефону Контакту | string | Необовʼязковий |
| string | Необовʼязковий | ||
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=getContact
ani=19101234567
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"result":{"name":"Дмитро","mainphone":"12345678901","responsible":"209","sip":"111"}} | OK Name - Імʼя контакту, mainphone – перший номер телефону контакту, responsible - внутрішній номер відповідального, sip - sip номер відповідального |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
getStatInfo#
Команда необхідна для того, щоб отримати Статистику дзвінків по співробітникам за період не більше місяця. Команду можна використовувати не частіше 1 раз на годину
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку getStatInfo | string | |
| Start | Дата у форматі “YYYY-MM-DD HH:MM:SS” - початок інтервалу | string | |
| Stop | Дата у форматі “YYYY-MM-DD HH:MM:SS” - кінець інтервалу | string | Необовʼязковий, якщо відсутній, тоді за 24 години |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=getStatInfo
Start=2021:01:01 00:00:00
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | { "results":[ { "description":"stat_info.", "stat":[ { "login":"alex", "name":"Алексей", "count_incoming":"0", "count_incoming_unique":"0", "count_incoming_answered":"0", "count_incoming_answered_unique":"0", "count_incoming_lost":"0", "count_incoming_lost_unique":"0", "count_outgoing":"10", "count_outgoing_unique":"4", "count_outgoing_answered":"5", "count_outgoing_answered_unique":"2", "count_outgoing_lost":"5", "count_outgoing_lost_unique":"4", "incoming_duration_talk":"0", "outgoing_duration_talk":"765" } ] } ] } | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
createTask#
Команда необхідна для того, щоб створити Нове завдання для Відповідального співробітника і контакту. Якщо контакт не існує, створюється новий
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку createTask | string | |
| ext | короткий номер співробітника відповідального за контакт | string | |
| department | Назва Відділу | string | необовʼязковий |
| ani | номер, телефону Контакту | string | Обовʼязковий ani або email |
| e-mail Контакту | string | Обовʼязковий ani або email | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| webhook | Url для информирования про результаті | string | В конце буде дописаний текст |
| text | Текст завдання | string | |
| date | Дата виконання завдання | Date | Необовʼязковий, За замовчуванням поточний час +1сек. Приклад: "2017-01-01 17:00:00", має бути більше текучою дати і менше два роки наперед |
| type | Тип | Integer | 1,2,3 (Follow-up,Зустріч, Дзвінок) |
Приклад запиту:
POST https://api.lirax.net/general
cmd=createTask
ext=101
department=Продажи
ani=19101234567
text=Подготовить Задание
date=2017-01-01 17:00:01
type=1
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"idtask":"22"} | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
AddTaskResult#
Команда необхідна для того, щоб додати результат до задачі, завершити завдання або змінити відповідального
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку AddTaskResult | string | обовʼязковий |
| ext | короткий номер співробітника кто добавил результат | string | обовʼязковий |
| idtask | Id Завдання | Integer | обовʼязковий |
| newext | Новий відповідальний | string | необовʼязковий |
| finish | Завершення завдання | bool | необовʼязковий |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| text | Текст результату | string | обовʼязковий |
Приклад запиту:
POST https://api.lirax.net/general
cmd=AddTaskResult
ext=101
idtask=123123
newext=191
text=Задание на этапе 1
finish=0
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"idtask":"123123"} | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
GetTask#
Команда необхідна для того, щоб додати результат до задачі, завершити завдання або змінити відповідального
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку AddTaskResult | string | обовʼязковий |
| task_id | Id Завдання | Integer | обовʼязковий |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=GetTask
task_id=123123
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | { "task_id":"609", "type":"Follow-up", "date_insert":"2014-12-09 14:15:55", "date_end":"2014-12-09 15:12:07", "text":"test Task!", "ext":"101", "Name":"System", "coauthors":"1", "list":[ { "ext":"504", "Name":"Сергій Рибальченко" } ] } | Здесь type – тип завдання; date_insert – дата создания; date_end – дата виконання ; text – текст завдання; ext – відповідальний; Name - імʼя відповідального; coauthors - кількість співвиконавців; list – список співвиконавців |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
createNote#
Команда необхідна для того, щоб створити нотатку для існуючого контакту від Відповідального співробітника.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку createNote | string | |
| ext | короткий номер співробітника відповідального за контакт | string | |
| ani | номер, телефону Контакту | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| text | Текст нотатки | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=createNote
ext=101
ani=19101234567
text=Новини
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
createDeal#
Команда необхідна для того, щоб створити Нову угоду для Відповідального співробітника і існуючого контакту.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку createDeal | string | |
| ext | короткий номер співробітника відповідального за контакт | string | |
| ani | номер, телефону Контакту | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| name | Нвзва угоди | string | |
| sum | Сума угоди | Integer | |
| stage | Стадія угоди | Integer | Дозволені лише існуючі стадии |
| status | Статус угоди (необовʼязковий) | Integer | 0-активная, 1- Успішно Завершені, 2- Завершена Неуспішно |
Приклад запиту:
POST https://api.lirax.net/general
cmd=createDeal
ext=101
ani=19101234567
name=Підготовити Завдання
sum=3030
stage=1
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"id_deal":$integer} | OK ($integer - целое число) |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
updateDeal#
Команда необхідна для того, щоб оновити існуючу угоду с id_deal для Відповідального співробітника і існуючого контакту.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку updateDeal | string | |
| ext | короткий номер співробітника відповідального за контакт | string | |
| ani | номер, телефону Контакту | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| id_deal | Id угоди | Integer | |
| name | Нвзва угоди | string | |
| sum | Сума угоди | Integer | |
| stage | Стадія угоди | Integer | Дозволені лише існуючі стадии |
| status | Статус угоди | Integer | 0-активная, 1- Успешно Завершен, 2- Завершена Неуспешно |
Приклад запиту:
POST https://api.lirax.net/general
cmd=updateDeal
ext=101
ani=19101234567
id_deal=1910
name=Подготовить Задание
sum=3030
stage=2
status=0
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) |
addBlackPhone#
Команда необхідна для того, щоб додати в Черный список номер телефону (лише цифри).
Параметри запиту:
| Імʼя | Опис | Тип/форма даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку addBlackPhone | string | |
| phone | номер телефону | string | Лише цифри |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=addBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
listBlackPhone#
Команда необхідна для того, щоб отримати Чорний список телефонів.
Параметри запиту:
| Імʼя | Опис | Тип/форма даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку listBlackPhone | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=listBlackPhone
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"blacklist":["phone1","phone2",...,"phoneN"]} | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
delBlackPhone#
Команда необхідна для того, щоб видалити в Чорному списку номер телефону (лише цифри).
Параметри запиту:
| Імʼя | Опис | Тип/форма даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку delBlackPhone | string | |
| phone | номер телефону | string | Лише цифри |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=delBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
listBlackIP#
Команда необхідна для того, щоб отримати Чорний список IP адрес
Параметри запиту:
| Імʼя | Опис | Тип/форма даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку listBlackIP | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=listBlackIP
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"blacklist":["IP1","IP2",...,"IPN"]} | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
addBlackIP#
Команда необхідна для того, щоб додати в Чорний список IP адресу.
Параметри запиту:
| Імʼя | Опис | Тип/форма даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку addBlackIP | string | |
| IP | IP Адресу | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=addBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
delBlackIP#
Команда необхідна для того, щоб видалити в Чррному списку IP адресу.
Параметри запиту:
| Імʼя | Опис | Тип/форма даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку delBlackIP | string | |
| IP | IP Адресу | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=delBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
getStages#
Команда необхідна для того, щоб отримати список Стадій угод, відсортованих Згідно Воронки.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку getStages | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=getStages
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"stages":[{"stage":$stage,"title":"..."},...]} | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
getShops#
Команда необхідна для того, щоб отримати список магазинів.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку getShops | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=getShops
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"shops":[{"id":$id_shop,"name":"..."},...]} | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
getUserStatuses#
Команда необхідна для того, щоб отримати список статусов станів користувача.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку getUserStatuses | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=getUserStatuses
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"statuses":[{"status":$status,"title":"..."},...]} | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
getUsers#
Команда необхідна для того, щоб отримати список користувачів
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку getUsers | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=getUsers
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"users":[{"id":$id,"Name":"...","ext":"...","active":"0|1"},...]} | OK |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
initStatuses#
Команда необхідна для того, щоб отримати текучі статуси операторів, через ВебХуки. Використовуються при вмиканні інтеграції. Подальші стани будут приходити по їх зміни, попередні статуси необхідно ігнорувати
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку initStatuses | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=initStatuses
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
sendMsg#
Команда необхідна для того, щоб відправити повідомлення співробітнику в корпоративный меседжер.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку sendMsg | string | |
| ext | короткий номер співробітника, кому відправляється повідомлення | string | |
| ani | імʼя Контакту, який послал повідомлення | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| text | Текст повідомлення | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=sendMsg
ext=101
ani=19101234567
text=Подготовить Задание
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) |
send_cloud_message#
Команда необхідна для того, щоб відправити повідомлення в хмарковий меседжер (Telegram, Viber, Facebook).
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку send_cloud_message | string | |
| client | Клиент ID облачного месенджера | string | обов'язкове при отсутсвии ani |
| ani | Номер телефону Клиента(використовується лише Telegram) | обов'язкове при отсутсвии client | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| text | Текст повідомлення | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=send_cloud_message
client=web_t123123123_00000
text=Підготовити Завдання
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) | |
| 402 | Повідомлення не передано |
sendSMS#
Команда необхідна для того, щоб відправити SMS через GSM модем. Запити треба відсилати не частіше 1 раз в 5 секунд на один модем.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку sendSMS | string | |
| ext | короткий номер співробітника, кто надсилає SMS | string | Лише цифри |
| provider | Идентификатор провайдера (номер телефону в GSM модеме) | string | Лише цифри |
| phone | Номер Телефону, кому посылаем повідомлення | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | |
| text | Текст повідомлення | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=sendSMS
ext=101
phone=19101234567
provider=380123456789
text=Підготовити Завдання
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"id_sms":$id_sms} | OK |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) | |
| 402 | Модем не подключен | |
| 403 | Модем занят, повторите позже |
checkSMS#
Команда необхідна для того, щоб перевірити статус доставки SMS через GSM модем. Запити треба відсилати не частіше 1 раз в 5 секунд на один модем.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку checkSMS | string | |
| ext | короткий номер співробітника, кто надсилає SMS | string | Лише цифри |
| provider | Идентификатор провайдера (номер телефону в GSM модеме) | string | Лише цифри |
| id_sms | Id отриманої командою sendSMS | Integer | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=checkSMS
ext=101
id_sms=1910123
provider=380123456789
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"sms_status":$id_status} | OK, 1- передано провайдеру, статус неизвестный; 2- передано провайдеру, идет доставка; 3- доставлено; 4- Час доставки истекло |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) |
EncodePhone#
Команда необхідна для того, щоб перевірити отриманий зашифрований номер.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку EncodePhone | string | |
| phone | Номер телефону | string | Лише цифри |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=EncodePhone
phone=12123123123
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"phone":$encoded} | OK |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) |
DecodePhone#
Команда необхідна для того, щоб отримати розшифрований номер.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку EncodePhone | string | |
| phone | Номер телефону | string | Лише цифри |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://api.lirax.net/general
cmd=DecodePhone
phone=12123120960170061170799
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | {"phone":$decoded} | OK |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) |
set_call_lost#
Команда необхідна для того, щоб встановити номер телефону, як пропущений дзвінок, для CallBack
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку set_call_lost | string | обов'язкове |
| phone | Номер телефону | string | Лише цифри, обов'язкове |
| ext | Номер телефону співробітників для CallBack | string | Лише цифри, обов'язкове |
| time_plan | 1 - Рабочее час, 2 - Вечер, 3 - Ночь, 4 - Выходные | цифри | Временной інтервал визначається в недельном плане, при замовчуванням 1 |
| max_try | Максимальное кількість спроб соединения с абонентом (с оператором не считается) | цифри | За замовчуванням 3 |
| interval | Початковий інтервал между спробами в хвилинах, кратный 6. Последующий інтервал равен начальному умножить на номер спроби | цифри | За замовчуванням 6 |
| minutes | Кількість хвилин затримки | цифри | За замовчуванням 0 |
| hours | Кількість годин затримки | цифри | За замовчуванням 0 |
| days | Кількість дней затримки | цифри | За замовчуванням 0 |
| weeks | Кількість недель затримки | цифри | За замовчуванням 0 |
| months | Кількість месяцев затримки | цифри | За замовчуванням 0 |
| info | Текст, який буде промовлятися співробітнику. Формат: мова і текст. Приклад: "uk Call Back сервіс на пропущений виклик, очікуйте з’єднання з абонентом" | string | |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | обов'язкове |
Приклад запиту:
POST https://api.lirax.net/general
cmd=set_call_lost
phone=12123120960
ext=222
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) | |
| 402 | Проблеми з сервером |
get_makecall_data#
Команда дозволяє отримати інформацію про дзвінок використовуючи id_makecall, отриманого командой makecall
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку get_makecall_data | string | обов'язкове |
| id_makecall | отриманої в результаті makecall | string | Лише цифри, обов'язкове |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | обов'язкове |
Приклад запиту:
POST https://api.lirax.net/general
cmd=get_makecall_data
id_makecall=e5251de22f99e071
token=202cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | { "id_makecall":"e5251de22f99e071", "call_start":"2021-10-28 16:02:32", "call_record":"https://files.lirax.net/voicerec.wav", "duration":"5" } | OK |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) | |
| 402 | Проблеми с сервером |
get_calls#
Команда дозволяє журнал дзвінків в json форматі (максимум 5000) для діапазона часу. Для Команди можливо використовувати метод GET
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку get_calls | string | обов'язкове |
| date_start | Початок діапазона | string | В SQL форматі, обов'язкове |
| date_finish | Кінець діапазона | string | В SQL форматі, обов'язкове інтервал має бути менше 48годин |
| call_type | тип дзвінка, {-1,0,1}, соответсвенно {внутрішній, вхідний, исходящий }, якщо отсутствует, тогда усі | numerical | необов'язкове |
| ani | Кто дзвонив | string | необов'язкове |
| dnis | Куда дзвонили | string | необов'язкове |
| offset | Пропустить в выводе кількість строк | numerical | необов'язкове |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | обов'язкове |
Приклад запиту:
GET https://api.lirax.net/general?cmd=get_calls&date_start=2023-10-04 10:00:00&date_finish=2023-10-04 11:00:00&token=-----Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | [{"call_id":"6708","ani":"203" , "dnis":"380123123", "start":"2023-10-04 10:21:14", "connect":"2023-10-04 10:21:25", "record": "https://files.lirax.net/voice_record2/x_10_21_14.wav", "type":"1","duration": "163","disconnect_side":"0", "call_call_center_id":"6" },{"call_id":"8326","ani":"380111111" ,"dnis":"380123123", "start":"2023-10-04 10:04:07", "connect":"","record":"","type":"1","duration":"0", "disconnect_side":"-1","call_call_center_id":"0" }] | OK connect – якщо не відповіли буде пуста строка record – url запису розмови disconnect_side – кто положил трубку, -1 система(можливо по таймауту), 0 – кто дзвонив, 1 – кому дзвонили call_call_center_id – який колцентр обробив дзвінок (якщо є) |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) | |
| 402 | Проблеми с сервером |
set_webhook#
Команда дозволяє журнал дзвінків в json форматі (максимум 5000) для діапазона часу. Для Команди можливо використовувати метод GET
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку set_webhook | string | обов'язкове |
| type | «0» — вхідний, «1» — исходящий | numerical | обов'язкове |
| event_type | init - при початку дзвінка, trying - при початку вихідного плеча, connect - при піднятті слухавки абонентом, release - при закінченні вихідного плеча, disconnect - при закінченні дзвінка | string | обов'язкове |
| json | Шаблон json, який буде використовуватися у тілі вебхука. Здесь можна використовувати макросы [ani] — кто дзвонить, [dnis] — куда, [date] — поточний час, [starto] — початок вхідного плеча, [starta] — початок підняття слухавки абонентом, [durationo] — тривалість вхідного плеча, [durationa] — тривалість вихідного плеча, [anidnis] — номер оператора для вхідного дзвінка, [type] — тип дзвінка «-1» — внутрішній, «0» — вхідний, «1» — исходящий приклад: {"call_type":"[type]","event_date":"[date]", "number_a":"[ani]","number_b":"[dnis]", "call_duration": "[durationa]"} | string | Может отсутсвовать, якщо метод POST, тогда тело буде использовться как шаблон |
| header_field | Додаткове поле заголовка, яке LiraX буде вставляти в webhook приклад: Authorisation: 123123123 | string | необов'язкове |
| method | GET|POST | string | Необов'язкове за замовчуванням GET |
| url | Url для webhook приклад: https://test.test.test.com/webhook?a=1&b=2 | string | обов'язкове |
| token | ключ (token) LiraX, встановлений в налаштуваннях інтеграції | string | обов'язкове |
Приклад запиту:
GET https://api.lirax.net/general?cmd=set_webhook&type=0&event_type=disconnect&url=https://test.test.test.com/webhook?a=1&b=2
&json={"call_type":"[type]","event_date":"[date]","number_a":"[ani]","number_b":"[dnis]","call_duration":"[durationa]"}
&token=-----Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | Успешно | |
| 400 | Передано некоректні параметри, або параметри неоновлені | |
| 401 | Передано неправильний ключ (token) | |
| 402 | Проблеми с сервером |
Завантаження історії дзвінків#
Авторизація через API
Проводить авторизацію користувача в системі. Усі методы API могут бути використані лише після авторизації.
В відповідь на запит, за вдалої авторизації, крім тіла відповіді вертається cookie файл, содержащий ключ сесії, аналогично работі з WEB-браузером. При подальших запитах до API-методам треба передавати полученные cookie. Час життя сесії - 15 хвилин.
Усі запити до API йдуть з під користувача, атрибути якого були використані для авторизації через даний метод. При цьому ми враховуємо усі права користувача, т.т. через API не можна отримати більше даних, ніж сам користувач може побачити через интерфейс системи. Ми радимо для API створювати окремого користувача для більш специфічного налаштування прав підключаємого застосунку.
Resource URL
POST
https://lira.lirax.net/api/private/api/auth.php
Parameters
| PARAMETER | DESCRIPTION |
|---|---|
| USER_LOGIN | require Логін користувача. |
| USER_HASH | require Пароль користувача. |
Дзвінки
https://lira.lirax.net/services/call_show.php?action=show&date_start=2016-12-06 00:00:00&date_finish=2016-12-13 23:59:59&filter=call_ani_dnis&filter_value=&call_type=&call_connect=&call_export=1
date_start
Дата Від
date_finish
Дата До
filter
Фільтр по полю
можливі значення:
"call_ani", "call_dnis", "call_ani_dnis", "call_originip", "call_destination", "call_origination", "call_utm_source", "call_utm_medium", "call_utm_campaign", "call_utm_term"
filter_value
Значення фільтра
call_type
можливі значення:
0 вхідні, 1 вихідні
call_connect
можливі значення:
0 не було розмови, 1 була розмова
Команди від LiraX до ВПП#
makecall_finished#
Команда информирует завершения задания на создания дзвінка для 2-х абонентов.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку makecall_finished | string | |
| id_makecall | Id - makecall | string | |
| Call_id | Call_id вихідного плеча дзвінка | string | при success=0 пуст |
| success | Поднята трубка абонентом | Integer | 0|1 |
| from_LiraX_token | ключ (token) ВПП, зазначену в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://domain/LiraX
cmd=makecall_finished
id_makecall=ef232234feb12
from_LiraX_token=303cb962ac59075b964b07152d234b70
Call_id=b964b07152d
success=1Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
make2calls_finished#
Команда информирует завершения задания на создания дзвінка для 2-х абонентов.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку make2calls_finished | string | |
| id_make2calls | Id - make2calls | string | |
| success | Было ли поднятие слухавки | Integer | 0- небыло, 1- подняли трубку |
| duration_success | тривалість розмови была не менше, чем ожидалась в параметре successtime | Integer | 0- менше, 1- більше равно |
| keys | Json массив нажатых кнопок, ivr_name – імʼя IVR, ivr_entry – пункт IVR меню, key – выбранная кнопка | Json | Может отсутствовать |
| from_LiraX_token | ключ (token) ВПП, зазначену в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://domain/LiraX
cmd=make2calls_finished
id_make2calls=ef232234feb12
from_LiraX_token=303cb962ac59075b964b07152d234b70
success=1
keys=[{"ivr_name":"Test","ivr_entry":"0","key":"9"},{"ivr_name":"Test","ivr_entry":"09","key":"7"}]
duration_success=0Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
staton#
Команда информирует про статусах співробітников.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку staton | string | |
| ext | внутрішній номер співробітника LiraX | string | |
| status | идентификатор статуса співробітника в личном кабінеті | Integer | 0- отключился, 1- свободен, >1 -занят, значення Згідно настроек |
| from_LiraX_token | ключ (token) ВПП, зазначену в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://domain/LiraX
cmd=staton
ext=910
from_LiraX_token=303cb962ac59075b964b07152d234b70
status=1Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
smsDelivered#
Команда информирует про доставке SMS.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку smsDelivered | string | |
| id_sms | Id SMS, полученный командою sendSMS | Integer | |
| from_LiraX_token | ключ (token) ВПП, зазначену в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://domain/LiraX
cmd=smsDelivered
from_LiraX_token=303cb962ac59075b964b07152d234b70
id_sms=1212Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
smsReceived#
Команда информирует про получении SMS.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку smsReceived | string | |
| ani | Номер телефону абонента | string | |
| id | Id SMS, полученный від провайдера | Integer | |
| provider | Імʼя провайдера (номер телефону) | string | |
| text | Текст повідомлення | string | В UTF8 |
| from_LiraX_token | ключ (token) ВПП, зазначену в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://domain/LiraX
cmd=smsReceived
from_LiraX_token=303cb962ac59075b964b07152d234b70
id_sms=121
ani=38012345679
provider=380112345678
text=HelloВаріанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | Передано некоректні параметри | |
| 401 | Передано неправильний ключ (token) |
contact#
Команда для получения інформації про наименовании клиента і його ответственном співробітнике по номером його телефону.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку contact | string | |
| phone | номер контакту | string | |
| callid | уникальный id дзвінка | string | |
| diversion | внешний номер телефону LiraX через який поступил дзвінок | string | при исходящем равен номером абонента |
| from_LiraX_token | ключ (token) ВПП, зазначену в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://domain/LiraX
cmd=contact
phone=19101234567
diversion=12101234567
from_LiraX_token=303cb962ac59075b964b07152d234b70
callid=D12D0EB124F4E64AF4EA-1511Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | { "contact_name": "Иванов Иван Иванович", "responsible": 103 } | responsible - короткий номер відповідального користувача, может отсутствовать, якщо такого нет або у него не задан короткий номера |
| 400 | { "error": "Invalid parameters" } | Передано некоректні параметри |
| 401 | { "error": "Invalid token" } | Передано неправильний ключ (token) |
event#
LiraX отправляет в ВПП уведомления про событиях дзвінків: появлении, принятии або завершении дзвінка, а також информацию про звонке при його завершении.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку event | string | |
| type | тип дзвінка | in/out | вхідний / исходящий |
| event | тип события, связанного со звонком: INCOMING - пришел вхідний дзвінок (в это час у менеджера має начать телефонувати телефон). ACCEPTED - дзвінок успешно принят (менеджер снял трубку). COMPLETED - дзвінок завершен (менеджер або клієнт положили трубку після розмови). CALL_COMPLETED – дзвінок полностью завершен. | string | |
| phone | номер телефону клиента | string | |
| diversion | внешний номер телефону LiraX через який поступил або вышел дзвінок | string | |
| ext | внутрішній номер співробітника LiraX, в випадку CALL_COMPLETED і type=in, содержит номер, на який пришел виклик | string | |
| callid | уникальный id дзвінка | string | |
| duration | продолжительность розмови в секундах | int | при event=COMPLETED, CALL_COMPLETED |
| call_duration | Продолжительность дзвінка на момент события в секундах | int | при event=COMPLETED, CALL_COMPLETED |
| is_recorded | записан ли дзвінок | 0/1 | при event=COMPLETED, CALL_COMPLETED |
| status | статус вхідного дзвінка: Success - успішний вхідний дзвінок Missed – пропущенный вхідний дзвінок статус вихідного дзвінка: Success - успішний исходящий дзвінок Busy - LiraX получила відповідь Занято NotAvailable - LiraX получила відповідь Абонент недоступен NotAllowed - Звонки на это направление запрещены | string | при event=COMPLETED, CALL_COMPLETED |
| record_link | посилання на запись дзвінка, якщо LiraX может предоставить её одразу, якщо нет - посилання отправляется командой record | string | при event=COMPLETED, CALL_COMPLETED |
| tid | Tracking Id | ||
| cid | Client Id | ||
| cs | Істочник | ||
| cm | Медиум | ||
| cc | ДОампания | ||
| ct | Терм | ||
| keys | Последний выбор IVR menu | json | при event= CALL_COMPLETED |
| From_LiraX_token | ключ (token) ВПП, зазначену в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://domain/LiraX
cmd=event
type=out
event=COMPLETED
phone=19101234567
ext=102
callid=D10D0EB124F4E64AF4EA-1511
duration=124
is_recorded=1
status=Success
record_link=https://link/file.wav
keys=[{"ivr_name":"Test","ivr_entry":"09","key":"4"}]
from_LiraX_token=303cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | { "error": "Invalid parameters" } | Передано некоректні параметри |
| 401 | { "error": "Invalid token" } | Передано неправильний ключ (token) |
record#
Поідомлення мітить информациію про запис розмови.
Параметри запиту:
| Імʼя | Опис | Тип/формат даних | Примітка |
|---|---|---|---|
| cmd | тип операції, у цьому випадку record | string | |
| callid | унікальний id дзвінка | string | |
| record_link | посилання на запись дзвінка | string | |
| from_LiraX_token | ключ (token) ВПП, зазначену в налаштуваннях інтеграції | string |
Приклад запиту:
POST https://domain/LiraX
cmd=record
callid=D10D0EB124F4E64AF4EA01511
record_link=https://link/file.wav
from_LiraX_token=303cb962ac59075b964b07152d234b70Варіанти відповіді:
| HTTP код | Тіло | Опис |
|---|---|---|
| 200 | OK | |
| 400 | { "error": "Invalid parameters" } | Передано некоректні параметри |
| 401 | { "error": "Invalid token" } | Передано неправильний ключ (token) |
ChangeLog#
2021-01-28
make2calls- додано поле FirstInternal2021-02-18
getContact- додана функція2021-02-19
getStatInfo- додана функція2021-04-12
AskQuestion- додана функція2021-04-13
AddTag- додана функція2021-04-13
DelTag- додана функція2021-04-14
checkContact — додано поле tag2021-08-13
get_sip_route_in — додана функція2021-08-13
set_sip_route_in — додана функція2021-09-12
SecondInternal в функції make2calls2021-09-12
SpeechNoWait в функції make2calls2021-10-26
set_call_lost- додана функція2021-10-28
get_makecall_data - додана функція2021-11-19
set_call_lost - додані поля info, minutes, hours, days, weeks, months2021-12-30
createTask — додано параметр email, якщо контакт не існує, створюється новий2022-08-25
Event — додано параметр call_duration2022-11-10
send_cloud_message - додана функція2023-10-04
get_calls- додана функція2023-10-20
AddTaskResult- додана функція2024-09-24
GetTask- додана функція2026-09-16
Використовується домен api.lirax.net