LiraX API do telefonii

Ogólne informacje o interfejsach API#

API umożliwia podłączenie dowolnego produktu programowego (SPP) do LiraX.

Integracja z LiraX rozwiązuje kilka problemów biznesowych:

• uzyskanie imienia i nazwiska osoby dzwoniącej na podstawie numeru telefonu;
• uzyskanie numeru menedżera przypisanego klientowi;
• wyświetlanie informacji o połączeniu przychodzącym bezpośrednio w RFP;
• zapisywanie historii wszystkich połączeń i linków do nagrań rozmów w ramach WPP;
• tworzenie kontaktu:
• Tworzenie zadania dla kontaktu i menedżera;
• Tworzenie notatki dla kontaktu;
• Tworzenie umowy o kontakt;
• Aktualizacja umowy
• wykonywanie połączeń wychodzących bezpośrednio z interfejsu RPP.

Integracja powinna być dwukierunkowa. Zatem część żądań LiraX wysyła do RPP w kierunku określonych punktów wejścia, a część żądań, wręcz przeciwnie, RPP wysyła do LiraX w kierunku pojedynczego punktu wejścia.

Interakcja odbywa się za pomocą protokołu HTTPS. Autoryzacja odbywa się odpowiednio na adresie LiraX lub VPP, przy użyciu klucza autoryzacyjnego uzyskanego podczas konfiguracji integracji.

Zasada autoryzacji i interakcji#

HTTPS:

• Żądania do LiraX są akceptowane wyłącznie przez HTTPS. Zapewnia to wystarczający poziom bezpieczeństwa dla systemów komunikujących się przez Internet.
• З ze względów bezpieczeństwa prosimy o wdrożenie akceptacji żądań po stronie WPP również za pomocą protokołu HTTPS.

Klucz (token):

• Dodatkowo, do autoryzacji każdego żądania do LiraX używany jest specjalny klucz (token). Można go uzyskać w ustawieniach integracji.
• Proszę wdrożyć akceptowanie żądań po stronie WPP również za pomocą klucza (tokena). Wygeneruj klucz i wklej go w odpowiednie pole w sekcji ustawień integracji.
• Klucze są tworzone jednorazowo podczas konfiguracji integracji. W razie potrzeby możesz zmienić klucz po swojej stronie i zaktualizować go w interfejsie LiraX.

Prośby od LiraX do WFP:

• Żądania muszą być wysyłane na adres określony w ustawieniach integracji w celu otrzymywania wiadomości, np. https://domena/LiraX.
• W treści żądania należy zawsze przekazać specjalny klucz w specjalnym polu „token”.
• Żądania są wysyłane w formacie application/x-www-form-urlencoded

Prośby WFP do LiraX:

• WFP powinien wysyłać wszystkie żądania na adres określony w ustawieniach integracji.
• W treści wiadomości VPP musi przekazać klucz (token) określony przez Ciebie w szafie webowej.
• Żądania są wysyłane w formacie application/x-www-form-urlencoded

Odpowiedzi

• Wszystkie odpowiedzi na zapytania LiraX muszą zostać wysłane przez WFP w formacie JSON w treści odpowiedzi.
• LiraX wysyła wszystkie odpowiedzi na żądania WPP w formacie JSON w treści odpowiedzi.

Lista poleceń API#

Z pasa startowego do 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
• Pobierz historię połączeń

Z LiraX na pas startowy:

• staton (POST)
• smsDelivered (POST)
• smsReceived (POST)
• contact (POST)
• event (POST)
• record (POST)

*Wszystkie żądania z typem zawartości: application/x-www-form-urlencoded

Polecenia API i przykłady dostępnych skryptów#

Zespoły z WPP do LiraX#

makeCall#

Polecenie jest potrzebne do zainicjowania połączenia między menedżerem a klientem. W wyniku pomyślnego wykonania polecenia, LiraX najpierw wykona połączenie na telefon menedżera, a następnie połączy go z klientem.

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=makeCall
from=101
to=19101234567
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

killCall#

Polecenie jest potrzebne do wymuszonego zakończenia połączenia między menedżerem a klientem.

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=killCall
Call_id=101234234234s3
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

make2Calls#

Polecenie jest potrzebne do połączenia dwóch abonentów. W wyniku pomyślnego wykonania polecenia, LiraX najpierw wykona połączenie na telefon to1, a następnie połączy się z to2. Polecenie from jest potrzebne do prawidłowego przekierowania połączenia.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

AskQuestion#

Polecenie jest potrzebne do zadania abonentowi pytania i uzyskania odpowiedzi. W wyniku pomyślnego wykonania polecenia, LiraX najpierw wykona połączenie na numer telefonu to1, a następnie odtworzy powitanie „hello”. W razie potrzeby możliwe jest dodatkowe odtworzenie do 4 wiadomości „text1-4” w wybranym języku (w razie potrzeby wymagane są pauzy). Następnie odtwarzane jest pytanie. Jeśli funkcja rozpoznawania głosu jest włączona, oczekuje ona poprawnych słów w odpowiedzi „ok”, a jeśli nie, oczekuje na naciśnięcie przycisku. Do prawidłowego przekierowania połączenia wymagane jest polecenie „From”. Reakcja jest podobna do polecenia make2calls.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=AskQuestion
from=101
cburl=https://mydomain.co/
to1=19101234561
token=202cb962ac59075b964b07152d234b70
hello=ru Gratulacje
text1=ru Oferowana jest nowa usługa
ask=ru Jeśli tego chcesz, powiedz.
ok=ru tak bardzo bym tego pragnął.
bye=ru Do widzenia

Opcje odpowiedzi:

AddTag#

Zespół dodaje tag do kontaktu.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

DelTag#

Polecenie usuwa tag z kontaktu.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

get_sip_route_in#

Polecenie jest potrzebne do zdefiniowania listy numerów SIP dla numeru wewnętrznego telefonu.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=get_sip_route_in
phone=302
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

set_sip_route_in#

Polecenie jest potrzebne do ustawienia priorytetu numeru SIP dla numeru wewnętrznego telefonu.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

getUserSips#

Polecenie jest potrzebne, aby ustalić, czy dla numeru zewnętrznego są dostępne telefony.

Zespół buforuje dane i aktualizuje je raz na godzinę.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

IsFreeUsers#

Polecenie jest potrzebne, aby ustalić, czy użytkownik telefonu internetowego może odebrać połączenie.

Polecenie sprawdza: - czy telefon internetowy jest włączony; - czy nie ma żadnej rozmowy z użytkownikiem i zwraca pierwszy wolny numer

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

IsCalling#

Polecenie sprawdza, czy istnieje konwersacja z numerem SIP i zwraca pierwszy numer bez konwersacji (sprawdza rejestrację)

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

AddCampaign#

Polecenie jest potrzebne do utworzenia lub skonfigurowania kampanii mającej na celu wykonywanie połączeń do subskrybentów lub wysyłanie wiadomości SMS.

Dzwoniąc do abonentów, połączenie jest najpierw kierowane do użytkownika, a dopiero później do abonenta.

Parametry zapytania:

Uwaga: W przypadku typu 1 liczba jednoczesnych połączeń jest definiowana w ustawieniach kampanii na koncie użytkownika.

W trybie podglądu połączenie jest najpierw kierowane do użytkownika, a następnie do abonenta, z komunikatem!=NULL w przeciwnym kierunku

Przykładowe zapytanie:

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
lub
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

Opcje odpowiedzi:

AddPhoneCampaign#

Polecenie jest potrzebne do dodania numerów telefonów do kampanii w celu wykonywania połączeń do subskrybentów lub wysyłania wiadomości SMS.

podczas dzwonienia do abonentów połączenie jest najpierw kierowane do użytkownika, a następnie do abonenta w celu uzyskania podglądu, z komunikatem!=NULL w przeciwnym kierunku

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=AddPhoneCampaign
from=101
Phones=12121234567,12121234568,12121234569
token=202cb962ac59075b964b07152d234b70

checkContact#

Polecenie jest potrzebne do utworzenia nowego kontaktu lub aktualizacji istniejącego, aktualizowane są nazwa kontaktu i pracownik odpowiedzialny.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

getContact#

Polecenie jest potrzebne w celu uzyskania informacji o istniejącym kontakcie i odpowiedzialnym za niego pracowniku.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

getStatInfo#

Polecenie jest potrzebne do uzyskania statystyk połączeń do pracowników za okres nie dłuższy niż miesiąc. Polecenie można użyć nie częściej niż raz na godzinę.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=getStatInfo
Start=2021:01:01 00:00:00
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

createTask#

Polecenie jest potrzebne do utworzenia nowego zadania dla pracownika odpowiedzialnego i kontaktu. Jeśli kontakt nie istnieje, zostanie utworzony nowy.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=createTask
ext=101
dział=Sprzedaż
ani=19101234567
tekst=Przygotuj zadanie
date=2017-01-01 17:00:01
type=1
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

AddTaskResult#

Zespół jest potrzebny do dodania wyniku do zadania, ukończenia zadania lub zmiany osoby odpowiedzialnej.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=AddTaskResult
ext=101
idtask=123123
newext=191
tekst=Zadanie na etapie 1
finish=0
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

GetTask#

Zespół jest potrzebny do dodania wyniku do zadania, ukończenia zadania lub zmiany osoby odpowiedzialnej.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=GetTask
task_id=123123
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

createNote#

Polecenie jest potrzebne do utworzenia notatki dla istniejącego kontaktu od pracownika odpowiedzialnego.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=createNote
ext=101
ani=19101234567
tekst=Wiadomości
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

createDeal#

Polecenie jest potrzebne do utworzenia nowej umowy dla pracownika odpowiedzialnego i istniejącego kontaktu.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=createDeal
ext=101
ani=19101234567
nazwa=Przygotuj zadanie
sum=3030
stage=1
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

updateDeal#

Polecenie jest potrzebne do aktualizacji istniejącej transakcji o identyfikatorze id_deal dla pracownika odpowiedzialnego i istniejącego kontaktu.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=updateDeal
ext=101
ani=19101234567
id_deal=1910
nazwa=Przygotuj zadanie
sum=3030
stage=2
status=0
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

addBlackPhone#

Polecenie jest potrzebne, aby dodać numer telefonu do czarnej listy (tylko cyfry).

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=addBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

listBlackPhone#

Polecenie jest potrzebne do uzyskania czarnej listy telefonów.

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=listBlackPhone
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

delBlackPhone#

Polecenie jest potrzebne do usunięcia numeru telefonu z czarnej listy (tylko cyfry).

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=delBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

listBlackIP#

Polecenie jest potrzebne do uzyskania czarnej listy adresów IP

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=listBlackIP
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

addBlackIP#

Polecenie jest potrzebne, aby dodać adres IP do czarnej listy.

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=addBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

delBlackIP#

Polecenie jest potrzebne do usunięcia adresu IP z czarnej listy.

Parametry zapytania:

Przykładowe zapytanie:

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

cmd=delBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

getStages#

Polecenie jest potrzebne do uzyskania listy etapów transakcji posortowanych według Vortex.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

getShops#

Polecenie jest potrzebne do uzyskania listy sklepów.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

getUserStatuses#

Polecenie jest potrzebne do uzyskania listy statusów użytkowników.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

getUsers#

Polecenie jest potrzebne do uzyskania listy użytkowników

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

initStatuses#

To polecenie jest potrzebne do pobrania aktualnych statusów operatorów za pośrednictwem webhooków. Jest ono używane podczas włączania integracji. Kolejne statusy zostaną pobrane, jeśli ulegną zmianie; poprzednie statusy należy zignorować.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

sendMsg#

Polecenie jest potrzebne do wysłania wiadomości do pracownika w komunikatorze firmowym.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=sendMsg
ext=101
ani=19101234567
tekst=Przygotuj zadanie
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

send_cloud_message#

Polecenie jest potrzebne do wysłania wiadomości do komunikatora w chmurze (Telegram, Viber, Facebook).

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=send_cloud_message
client=web_t123123123_00000
tekst=Przygotuj zadanie
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

sendSMS#

Polecenie jest potrzebne do wysłania SMS-a przez modem GSM. Żądania powinny być wysyłane nie częściej niż co 5 sekund na modem.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=sendSMS
ext=101
phone=19101234567
provider=380123456789
tekst=Przygotuj zadanie
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

checkSMS#

Polecenie jest potrzebne do sprawdzenia statusu dostarczenia wiadomości SMS przez modem GSM. Żądania powinny być wysyłane nie częściej niż co 5 sekund na modem.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=checkSMS
ext=101
id_sms=1910123
provider=380123456789
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

EncodePhone#

Polecenie jest potrzebne do weryfikacji otrzymanego zaszyfrowanego numeru.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=EncodePhone
phone=12123123123
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

DecodePhone#

Polecenie jest potrzebne do uzyskania odszyfrowanego numeru.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=DecodePhone
phone=12123120960170061170799
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

set_call_lost#

Polecenie jest potrzebne do ustawienia numeru telefonu jako nieodebranego połączenia w celu wykonania funkcji CallBack

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=set_call_lost
phone=12123120960
ext=222
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

get_makecall_data#

Polecenie pozwala na uzyskanie informacji o wywołaniu przy użyciu identyfikatora id_makecall, uzyskanego poleceniem makecall.

Parametry zapytania:

Przykładowe zapytanie:

POST https://api.lirax.net/general
cmd=get_makecall_data
id_makecall=e5251de22f99e071
token=202cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

get_calls#

Polecenie umożliwia rejestrowanie połączeń w formacie JSON (maksymalnie 5000) dla określonego przedziału czasowego. Możesz użyć metody GET dla polecenia.

Parametry zapytania:

Przykładowe zapytanie:

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=-----

Opcje odpowiedzi:

set_webhook#

Polecenie umożliwia rejestrowanie połączeń w formacie JSON (maksymalnie 5000) dla określonego przedziału czasowego. Możesz użyć metody GET dla polecenia.

Parametry zapytania:

Przykładowe zapytanie:

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=-----

Opcje odpowiedzi:

Pobierz historię połączeń#

Autoryzacja poprzez API

Autoryzuje użytkownika w systemie. Wszystkie metody API mogą być używane dopiero po autoryzacji.

W odpowiedzi na żądanie, po pomyślnej autoryzacji, oprócz treści odpowiedzi, zwracany jest plik cookie zawierający klucz sesji, podobnie jak w przypadku przeglądarki internetowej. W kolejnych żądaniach do metod API, otrzymany plik cookie musi zostać przekazany. Czas życia sesji wynosi 15 minut.

Wszystkie żądania do API pochodzą od użytkownika, którego atrybuty zostały użyte do autoryzacji za pomocą tej metody. Uwzględniamy przy tym wszystkie uprawnienia użytkownika, co oznacza, że nie można uzyskać za pośrednictwem API więcej danych, niż użytkownik może zobaczyć w interfejsie systemowym. Zalecamy utworzenie osobnego użytkownika dla API w celu bardziej szczegółowych ustawień uprawnień połączonej aplikacji.

Resource URL

POST

https://lira. lirax. net/api/private/api/auth. php

Parameters

Połączenia

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

Data od

date_finish

Data do

filter

Filtruj według pola

możliwe wartości:

"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

Wartość filtra

call_type

możliwe wartości:

0 przychodzące, 1 wychodzące

call_connect

możliwe wartości:

0 nie było żadnej rozmowy, 1 była rozmowa

Zespoły z LiraX na pas startowy#

makecall_finished#

Polecenie informuje o zakończeniu zadania utworzenia połączenia dla 2 abonentów.

Parametry zapytania:

Przykładowe zapytanie:

POST https://domain/LiraX
cmd=makecall_finished
id_makecall=ef232234feb12
from_LiraX_token=303cb962ac59075b964b07152d234b70
Call_id=b964b07152d
success=1

Opcje odpowiedzi:

make2calls_finished#

Polecenie informuje o zakończeniu zadania utworzenia połączenia dla 2 abonentów.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

staton#

Zespół informuje o statusie pracowników.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

smsDelivered#

Zespół informuje o dostarczeniu SMS-ów.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

smsReceived#

Zespół informuje o otrzymaniu wiadomości SMS.

Parametry zapytania:

Przykładowe zapytanie:

POST https://domain/LiraX
cmd=smsReceived
from_LiraX_token=303cb962ac59075b964b07152d234b70
id_sms=121
ani=38012345679
provider=380112345678
text=Hello

Opcje odpowiedzi:

contact#

Polecenie umożliwiające uzyskanie informacji o nazwisku klienta i odpowiedzialnym za niego pracowniku na podstawie numeru jego telefonu.

Parametry zapytania:

Przykładowe zapytanie:

POST https://domain/LiraX
cmd=contact
phone=19101234567
diversion=12101234567
from_LiraX_token=303cb962ac59075b964b07152d234b70
callid=D12D0EB124F4E64AF4EA-1511

Opcje odpowiedzi:

event#

LiraX wysyła powiadomienia do WPP o zdarzeniach związanych z połączeniami: rozpoczęciu, odebraniu lub zakończeniu połączenia, a także informacje o połączeniu po jego zakończeniu.

Parametry zapytania:

Przykładowe zapytanie:

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

Opcje odpowiedzi:

record#

Wiadomość zawiera informacje o nagraniu rozmowy.

Parametry zapytania:

Przykładowe zapytanie:

POST https://domain/LiraX

cmd=record
callid=D10D0EB124F4E64AF4EA01511
record_link=https://link/file.wav
from_LiraX_token=303cb962ac59075b964b07152d234b70

Opcje odpowiedzi:

ChangeLog#

2021-01-28

make2calls- dodano pole FirstInternal

2021-02-18

getContact- dodana metoda

2021-02-19

getStatInfo- dodana metoda

2021-04-12

AskQuestion- dodana metoda

2021-04-13

AddTag- dodana metoda

2021-04-13

DelTag- dodana metoda

2021-04-14

checkContact — dodano pole tagu

2021-08-13

get_sip_route_in — dodana metoda

2021-08-13

set_sip_route_in — dodana metoda

2021-09-12

SecondInternal w funkcji make2calls

2021-09-12

SpeechNoWait w funkcji make2calls

2021-10-26

set_call_lost- dodana metoda

2021-10-28

get_makecall_data - dodana metoda

2021-11-19

set_call_lost - dodane pola informacji, minut, godzin, dni, tygodni, miesięcy

2021-12-30

createTask — dodano parametr e-mail, jeśli kontakt nie istnieje, tworzony jest nowy

2022-08-25

Event — dodano parametr call_duration

2022-11-10

send_cloud_message - dodana metoda

2023-10-04

get_calls- dodana metoda

2023-10-20

AddTaskResult- dodana metoda

2024-09-24

GetTask- dodana metoda

2026-09-16

Używana jest domena api.lirax.net