API documentation

LiraX API для телефонії

Загальні відомості про 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)
  • 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тип операції, у цьому випадку makeCallstring
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тип операції, у цьому випадку killCallstring
Call_idid дзвінка, отриманого в події makecall_finishedstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring

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

POST https://api.lirax.net/general

cmd=killCall
Call_id=101234234234s3
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

make2Calls#

Команда необхідна для того, щоб зʼєднати між собою два абонента. В результаті успішного виконання команди, LiraX спочатку здійснить дзвінок на телефон to1, а потім зʼєднає його з to2. From необхідний для правильної маршрутизації викликів.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку make2Callsstring
fromкороткий номер співробітника, від імені якого здійснюються вихідні викликиstring
to1номер, на який здійснюється перший викликstring
to2номер, на який здійснюється другий виклик або URL звукового файлу(mp3, wav) у випадку якщо необхідно відтворити лише звуковий файлstring
speechТекст, який має бути озвучений після підняття слухавки to1. Текст має складатися з коду мови (“uk “, “en “, “ru “) і самого текстуstringНеобовʼязковий
atempoНеобовʼязковий параметр, що зазначає швидкість відтворення від 0.5 до 2.0stringНеобовʼязковий
timeoutЧас в хвилинах (якщо більше 10 кожні 10 хвилин спроби повторюватимуться до підняття слухавки обома абонентами). За замовчуванням 0 – лише одна спробаstringНеобовʼязковий
successtimeЧас в секундах – Скільки секунд має тривати розмова, щоб вважати, що дзвінок успішний. За замовчуванням 0stringНеобовʼязковий
notbeforeЧас в годинах – До якої години не можна телефонувати. За замовчуванням 08stringНеобовʼязковий
notafterЧас в годинах – Після якої години не можна телефонувати, За замовчуванням 20stringНеобовʼязковий
tryКількість спроб додзвону на першу сторону з інтервалом 10 хвилинintegerНеобовʼязковий, за замовчуванням =1
vtimeЧас в годинах і хвилинах – hh:mm. Параметр може використовуватися для IVRstringНеобовʼязковий
vdateДата – ”dd. mm. YYYY”, ”today” або ”tomorrow”. Параметр може використовуватися для IVRstringНеобовʼязковий
vmoneyЗначення суми грошей типу float 0.00 з двома цифрами після крапки. Параметр може використовуватися для IVRstringНеобовʼязковий
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
idshopНеобовʼязковий параметр, що зазначає ID магазину, від якого буде дзвінокinteger(список ID можна отримати функцією GetShops)
FirstInternalНеобовʼязковий параметр, що зазначає, що перше плече внутрішній дзвінок якщо =1integerНеобовʼязковий
SecondInternalНеобовʼязковий параметр, що зазначає, що друге плече внутрішній дзвінок якщо =1integerНеобовʼязковий
SpeechNoWaitНеобовʼязковий параметр, якщо =1, зазначає, що speech відтворюється замість гудків при виклику сторони to2integerНеобовʼязковий

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

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тип операції, у цьому випадку AskQuestionstring
fromкороткий номер співробітника, від імені якого здійснюються вихідні викликиstring
to1номер, на який здійснюється перший викликstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
helloНеобовʼязковий параметр, предложение необхідно как привітання (типа Вітаємо)string
text1Необовʼязковий параметр, Повідомлення 0string
text2Необовʼязковий параметр, Повідомлення 0string
text3Необовʼязковий параметр, Повідомлення 0string
text4Необовʼязковий параметр, Повідомлення 0string
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тип операції, у цьому випадку AddTagstring
aniномер телефону контактуstringНеобовʼязковий
tagтегstringНеобовʼязковий
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring

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

POST https://api.lirax.net/general
cmd=AddTag
ani=19101234567
tag=OK
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

DelTag#

Команда видаляє тег в контакті

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку DelTagstring
aniномер телефону контактуstringНеобовʼязковий
tagтегstringНеобовʼязковий
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring

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

POST https://api.lirax.net/general
cmd=DelTag
ani=19101234567
tag=OK
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

get_sip_route_in#

Команда необхідна для того, щоб визначити список sip номерів для внутрішнього номера phone

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку get_sip_route_instring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
phoneВнутрішній номерstringПриклад: 302

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

POST https://api.lirax.net/general
cmd=get_sip_route_in
phone=302
token=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, якщо немає SIP-номерів отримаємо “N”:0,
N-кількість SIP-номерів,
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_instring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
phoneВнутрішній номерstringПриклад: 302
sip_numberномер SIPstringПриклад: 1115
time_planid тижневого плану (робочий=1, вечірній=2, нічний=3, свято=4)stringПриклад: 1
priorityпріоритет SIP для внутрішнього номераstringПриклад: 1

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

POST https://api.lirax.net/general
cmd=set_sip_route_in
phone=302
sip_number=1115
priority=0
time_plan=1
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200{"result":"1"}OK, при успішному оновленні, result=1, при відсутності сіпа result=0
400Передано некоректні параметри
401Передано неправильний ключ (token)
402Внутрішня помилка

getUserSips#

Команда необхідна для того, щоб визначити чи є доступні телефони для внутрішнього номера ext.

Команда кешує дані і оновлює їх 1 раз на годину

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку getUserSipsstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
extВнутрішній номерstringПриклад: 302
webЯкщо встановлено > 0, тоді повертаються лише вебтелефониintegerНеобовʼязковий

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

POST https://api.lirax.net/general
cmd=getUserSips
ext=302
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200{"user_sips":[{"phone":"10000", "user_id":"1111", "ext":"302"}]}OK, якщо немає доступних сіпів отримаємо {"user_sips":[]}
400Передано некоректні параметри
401Передано неправильний ключ (token)

IsFreeUsers#

Команда необхідна для того, щоб визначити, чи можливо, щоб користувач на вебтелефоні прийняв дзвінок.

Команда перевіряє: - чи включений Веб телефон; - чи немає розмови з користувачем і повертає перший номер з вільних

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку IsFreeUsersstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
phonesСписок внутрішніх або сіп номерів телефонівstringПриклад: 1212121,
1212123, 302
amoЯкщо встановлено в 1, тоді номери використовуються як amocrm user_idstringНеобовʼязковий

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

POST https://api.lirax.net/general
cmd=IsFreeUsers
Phones=1212121,1212123,302
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200{"result":"phoneFromPhones", "sip":"sip_number", "ext":"number"}OK, якщо усі номери зайняті отримаємо {"result":null}
400Передано некоректні параметри
401Передано неправильний ключ (token)

IsCalling#

Команда перевіряє, нет чи розмови з SIP-номером і повертає перший номер без розмови(перевіряє реєстрацію)

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку IsFreeUsersstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
phonesСписок внутрішніх або сіп номерів телефонівstringПриклад: 1212121,
1212123

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

POST https://api.lirax.net/general
cmd=IsCalling
Phones=1212121,1212123
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200{"result":"phoneFromPhones", "ext":"number"}OK, якщо усі номери зайняті отримаємо {"result":null}
400Передано некоректні параметри
401Передано неправильний ключ (token)

AddCampaign#

Команда необхідна для того, щоб створити або встановити кампанію для обдзвону абонентів або надсилання SMS.

Під час обдзвону абонентів спочатку дзвінок йде до користувача, а потім до абонента

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку AddCampaignstring
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 - SMSintegerЗа замовчуванням: 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 кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

AddPhoneCampaign#

Команда необхідна для того, щоб додати телефонні номери в кампанію для обдзвону абонентів або надсилання SMS.

при обдзвоні абонентів спочатку дзвінок йде до користувача, а потім до абоненту для режиму попереднього перегляду, при message!=NULL навпаки

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку AddPhoneCampaignstring
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=202cb962ac59075b964b07152d234b70

checkContact#

Команда необхідна для того, щоб створити новий або оновити наявний контакт, оновлюється Імʼя контакту і відповідальний співробітник.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку checkContactstring
extкороткий номер співробітника, відповідального за контактstring
aniОсновний номер телефону контактуstring
nameімʼя контактуstring
add_phoneСписок додаткових телефонівstringНеобовʼязковий
emailsСписок e-mailstringНеобовʼязковий
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
trackidGoogle tracking id for sitestringНеобовʼязковий
clientidGoogle Client idstringНеобовʼязковий
sitenameІмʼя сайтаstringНеобовʼязковий
sourceДжерелоstringНеобовʼязковий
stypeТип джерела (MediumstringНеобовʼязковий
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 кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

getContact#

Команда необхідна для того, щоб отримати інформацію про наявний контакт і його Відповідального співробітника.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку getContactstring
aniномер телефону контактуstringНеобовʼязковий
emaile-mailstringНеобовʼязковий
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тип операції, у цьому випадку getStatInfostring
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тип операції, у цьому випадку createTaskstring
extкороткий номер співробітника, відповідального за контактstring
departmentНазва Відділуstringнеобовʼязковий
aniномер телефону контактуstringОбовʼязковий ani або email
emaile-mail контактуstringОбовʼязковий ani або email
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
webhookURL для інформування про результатиstringНаприкінці буде дописано текст
textТекст завданняstring
dateДата виконання завданняDateНеобовʼязковий, За замовчуванням поточний час +1сек.
Приклад: "2017-01-01 17:00:00", має бути більше поточної дати і менше ніж два роки наперед
typeТипInteger1, 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тип операції, у цьому випадку AddTaskResultstringобовʼязковий
extкороткий номер співробітника, який додав результатstringобовʼязковий
idtaskId Завдання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тип операції, у цьому випадку AddTaskResultstringобовʼязковий
task_idId Завдання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тип операції, у цьому випадку createNotestring
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 кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

createDeal#

Команда необхідна для того, щоб створити нову угоду для Відповідального співробітника і існуючого контакту.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку createDealstring
extкороткий номер співробітника, відповідального за контактstring
aniномер телефону контактуstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
nameНазва угодиstring
sumСума угодиInteger
stageСтадія угодиIntegerДозволені лише існуючі стадії
statusСтатус угоди (необовʼязковий)Integer0-активна, 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тип операції, у цьому випадку updateDealstring
extкороткий номер співробітника, відповідального за контактstring
aniномер телефону контактуstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring
id_dealId угодиInteger
nameНазва угодиstring
sumСума угодиInteger
stageСтадія угодиIntegerДозволені лише існуючі стадії
statusСтатус угодиInteger0-активна, 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 кодТілоОпис
200OK
400Передано некоректні параметри, або параметри неоновлені
401Передано неправильний ключ (token)

addBlackPhone#

Команда необхідна для того, щоб додати в чорний список номер телефону (лише цифри).

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку addBlackPhonestring
phoneномер телефонуstringЛише цифри
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring

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

POST https://api.lirax.net/general

cmd=addBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

listBlackPhone#

Команда необхідна для того, щоб отримати Чорний список телефонів.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку listBlackPhonestring
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тип операції, у цьому випадку delBlackPhonestring
phoneномер телефонуstringЛише цифри
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring

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

POST https://api.lirax.net/general

cmd=delBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

listBlackIP#

Команда необхідна для того, щоб отримати Чорний список IP адрес

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку listBlackIPstring
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тип операції, у цьому випадку addBlackIPstring
IPIP Адресуstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring

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

POST https://api.lirax.net/general

cmd=addBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

delBlackIP#

Команда необхідна для того, щоб видалити в чорному списку IP адресу.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку delBlackIPstring
IPIP Адресуstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring

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

POST https://api.lirax.net/general

cmd=delBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

getStages#

Команда необхідна для того, щоб отримати список Стадій угод, відсортованих Згідно Вирви.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку getStagesstring
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тип операції, у цьому випадку getShopsstring
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тип операції, у цьому випадку getUserStatusesstring
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тип операції, у цьому випадку getUsersstring
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тип операції, у цьому випадку initStatusesstring
tokenключ (token) LiraX, встановлений в налаштуваннях інтеграціїstring

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

POST https://api.lirax.net/general
cmd=initStatuses
token=202cb962ac59075b964b07152d234b70

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

sendMsg#

Команда необхідна для того, щоб відправити повідомлення співробітнику в корпоративний меседжер.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку sendMsgstring
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 кодТілоОпис
200OK
400Передано некоректні параметри, або параметри неоновлені
401Передано неправильний ключ (token)

send_cloud_message#

Команда необхідна для того, щоб відправити повідомлення в хмарковий меседжер (Telegram, Viber, Facebook).

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку send_cloud_messagestring
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 кодТілоОпис
200OK
400Передано некоректні параметри, або параметри неоновлені
401Передано неправильний ключ (token)
402Повідомлення не передано

sendSMS#

Команда необхідна для того, щоб відправити SMS через GSM модем. Запити треба відсилати не частіше ніж 1 раз в 5 секунд на один модем.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку sendSMSstring
extкороткий номер співробітника, Хто надсилає SMSstringЛише цифри
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тип операції, у цьому випадку checkSMSstring
extкороткий номер співробітника, Хто надсилає SMSstringЛише цифри
providerідентифікатор провайдера (номер телефону в GSM модеме)stringЛише цифри
id_smsId отриманої командою sendSMSInteger
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тип операції, у цьому випадку EncodePhonestring
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тип операції, у цьому випадку EncodePhonestring
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_loststringобовʼязковий
phoneНомер телефонуstringЛише цифри, обовʼязковий
extНомер телефону співробітників для CallBackstringЛише цифри, обовʼязковий
time_plan1 - Робочий час,
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 кодТілоОпис
200OK
400Передано некоректні параметри, або параметри неоновлені
401Передано неправильний ключ (token)
402Проблеми з сервером

get_makecall_data#

Команда дозволяє отримати інформацію про дзвінок використовуючи id_makecall, отриманого командою makecall

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку get_makecall_datastringобовʼязковий
id_makecallотриманої в результаті makecallstringЛише цифри, обовʼязковий
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_callsstringобовʼязковий
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_webhookstringобовʼязковий
type«0» — вхідний, «1» — вихіднийnumericalобовʼязковий
event_typeinit - при початку дзвінка, 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необовʼязковий
methodGET|POSTstringНеобовʼязковий
за замовчуванням
GET
urlUrl для 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

PARAMETERDESCRIPTION
USER_LOGINrequire
Логін користувача.
USER_HASHrequire
Пароль користувача.

Дзвінки

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_finishedstring
id_makecallId - makecallstring
Call_idCall_id вихідного плеча дзвінкаstringпри success=0 пуст
successАбонент підняв слухавкуInteger0|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 кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

make2calls_finished#

Команда повідомляє про завершення завдання на створення дзвінка для 2-х абонентів.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку make2calls_finishedstring
id_make2callsId - make2callsstring
successЧи було піднято слухавкуInteger0- не було, 1- підняли слухавку
duration_successтривалість розмови была не менше, чем очікувалося в параметрі successtimeInteger0- менше, 1- більше равно
keysJson массив нажатых кнопок, 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 кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

staton#

Команда інформує про статуси співробітників.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку statonstring
extвнутрішній номер співробітника LiraXstring
statusідентифікатор статуса співробітника в особистому кабінетіInteger0- відключився, 1- вільний, >1 -зайнятий, значення Згідно налаштування
from_LiraX_tokenключ (token) ВПП, зазначену в налаштуваннях інтеграціїstring

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

POST https://domain/LiraX
cmd=staton
ext=910
from_LiraX_token=303cb962ac59075b964b07152d234b70
status=1

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

smsDelivered#

Команда інформує про доставке SMS.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку smsDeliveredstring
id_smsId SMS, отриманий командою sendSMSInteger
from_LiraX_tokenключ (token) ВПП, зазначену в налаштуваннях інтеграціїstring

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

POST https://domain/LiraX
cmd=smsDelivered
from_LiraX_token=303cb962ac59075b964b07152d234b70
id_sms=1212

Варіанти відповіді:

HTTP кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

smsReceived#

Команда інформує про отримання SMS.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку smsReceivedstring
aniНомер телефону абонентаstring
idId 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 кодТілоОпис
200OK
400Передано некоректні параметри
401Передано неправильний ключ (token)

contact#

Команда для отримання інформації про наименовании клиента і його ответственном співробітнике по номером його телефону.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку contactstring
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тип операції, у цьому випадку eventstring
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 може надати її одразу, якщо ні - посилання надсилається командою recordstringпри event=COMPLETED, CALL_COMPLETED
tidTracking Id
cidClient Id
csДжерело
cmМедіум
ccКампанія
ctТерм
keysОстанній вибір IVR menujsonпри 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 кодТілоОпис
200OK
400{ "error": "Invalid parameters" }Передано некоректні параметри
401{ "error": "Invalid token" }Передано неправильний ключ (token)

record#

Поідомлення містить інформацію про запис розмови.

Параметри запиту:

ІмʼяОписТип/формат данихПримітка
cmdтип операції, у цьому випадку recordstring
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 кодТілоОпис
200OK
400{ "error": "Invalid parameters" }Передано некоректні параметри
401{ "error": "Invalid token" }Передано неправильний ключ (token)

ChangeLog#

2021-01-28

make2calls- додано поле FirstInternal

2021-02-18

getContact- доданий метод

2021-02-19

getStatInfo- доданий метод

2021-04-12

AskQuestion- доданий метод

2021-04-13

AddTag- доданий метод

2021-04-13

DelTag- доданий метод

2021-04-14

checkContact — додано поле tag

2021-08-13

get_sip_route_in — доданий метод

2021-08-13

set_sip_route_in — доданий метод

2021-09-12

SecondInternal в функції make2calls

2021-09-12

SpeechNoWait в функції make2calls

2021-10-26

set_call_lost- доданий метод

2021-10-28

get_makecall_data - доданий метод

2021-11-19

set_call_lost - додані поля info, minutes, hours, days, weeks, months

2021-12-30

createTask — додано параметр email, якщо контакт не існує, створюється новий

2022-08-25

Event — додано параметр call_duration

2022-11-10

send_cloud_message - доданий метод

2023-10-04

get_calls- доданий метод

2023-10-20

AddTaskResult- доданий метод

2024-09-24

GetTask- доданий метод

2026-09-16

Використовується домен api.lirax.net