Allgemeine Informationen zu APIs#
API ermöglicht es Ihnen, jedes Ihrer Softwareprodukte (SPP) mit LiraX zu verbinden.
Die Integration mit LiraX löst mehrere Geschäftsprobleme:
- ermittlung des Namens des Anrufers anhand der Telefonnummer;
- ermittlung der dem Kunden zugewiesenen Managernummer;
- informationen über einen eingehenden Anruf direkt im RFP anzeigen;
- speicherung des Verlaufs aller Anrufe und Verknüpfungen zu Gesprächsaufzeichnungen innerhalb des WPP;
- einen Kontakt erstellen:
- Erstellung einer Aufgabe für einen Kontakt und einen Vorgesetzten;
- Eine Notiz für einen Kontakt erstellen;
- Erstellung einer Vereinbarung für einen Kontakt;
- Aktualisierung der Vereinbarung
- ausgehende Anrufe direkt über die RPP-Schnittstelle tätigen.
Die Integration sollte bidirektional sein. Daher sendet LiraX einige Anfragen an das RPP in Richtung der festgelegten Einstiegspunkte, und umgekehrt sendet das RPP einige Anfragen an LiraX in Richtung des einzigen Einstiegspunkts.
Die Interaktion erfolgt über das HTTPS-Protokoll. Die Autorisierung erfolgt an der LiraX- bzw. VPP-Adresse unter Verwendung des während des Integrations-Setup-Prozesses erhaltenen Autorisierungsschlüssels.
Prinzip der Autorisierung und Interaktion#
HTTPS:
- Anfragen an LiraX werden ausschließlich über HTTPS akzeptiert. Dies gewährleistet ein ausreichendes Sicherheitsniveau für die Kommunikation zwischen Systemen über das Internet.
- З zum Schutz Ihrer Daten implementieren Sie bitte auch auf der WPP-Seite die Annahme von Anfragen über HTTPS.
Schlüssel (Token):
- Zusätzlich wird ein spezieller Schlüssel (Token) verwendet, um jede Anfrage an LiraX zu autorisieren. Sie können ihn in den Integrationseinstellungen abrufen.
- Bitte implementieren Sie die Annahme von Anfragen auch auf der WPP-Seite mithilfe eines Schlüssels (Tokens). Generieren Sie den Schlüssel und fügen Sie ihn in das entsprechende Feld im Bereich der Integrationseinstellungen ein.
- Die Schlüssel werden einmalig bei der Einrichtung der Integration erstellt. Bei Bedarf können Sie den Schlüssel auf Ihrer Seite ändern und ihn in der LiraX-Oberfläche aktualisieren.
Anfragen von LiraX an das WFP:
- Anfragen müssen an die in den Integrationseinstellungen für den Empfang von Nachrichten angegebene Adresse gesendet werden, zum Beispiel https://domain/LiraX.
- Im Anfragetext muss immer ein spezieller Schlüssel im speziellen Feld „token“ übergeben werden.
- Anfragen werden im Format application/x-www-form-urlencoded gesendet.
Anfragen des WFP an LiraX:
- Das WFP sollte alle Anfragen an die in den Integrationseinstellungen angegebene Adresse senden.
- Im Nachrichtentext muss der VPP den von Ihnen im Web-Cabinet angegebenen Schlüssel (Token) übermitteln.
- Anfragen werden im Format application/x-www-form-urlencoded gesendet.
Antworten
- Alle Antworten auf LiraX-Anfragen müssen vom WFP im JSON-Format im Antworttext gesendet werden.
- LiraX sendet alle Antworten auf WPP-Anfragen im JSON-Format im Antworttext.
Liste der API-Befehle#
Von der Startbahn zu 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
- Anrufliste herunterladen
Von LiraX zur Startbahn:
- staton (POST)
- smsDelivered (POST)
- smsReceived (POST)
- contact (POST)
- event (POST)
- record (POST)
*Alle Anfragen mit Content-Type: application/x-www-form-urlencoded
API-Befehle und Beispiele verfügbarer Skripte#
Teams von WPP bis LiraX#
makeCall#
Dieser Befehl ist erforderlich, um einen Anruf vom Manager zum Kunden zu initiieren. Nach erfolgreicher Ausführung des Befehls ruft LiraX zunächst den Manager an und verbindet ihn anschließend mit dem Kunden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall makeCall | string | |
| from | kurznummer des Mitarbeiters, der den ausgehenden Anruf tätigt | string | |
| to | nummer, an die der ausgehende Anruf getätigt wird | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| idshop | Optionaler Parameter, der die Store-ID angibt, von der aus der Aufruf erfolgen soll. | integer | (Die Liste der IDs kann mit der Funktion GetShops abgerufen werden.) |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=makeCall
from=101
to=19101234567
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"id_makecall":"$id_makecall"} | OK, $id_makecall – wird beim Empfang des Webhooks makecall_finished verwendet |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
killCall#
Dieser Befehl ist erforderlich, um ein Gespräch von einem Manager mit einem Kunden zwangsweise zu beenden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall killCall | string | |
| Call_id | id anruf im Ereignis makecall_finished empfangen | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=killCall
Call_id=101234234234s3
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
make2Calls#
Dieser Befehl ist erforderlich, um zwei Teilnehmer zu verbinden. Nach erfolgreicher Ausführung des Befehls ruft LiraX zunächst das Telefon to1 an und verbindet es anschließend mit to2. Die Angabe von „From“ ist für die korrekte Anrufweiterleitung notwendig.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall make2Calls | string | |
| from | kurznummer des Mitarbeiters, in dessen Namen ausgehende Anrufe getätigt werden | string | |
| to1 | nummer, an die der erste Anruf erfolgt | string | |
| to2 | die Nummer, an die der zweite Anruf getätigt wird, oder die URL der Audiodatei (mp3, wav), falls Sie nur die Audiodatei abspielen möchten. | string | |
| speech | Der Text, der nach dem Abheben des Telefons gesprochen werden soll. Der Text sollte aus dem Sprachcode („uk“, „en“, „ru“) und dem eigentlichen Text bestehen. | string | Optional |
| atempo | Optionaler Parameter zur Angabe der Wiedergabegeschwindigkeit von 0,5 bis 2,0. | string | Optional |
| timeout | Zeit in Minuten (bei mehr als 10 Versuchen werden diese alle 10 Minuten wiederholt, bis beide Teilnehmer den Anruf annehmen). Standardwert 0 – nur ein Versuch | string | Optional |
| successtime | Zeit in Sekunden – Wie viele Sekunden das Gespräch dauern muss, um als erfolgreich zu gelten. Standardwert: 0 | string | Optional |
| notbefore | Zeit in Stunden – Bis zu welcher Uhrzeit Sie nicht anrufen können. Standardwert: 08 | string | Optional |
| notafter | Zeit in Stunden – Nach welcher Stunde können Sie nicht mehr anrufen? Standardwert: 20 | string | Optional |
| try | Anzahl der Versuche, den ersten Teilnehmer im Abstand von 10 Minuten zurückzurufen | integer | Optional, Standardwert = 1 |
| vtime | Zeitangabe in Stunden und Minuten – hh:mm. Dieser Parameter kann für IVR verwendet werden. | string | Optional |
| vdate | Datum – „TT.MM.JJJJ“, „heute“ oder „morgen“. Dieser Parameter kann für IVR verwendet werden. | string | Optional |
| vmoney | Der Geldbetrag wird als Gleitkommazahl vom Typ 0.00 mit zwei Nachkommastellen angegeben. Dieser Parameter kann für IVR-Systeme verwendet werden. | string | Optional |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| idshop | Optionaler Parameter, der die Store-ID angibt, von der aus der Aufruf erfolgen soll. | integer | (Die Liste der IDs kann mit der Funktion GetShops abgerufen werden.) |
| FirstInternal | Optionaler Parameter, der angibt, ob der erste Teil ein interner Aufruf ist, falls = 1 | integer | Optional |
| SecondInternal | Optionaler Parameter, der angibt, ob der zweite Teil ein interner Aufruf ist, falls = 1 | integer | Optional |
| SpeechNoWait | Optionaler Parameter, falls = 1, gibt an, dass beim Anruf von Teilnehmer 2 Sprache anstelle von Pieptönen abgespielt wird. | integer | Optional |
Beispielabfrage:
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=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"id_make2calls":"$id_make2calls"} | OK, $id_make2calls – wird beim Empfang des Webhooks make2calls_finished verwendet |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
AskQuestion#
Dieser Befehl dient dazu, dem Teilnehmer eine Frage zu stellen und eine Antwort zu erhalten. Nach erfolgreicher Ausführung ruft LiraX zunächst die Telefonnummer to1 an und spielt die Begrüßung „Hallo“ ab. Bei Bedarf können zusätzlich bis zu vier Nachrichten „text1-4“ in der gewählten Sprache abgespielt werden (gegebenenfalls mit Pausen). Anschließend wird die Frage abgespielt. Ist die Spracherkennung aktiviert, erwartet das System die korrekte Antwort „ok“. Erfolgt keine Spracherkennung, wird ein Tastendruck erwartet. Die Angabe „Von“ ist für die korrekte Anrufweiterleitung erforderlich. Die Reaktion entspricht dem Befehl make2calls.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall AskQuestion | string | |
| from | kurznummer des Mitarbeiters, in dessen Namen ausgehende Anrufe getätigt werden | string | |
| to1 | nummer, an die der erste Anruf erfolgt | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| hello | Optionaler Parameter, der Satz muss eine Begrüßung sein (z. B. „Herzlichen Glückwunsch“). | string | |
| text1 | Optionaler Parameter, Nachricht 0 | string | |
| text2 | Optionaler Parameter, Nachricht 0 | string | |
| text3 | Optionaler Parameter, Nachricht 0 | string | |
| text4 | Optionaler Parameter, Nachricht 0 | string | |
| bye | Optionaler Parameter, Abschiedsnachricht, wird nach der Frage ausgeführt. | string | |
| ask | Eine Frage melden | String | |
| ok | Wörter zwischen Leerzeichen, die wir in einer positiven Antwort erwarten (zum Beispiel: ja ok). | String | |
| cburl | Optionaler Parameter, URL für den Webhook mit der make2calls_finished-Nachricht, der Daten mit der Antwort des Abonnenten überträgt. | String |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=AskQuestion
from=101
cburl=https://mydomain.co/
to1=19101234561
token=202cb962ac59075b964b07152d234b70
hello=ru Glückwunsch
text1=ru Es wird ein neuer Service angeboten
ask=ru Wenn du es willst, sag es.
ok=ru ich wünschte es mir so sehr.
bye=ru Auf WiedersehenAntwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"id_make2calls":"$id_make2calls"} | OK, $id_make2calls – wird beim Empfang des Webhooks make2calls_finished verwendet |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
AddTag#
Das Team fügt dem Kontakt ein Tag hinzu.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall AddTag | string | |
| ani | kontakttelefonnummer | string | Optional |
| tag | etikett | string | Optional |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=AddTag
ani=19101234567
tag=OK
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
DelTag#
Der Befehl entfernt ein Tag von einem Kontakt.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall DelTag | string | |
| ani | kontakttelefonnummer | string | Optional |
| tag | etikett | string | Optional |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=DelTag
ani=19101234567
tag=OK
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
get_sip_route_in#
Dieser Befehl ist erforderlich, um eine Liste von SIP-Nummern für die Telefonnebenstelle zu definieren.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall get_sip_route_in | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| phone | Interne Nummer | string | Beispiel: 302 |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=get_sip_route_in
phone=302
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 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, wenn keine SIP-Nummern vorhanden sind, erhalten wir „N“:0. N-te Anzahl von SIP-Nummern, sip_name sIP-Name, sip_number – sIP-Nummer, user_name – Benutzername, ext – durchwahlnummer des Benutzers, priority – aktuelle SIP-Priorität, time_plan – id wochenplan (Arbeit=1, Abend=2, Nacht=3, Feiertag=4) |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben | |
| 402 | Interner Fehler |
set_sip_route_in#
Dieser Befehl ist erforderlich, um die Priorität der SIP-Nummer für die Telefonnummer festzulegen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall set_sip_route_in | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| phone | Interne Nummer | string | Beispiel: 302 |
| sip_number | sIP-Nummer | string | Beispiel: 1115 |
| time_plan | id wochenplan (Arbeit=1, Abend=2, Nacht=3, Feiertag=4) | string | Beispiel: 1 |
| priority | sIP-Priorität für Nebenstellennummer | string | Beispiel: 1 |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=set_sip_route_in
phone=302
sip_number=1115
priority=0
time_plan=1
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"result":"1"} | OK, bei erfolgreicher Aktualisierung: Ergebnis = 1; andernfalls: Ergebnis = 0 |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben | |
| 402 | Interner Fehler |
getUserSips#
Der Befehl ist erforderlich, um festzustellen, ob für die Nebenstelle Telefone verfügbar sind.
Das Team speichert die Daten im Cache und aktualisiert sie stündlich.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall getUserSips | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| ext | Interne Nummer | string | Beispiel: 302 |
| web | Wenn der Wert auf > 0 gesetzt ist, werden nur Webphones zurückgegeben. | integer | Optional |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=getUserSips
ext=302
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"user_sips":[{"phone":"10000", "user_id":"1111", "ext":"302"}]} | OK, wenn keine Schlucke verfügbar sind, werden wir {"user_sips":[]} |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
IsFreeUsers#
Der Befehl ist erforderlich, um festzustellen, ob es einem Benutzer eines Webtelefons möglich ist, einen Anruf anzunehmen.
Der Befehl prüft: – ob das Webtelefon eingeschaltet ist; – ob keine Verbindung zum Benutzer besteht und gibt die erste freie Nummer zurück.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall IsFreeUsers | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| phones | Liste der internen oder SIP-Telefonnummern | string | Beispiel: 1212121, 1212123, 302 |
| amo | Wenn auf 1 gesetzt, werden Zahlen als amocrm user_id verwendet. | string | Optional |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=IsFreeUsers
Phones=1212121,1212123,302
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"result":"phoneFromPhones", "sip":"sip_number", "ext":"number"} | OK, wenn alle Nummern belegt sind, erhalten wir {"result":null} |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
IsCalling#
Der Befehl prüft, ob eine Konversation mit einer SIP-Nummer besteht und gibt die erste Nummer ohne Konversation zurück (überprüft die Registrierung).
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall IsFreeUsers | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| phones | Liste der internen oder SIP-Telefonnummern | string | Beispiel: 1212121, 1212123 |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=IsCalling
Phones=1212121,1212123
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"result":"phoneFromPhones", "ext":"number"} | OK, wenn alle Nummern belegt sind, erhalten wir {"result":null} |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
AddCampaign#
Dieser Befehl wird benötigt, um eine Kampagne zum Anrufen von Abonnenten oder zum Versenden von SMS zu erstellen oder einzurichten.
Bei Anrufen an Abonnenten wird der Anruf zuerst an den Benutzer und dann an den Abonnenten weitergeleitet.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall AddCampaign | string | |
| from | kurznummer des Mitarbeiters, in dessen Namen die Kampagne durchgeführt wird | string | |
| ext | kurzwahlnummer des Mitarbeiters, unter der die Anrufe von den Mitarbeitern entgegengenommen werden (standardmäßig gleich der Absendernummer) | string | Optional |
| days | Liste der Tage (0-Sonntag, 6-Samstag) | string | Standardwert: 1, 2, 3, 4, 5 |
| time | Zeitbereich | string | Standard: 10:00-18:00 Uhr |
| pdd | Nachbearbeitungszeit (Sekunden) | integer | Standardwert: 5 |
| preview_timeout | Ausgehende Anrufverzögerung, nachdem der Mitarbeiter den Hörer abgenommen hat (Standardwert 0) | integer | Optional |
| try | anzahl der Versuche | integer | Standardwert: 1 |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| type | Kampagnentyp 1 – Telefon, 2 – SMS | integer | Standardwert: 1 |
| phones | Liste der Telefonnummern (wenn die Liste leer ist, wird die Kampagne beendet) | string | Beispiel: 12121234567, 12121234568 |
| message | Nachrichtentext, für Typ=1 muss das erste Wort Sprache sein {en, uk, ru, …} (In diesem Fall wird zuerst der Abonnent aufgerufen und preview_timeout ignoriert) | string | Erforderlich für Typ=2 |
| idshop | Optionaler Parameter, der die Store-ID angibt, von der aus der Aufruf erfolgen soll. | integer | Optional (die Liste der IDs kann mit der Funktion GetShops abgerufen werden) |
Hinweis: Bei Typ=1 wird die Anzahl der gleichzeitigen Anrufe in den Kampagneneinstellungen im Benutzerkonto festgelegt.
Im Vorschaumodus wird der Aufruf zuerst an den Benutzer und dann an den Abonnenten gesendet, wobei message!=NULL das Gegenteil bewirkt.
Beispielabfrage:
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
oder
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=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
AddPhoneCampaign#
Dieser Befehl ist erforderlich, um Telefonnummern zu einer Kampagne hinzuzufügen, mit der Abonnenten angerufen oder SMS versendet werden können.
beim Aufruf von Abonnenten geht der Anruf zuerst an den Benutzer und dann im Vorschaumodus an den Abonnenten, wobei message!=NULL das Gegenteil bewirkt.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall AddPhoneCampaign | string | |
| from | kurznummer des Mitarbeiters, in dessen Namen die Kampagne durchgeführt wird | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| phones | Liste der Telefonnummern | string | Beispiel: 12121234567, 12121234568 |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=AddPhoneCampaign
from=101
Phones=12121234567,12121234568,12121234569
token=202cb962ac59075b964b07152d234b70checkContact#
Dieser Befehl ist erforderlich, um einen neuen Kontakt anzulegen oder einen bestehenden Kontakt zu aktualisieren. Dabei werden der Kontaktname und der zuständige Mitarbeiter aktualisiert.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | vorgangstyp, in diesem Fall checkContact | string | |
| ext | kurznummer des für den Kontakt zuständigen Mitarbeiters | string | |
| ani | Telefonnummer des Hauptansprechpartners | string | |
| name | kontaktname | string | |
| add_phone | Liste zusätzlicher Telefone | string | Optional |
| emails | E-Mail-Liste | string | Optional |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| trackid | Google tracking id for site | string | Optional |
| clientid | Google Client id | string | Optional |
| sitename | Name der Website | string | Optional |
| source | Quelle | string | Optional |
| stype | Quellentyp (Mittel) | string | Optional |
| campain | Kampagne | string | Optional |
| Term | Stichwort | string | Optional |
| tag | Tag (Tag wird eingefügt, falls verfügbar) | string | Optional |
Beispielabfrage:
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.comAntwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
getContact#
Der Befehl wird benötigt, um Informationen über einen bestehenden Kontakt und dessen zuständigen Mitarbeiter zu erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall getContact | string | |
| ani | kontakttelefonnummer | string | Optional |
| string | Optional | ||
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=getContact
ani=19101234567
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"result":{"Name": "Dmytro", "Haupttelefon": "12345678901", "Verantwortlicher": "209", "SIP": "111"}} | OK Name - Name des Ansprechpartners mainphone – die erste Kontakttelefonnummer, responsible - die Durchwahlnummer der zuständigen Person, sip - sip nummer der verantwortlichen Person |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
getStatInfo#
Dieser Befehl wird benötigt, um Statistiken über Anrufe an Mitarbeiter für einen Zeitraum von maximal einem Monat zu erhalten. Der Befehl kann maximal einmal pro Stunde verwendet werden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall getStatInfo | string | |
| Start | Datum im Format „JJJJ-MM-TT HH:MM:SS“ – Beginn des Intervalls | string | |
| Stop | Datum im Format „JJJJ-MM-TT HH:MM:SS“ – Ende des Intervalls | string | Optional, falls abwesend, dann innerhalb von 24 Stunden |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=getStatInfo
Start=2021:01:01 00:00:00
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | { "results":[ { "description":"stat_info. ", "stat":[ { "login":"alex", "Name":"Alexei", "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 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
createTask#
Dieser Befehl ist erforderlich, um eine neue Aufgabe für den zuständigen Mitarbeiter und den Kontakt anzulegen. Falls der Kontakt noch nicht existiert, wird er neu angelegt.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall createTask | string | |
| ext | kurznummer des für den Kontakt zuständigen Mitarbeiters | string | |
| department | Abteilungsname | string | optional |
| ani | kontakttelefonnummer | string | Erforderlich: ANI oder E-Mail |
| e-mail kontakt | string | Erforderlich: ANI oder E-Mail | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| webhook | URL über die Ergebnisse informieren | string | Der Text wird am Ende hinzugefügt. |
| text | Aufgabentext | string | |
| date | Datum der Aufgabenerfüllung | Date | Optional, Standardeinstellung: Aktuelle Zeit +1 Sekunde. Beispiel: „2017-01-01 17:00:00“ muss nach dem aktuellen Datum und weniger als zwei Jahre in der Zukunft liegen. |
| type | Typ | Integer | 1, 2, 3 (Follow-up, Besprechung, Anruf) |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=createTask
ext=101
abteilung = Vertrieb
ani=19101234567
text=Aufgabe vorbereiten
date=2017-01-01 17:00:01
type=1
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"idtask":"22"} | OK |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
AddTaskResult#
Um ein Ergebnis zu einer Aufgabe hinzuzufügen, eine Aufgabe abzuschließen oder die verantwortliche Person zu wechseln, wird ein Team benötigt.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall AddTaskResult | string | obligatorisch |
| ext | kurznummer des Mitarbeiters, der das Ergebnis hinzugefügt hat | string | obligatorisch |
| idtask | Id Aufgabe | Integer | obligatorisch |
| newext | Neu verantwortlich | string | optional |
| finish | Die Aufgabe abschließen | bool | optional |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| text | Ergebnistext | string | obligatorisch |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=AddTaskResult
ext=101
idtask=123123
newext=191
text=Die Aufgabe in Phase 1
finish=0
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"idtask":"123123"} | OK |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
GetTask#
Um ein Ergebnis zu einer Aufgabe hinzuzufügen, eine Aufgabe abzuschließen oder die verantwortliche Person zu wechseln, wird ein Team benötigt.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall AddTaskResult | string | obligatorisch |
| task_id | Id Aufgabe | Integer | obligatorisch |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=GetTask
task_id=123123
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 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": "Sergij Rybalchenko" } ] } | Hierbei handelt es sich bei „Typ“ um die Art der Aufgabe; date_insert – erstellungsdatum; date_end – datum der Ausführung; text – aufgabentext; ext – verantwortlich; Name - name der verantwortlichen Person; coauthors - anzahl der Mitwirkenden; list – liste der Mitwirkenden |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
createNote#
Dieser Befehl ist erforderlich, um vom zuständigen Mitarbeiter eine Notiz für einen bestehenden Kontakt zu erstellen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall createNote | string | |
| ext | kurznummer des für den Kontakt zuständigen Mitarbeiters | string | |
| ani | kontakttelefonnummer | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| text | Notiztext | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=createNote
ext=101
ani=19101234567
text=News
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
createDeal#
Das Team wird benötigt, um eine neue Vereinbarung zwischen dem verantwortlichen Mitarbeiter und einem bestehenden Ansprechpartner zu erstellen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | transaktionstyp, in diesem Fall createDeal | string | |
| ext | kurznummer des für den Kontakt zuständigen Mitarbeiters | string | |
| ani | kontakttelefonnummer | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| name | Name des Geschäfts | string | |
| sum | Transaktionsbetrag | Integer | |
| stage | Vereinbarungsphase | Integer | Nur bereits bestehende Bühnen sind zulässig. |
| status | Deal-Status (optional) | Integer | 0 – Aktiv, 1 – Erfolgreich abgeschlossen, 2 – Nicht erfolgreich abgeschlossen |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=createDeal
ext=101
ani=19101234567
name=Aufgabe vorbereiten
sum=3030
stage=1
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"id_deal":$integer} | OK ($integer - ganze Zahl) |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
updateDeal#
Der Befehl ist erforderlich, um einen bestehenden Deal mit id_deal für den verantwortlichen Mitarbeiter und einen bestehenden Kontakt zu aktualisieren.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall updateDeal | string | |
| ext | kurznummer des für den Kontakt zuständigen Mitarbeiters | string | |
| ani | kontakttelefonnummer | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| id_deal | Id vereinbarungen | Integer | |
| name | Name des Geschäfts | string | |
| sum | Transaktionsbetrag | Integer | |
| stage | Vereinbarungsphase | Integer | Nur bereits bestehende Bühnen sind zulässig. |
| status | Deal-Status | Integer | 0 – aktiv, 1 – erfolgreich abgeschlossen, 2 – fehlgeschlagen |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=updateDeal
ext=101
ani=19101234567
id_deal=1910
name=Aufgabe vorbereiten
sum=3030
stage=2
status=0
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben |
addBlackPhone#
Dieser Befehl ist erforderlich, um eine Telefonnummer zur Sperrliste hinzuzufügen (nur Nummern).
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall addBlackPhone | string | |
| phone | telefonnummer | string | Nur Zahlen |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=addBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
listBlackPhone#
Dieser Befehl wird benötigt, um die Sperrliste der Telefone zu erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | art der Operation, in diesem Fall listBlackPhone | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=listBlackPhone
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"blacklist":["phone1", "phone2", . .. , "phoneN"]} | OK |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
delBlackPhone#
Dieser Befehl ist erforderlich, um eine Telefonnummer von der Sperrliste zu entfernen (nur Nummern).
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | art der Operation, in diesem Fall delBlackPhone | string | |
| phone | telefonnummer | string | Nur Zahlen |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=delBlackPhone
phone=100111000101
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
listBlackIP#
Dieser Befehl wird benötigt, um die IP-Adressen-Sperrliste abzurufen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall listBlackIP | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=listBlackIP
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"blacklist":["IP1", "IP2", . .. , "IPN"]} | OK |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
addBlackIP#
Dieser Befehl ist erforderlich, um eine IP-Adresse zur Blacklist hinzuzufügen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall addBlackIP | string | |
| IP | IP Adresse | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=addBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
delBlackIP#
Dieser Befehl ist erforderlich, um eine IP-Adresse von der Blacklist zu entfernen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall delBlackIP | string | |
| IP | IP Adresse | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=delBlackPhone
IP=100.111.000.101
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
getStages#
Dieser Befehl wird benötigt, um eine Liste der Deal-Phasen, sortiert nach Vortex, zu erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall getStages. | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=getStages
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"stages":[{"stage":$stage, "title":". .. "}, . .. ]} | OK |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
getShops#
Dieser Befehl wird benötigt, um eine Liste der Geschäfte zu erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall getShops | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=getShops
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"shops":[{"id":$id_shop, "name":". .. "}, . .. ]} | OK |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
getUserStatuses#
Dieser Befehl wird benötigt, um eine Liste der Benutzerstatus zu erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall getUserStatuses | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=getUserStatuses
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"statuses":[{"status":$status, "title":". .. "}, . .. ]} | OK |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
getUsers#
Dieser Befehl wird benötigt, um eine Liste der Benutzer zu erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall getUsers | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=getUsers
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"users":[{"id":$id, "Name":". .. ", "ext":". .. ", "active":"0|1"}, . .. ]} | OK |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
initStatuses#
Dieser Befehl ist erforderlich, um die aktuellen Status der Bediener per Webhook abzurufen. Er wird bei der Aktivierung der Integration verwendet. Weitere Statusmeldungen werden bei Änderungen empfangen; vorherige Statusmeldungen werden ignoriert.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall initStatuses | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=initStatuses
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
sendMsg#
Dieser Befehl ist erforderlich, um eine Nachricht an einen Mitarbeiter über den Firmen-Messenger zu senden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall sendMsg | string | |
| ext | kurznummer des Mitarbeiters, an den die Nachricht gesendet wird | string | |
| ani | name des Kontakts, der die Nachricht gesendet hat | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| text | Nachrichtentext | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=sendMsg
ext=101
ani=19101234567
text=Aufgabe vorbereiten
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben |
send_cloud_message#
Dieser Befehl ist erforderlich, um eine Nachricht an einen Cloud-Messenger (Telegram, Viber, Facebook) zu senden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall send_cloud_message | string | |
| client | Cloud Messenger Client-ID | string | obligatorisch in Abwesenheit von Tieren |
| ani | Telefonnummer des Kunden (wird ausschließlich über Telegram genutzt) | obligatorisch, wenn kein Kunde anwesend ist | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| text | Nachrichtentext | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=send_cloud_message
client=web_t123123123_00000
text=Aufgabe vorbereiten
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben | |
| 402 | Nachricht nicht zugestellt |
sendSMS#
Dieser Befehl ist erforderlich, um SMS über ein GSM-Modem zu versenden. Anfragen sollten pro Modem maximal einmal alle 5 Sekunden gesendet werden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall sendSMS | string | |
| ext | kurznummer des Mitarbeiters, der die SMS sendet | string | Nur Zahlen |
| provider | anbieterkennung (Telefonnummer im GSM-Modem) | string | Nur Zahlen |
| phone | Telefonnummer, an die wir die Nachricht senden | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | |
| text | Nachrichtentext | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=sendSMS
ext=101
phone=19101234567
provider=380123456789
text=Aufgabe vorbereiten
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"id_sms":$id_sms} | OK |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben | |
| 402 | Das Modem ist nicht angeschlossen. | |
| 403 | Das Modem ist belegt, bitte versuchen Sie es später erneut. |
checkSMS#
Dieser Befehl ist erforderlich, um den Status der SMS-Zustellung über ein GSM-Modem zu überprüfen. Anfragen sollten pro Modem maximal einmal alle 5 Sekunden gesendet werden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall checkSMS | string | |
| ext | kurznummer des Mitarbeiters, der die SMS sendet | string | Nur Zahlen |
| provider | anbieterkennung (Telefonnummer im GSM-Modem) | string | Nur Zahlen |
| id_sms | Id empfangen vom sendSMS-Befehl | Integer | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=checkSMS
ext=101
id_sms=1910123
provider=380123456789
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"sms_status":$id_status} | OK, 1- an den Anbieter weitergeleitet, Status unbekannt; 2- an den Anbieter übergeben, Zustellung läuft; 3- geliefert; 4- Die Lieferzeit ist abgelaufen. |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben |
EncodePhone#
Dieser Befehl ist erforderlich, um die empfangene verschlüsselte Nummer zu überprüfen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall EncodePhone | string | |
| phone | Telefonnummer | string | Nur Zahlen |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=EncodePhone
phone=12123123123
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"phone":$encoded} | OK |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben |
DecodePhone#
Dieser Befehl ist erforderlich, um die entschlüsselte Nummer zu erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall EncodePhone | string | |
| phone | Telefonnummer | string | Nur Zahlen |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=DecodePhone
phone=12123120960170061170799
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | {"phone":$decoded} | OK |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben |
set_call_lost#
Dieser Befehl ist erforderlich, um eine Telefonnummer als verpassten Anruf für CallBack festzulegen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall set_call_lost | string | obligatorisch |
| phone | Telefonnummer | string | Nur Zahlen erforderlich |
| ext | Mitarbeiter-Telefonnummer für Rückruf | string | Nur Zahlen erforderlich |
| time_plan | 1 - Arbeitszeit, 2 - Abend, 3 - Nacht, 4 - Wochenende | zahlen | Das Zeitintervall ist im Wochenplan definiert, standardmäßig 1 |
| max_try | Maximale Anzahl von Verbindungsversuchen zu einem Teilnehmer (ohne Netzbetreiber) | zahlen | Standard 3 |
| interval | Das anfängliche Intervall zwischen den Versuchen wird in Minuten angegeben und ist ein Vielfaches von 6. Das nachfolgende Intervall entspricht dem anfänglichen Intervall multipliziert mit der Versuchsnummer. | zahlen | Standardwert 6 |
| minutes | Anzahl der Minuten Verspätung | zahlen | Standardwert 0 |
| hours | Anzahl der Verspätungsstunden | zahlen | Standardwert 0 |
| days | Anzahl der Tage Verzögerung | zahlen | Standardwert 0 |
| weeks | Anzahl der Wochen Verzögerung | zahlen | Standardwert 0 |
| months | Anzahl der Monate Verzögerung | zahlen | Standardwert 0 |
| info | Text, der dem Mitarbeiter vorgelesen wird. Format: Sprache und Text. Beispiel: „UK-Rückrufservice für verpasste Anrufe, bitte warten Sie auf die Verbindung zum Teilnehmer.“ | string | |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | obligatorisch |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=set_call_lost
phone=12123120960
ext=222
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben | |
| 402 | Serverprobleme |
get_makecall_data#
Mit diesem Befehl können Sie Informationen über den Anruf mithilfe der ID id_makecall abrufen, die Sie mit dem Befehl makecall erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall get_makecall_data | string | obligatorisch |
| id_makecall | resultierend aus einem Anruf | string | Nur Zahlen erforderlich |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | obligatorisch |
Beispielabfrage:
POST https://api.lirax.net/general
cmd=get_makecall_data
id_makecall=e5251de22f99e071
token=202cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | { "id_makecall":"e5251de22f99e071", "call_start":"2021-10-28 16:02:32", "call_record":"https://files. lirax. net/voicerec. wav", "duration":"5" } | OK |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben | |
| 402 | Serverprobleme |
get_calls#
Der Befehl ermöglicht das Abrufen eines Anrufprotokolls im JSON-Format (maximal 5000 Einträge) für einen bestimmten Zeitraum. Sie können für den Befehl die GET-Methode verwenden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall get_calls | string | obligatorisch |
| date_start | Anfang der Reichweite | string | Im SQL-Format erforderlich |
| date_finish | Reichweitenende | string | Im SQL-Format erforderlich das Intervall sollte weniger als 48 Stunden betragen. |
| call_type | anruftyp, {-1, 0, 1}, in Übereinstimmung {intern, Eingabe, Ausgabe }, falls nicht vorhanden, dann alle | numerical | optional |
| ani | Wer hat angerufen? | string | optional |
| dnis | Wo haben sie angerufen? | string | optional |
| offset | Überspringen Sie die Anzahl der Zeilen in der Ausgabe | numerical | optional |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | obligatorisch |
Beispielabfrage:
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=-----Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 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 – wenn keine Antwort erfolgt, erscheint eine leere Zeile. record – url gesprächsaufzeichnung disconnect_side – Wer hat aufgelegt?, -1 System (möglicherweise aufgrund von Zeitüberschreitung), 0 – Wer hat angerufen?, 1 – Wer wurde angerufen? call_call_center_id – welches Callcenter hat den Anruf bearbeitet (falls vorhanden)? |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben | |
| 402 | Serverprobleme |
set_webhook#
Der Befehl ermöglicht das Abrufen eines Anrufprotokolls im JSON-Format (maximal 5000 Einträge) für einen bestimmten Zeitraum. Sie können für den Befehl die GET-Methode verwenden.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall set_webhook | string | obligatorisch |
| type | „0“ – Eingang, „1“ – Ausgang | numerical | obligatorisch |
| event_type | init - zu Beginn des Anrufs, Verbindungsaufbau – zu Beginn der ausgehenden Verbindung, Verbindung herstellen – wenn der Teilnehmer den Hörer abnimmt, Verbindung trennen – am Ende der ausgehenden Verbindung, Verbindung trennen – am Ende des Anrufs | string | obligatorisch |
| json | JSON-Vorlage für den Webhook-Body. Hier können Sie Makros verwenden: [ani] — anrufer, [dnis] — Angerufener, [date] — aktuelle Uhrzeit, [starto] — Beginn des eingehenden Anrufs, [starta] — Zeitpunkt, an dem der Teilnehmer den Hörer abnimmt, [durationo] — Dauer des eingehenden Anrufs, [durationa] — Dauer des ausgehenden Anrufs, [anidnis] — Betreibernummer für den eingehenden Anruf, [type] — Anruftyp: "-1" — intern, "0" — eingehend, "1" — ausgehend. Beispiel: {"call_type":"[type]", "event_date":"[date]", "number_a":"[ani]", "number_b":"[dnis]", "call_duration": "[durationa]"} | string | möglicherweise fehlt etwas; wenn die POST-Methode verwendet wird, wird der Anfragetext als Vorlage verwendet. |
| header_field | Ein zusätzliches Header-Feld, das LiraX in den Webhook einfügt. beispiel: Authorisation: 123123123 | string | optional |
| method | GET|POST | string | Optional standardmäßig GET |
| url | Url für Webhooks beispiel: https://test.test.test.com/webhook?a=1&b=2 | string | obligatorisch |
| token | liraX-Token in den Integrationseinstellungen festgelegt | string | obligatorisch |
Beispielabfrage:
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=-----Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | erfolgreich | |
| 400 | Falsche Parameter übergeben oder Parameter nicht aktualisiert | |
| 401 | Ungültiges Token übergeben | |
| 402 | Serverprobleme |
Anrufliste herunterladen#
Autorisierung über API
Autorisiert den Benutzer im System. Alle API-Methoden können erst nach der Autorisierung verwendet werden.
Als Antwort auf die Anfrage wird nach erfolgreicher Autorisierung neben dem Antworttext eine Cookie-Datei mit dem Sitzungsschlüssel zurückgegeben, ähnlich wie bei der Verwendung eines Webbrowsers. Bei nachfolgenden Anfragen an API-Methoden muss das empfangene Cookie übergeben werden. Die Sitzungsdauer beträgt 15 Minuten.
Alle API-Anfragen werden von dem Benutzer gestellt, dessen Attribute für die Autorisierung über diese Methode verwendet wurden. Dabei berücksichtigen wir alle Benutzerrechte, d. h. über die API können nicht mehr Daten abgerufen werden, als der Benutzer selbst über die Systemoberfläche einsehen kann. Wir empfehlen, für die API einen separaten Benutzer anzulegen, um die Rechte der verbundenen Anwendung spezifischer zu konfigurieren.
Resource URL
POST
https://lira. lirax. net/api/private/api/auth. php
Parameters
| PARAMETER | DESCRIPTION |
|---|---|
| USER_LOGIN | require Benutzeranmeldung. |
| USER_HASH | require Benutzerpasswort. |
Anrufe
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
Stammen aus
date_finish
Datum bis
filter
Nach Feld filtern
mögliche Werte:
"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
Filterwert
call_type
mögliche Werte:
0 eingehender Eingang, 1 ausgehender Ausgang
call_connect
mögliche Werte:
0 es gab kein Gespräch, 1 Es gab ein Gespräch
Teams von LiraX bis zur Startbahn#
makecall_finished#
Der Befehl meldet den Abschluss der Aufgabe, einen Anruf für 2 Teilnehmer zu erstellen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall makecall_finished | string | |
| id_makecall | Id - makecall | string | |
| Call_id | Call_id der ausgehende Arm des Anrufs | string | wenn Erfolg=0 leer |
| success | Der Abonnent nahm den Anruf entgegen. | Integer | 0|1 |
| from_LiraX_token | das in den Integrationseinstellungen angegebene WPP-Token | string |
Beispielabfrage:
POST https://domain/LiraX
cmd=makecall_finished
id_makecall=ef232234feb12
from_LiraX_token=303cb962ac59075b964b07152d234b70
Call_id=b964b07152d
success=1Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
make2calls_finished#
Der Befehl meldet den Abschluss der Aufgabe, einen Anruf für 2 Teilnehmer zu erstellen.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | die Art der Operation, in diesem Fall make2calls_finished | string | |
| id_make2calls | Id - make2calls | string | |
| success | Wurde der Anruf entgegengenommen? | Integer | 0- es war niemand da, 1- nahm den Anruf entgegen |
| duration_success | die Gesprächsdauer war nicht kürzer als im Erfolgszeitparameter erwartet. | Integer | 0- kleiner als, 1 - größer oder gleich |
| keys | Json liste der gedrückten Tasten, ivr_name – IVR-Name, ivr_entry – IVR-Menüpunkt, key – ausgewählte Taste | Json | kann abwesend sein |
| from_LiraX_token | das in den Integrationseinstellungen angegebene WPP-Token | string |
Beispielabfrage:
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=0Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
staton#
Das Team informiert über den Status der Mitarbeiter.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | art des Betriebs, in diesem Fall Station | string | |
| ext | liraX Mitarbeiter-Durchwahlnummer | string | |
| status | mitarbeiterstatus-Kennung im persönlichen Konto | Integer | 0- nicht verbunden, 1 – frei, >1 – belegt, Wert gemäß Einstellung |
| from_LiraX_token | das in den Integrationseinstellungen angegebene WPP-Token | string |
Beispielabfrage:
POST https://domain/LiraX
cmd=staton
ext=910
from_LiraX_token=303cb962ac59075b964b07152d234b70
status=1Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
smsDelivered#
Das Team informiert über die Zustellung der SMS.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall SMS zugestellt | string | |
| id_sms | Id SMS, empfangen vom sendSMS-Befehl | Integer | |
| from_LiraX_token | das in den Integrationseinstellungen angegebene WPP-Token | string |
Beispielabfrage:
POST https://domain/LiraX
cmd=smsDelivered
from_LiraX_token=303cb962ac59075b964b07152d234b70
id_sms=1212Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
smsReceived#
Das Team informiert über den Empfang einer SMS.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall SMS empfangen | string | |
| ani | Telefonnummer des Abonnenten | string | |
| id | Id SMS, vom Anbieter erhalten | Integer | |
| provider | Name des Anbieters (Telefonnummer) | string | |
| text | Nachrichtentext | string | In UTF8 |
| from_LiraX_token | das in den Integrationseinstellungen angegebene WPP-Token | string |
Beispielabfrage:
POST https://domain/LiraX
cmd=smsReceived
from_LiraX_token=303cb962ac59075b964b07152d234b70
id_sms=121
ani=38012345679
provider=380112345678
text=HelloAntwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | Falsche Parameter übergeben | |
| 401 | Ungültiges Token übergeben |
contact#
Ein Befehl, um anhand der Telefonnummer Informationen über den Namen des Kunden und den zuständigen Mitarbeiter zu erhalten.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | art der Operation, in diesem Fall Kontakt | string | |
| phone | kontaktnummer | string | |
| callid | eindeutige Anrufer-ID | string | |
| diversion | externe LiraX-Telefonnummer, von der der Anruf empfangen wurde | string | wenn die ausgehende Anzahl der Abonnentennummer entspricht |
| from_LiraX_token | das in den Integrationseinstellungen angegebene WPP-Token | string |
Beispielabfrage:
POST https://domain/LiraX
cmd=contact
phone=19101234567
diversion=12101234567
from_LiraX_token=303cb962ac59075b964b07152d234b70
callid=D12D0EB124F4E64AF4EA-1511Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | { "contact_name": "Ivanov Ivan Ivanovich", "verantwortlich": 103 } | responsible — kurzwahlnummer des verantwortlichen Benutzers; kann fehlen, wenn kein verantwortlicher Benutzer vorhanden ist oder keine Kurzwahlnummer für ihn/sie festgelegt wurde. |
| 400 | { "error": "Invalid parameters" } | Falsche Parameter übergeben |
| 401 | { "error": "Invalid token" } | Ungültiges Token übergeben |
event#
LiraX sendet Benachrichtigungen an WPP über Anrufereignisse: Starten, Annehmen oder Beenden eines Anrufs sowie Informationen über den Anruf nach dessen Beendigung.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | art der Operation, in diesem Fall Ereignis | string | |
| type | anruftyp | in/out | eingehende / ausgehende |
| event | art des mit dem Anruf verbundenen Ereignisses: INCOMING - es ist ein Anruf eingegangen (in diesem Moment sollte das Telefon des Managers klingeln). ACCEPTED - der Anruf wurde erfolgreich entgegengenommen (der Manager nahm den Anruf entgegen). COMPLETED - das Gespräch ist beendet (der Manager oder Kunde hat nach dem Gespräch aufgelegt). CALL_COMPLETED – das Gespräch ist vollständig beendet. | string | |
| phone | telefonnummer des Kunden | string | |
| diversion | externe LiraX-Telefonnummer, über die der Anruf empfangen oder getätigt wurde | string | |
| ext | durchwahlnummer eines LiraX-Mitarbeiters im Fall von CALL_COMPLETED und type=in enthält es die Nummer, an die der Anruf kam | string | |
| callid | eindeutige Anrufer-ID | string | |
| duration | Anrufdauer in Sekunden | int | wenn Ereignis=ABGESCHLOSSEN, CALL_COMPLETED |
| call_duration | Anrufdauer zum Zeitpunkt des Ereignisses in Sekunden | int | wenn Ereignis=ABGESCHLOSSEN, CALL_COMPLETED |
| is_recorded | wird das Gespräch aufgezeichnet? | 0/1 | wenn Ereignis=ABGESCHLOSSEN, CALL_COMPLETED |
| status | status eingehender Anrufe: Success - erfolgreicher eingehender Anruf Missed – verpasster eingehender Anruf status ausgehender Anrufe: Success - erfolgreicher ausgehender Anruf Busy - LiraX ich habe die Antwort von Zanyato erhalten. NotAvailable - LiraX antwort erhalten: Abonnent nicht verfügbar NotAllowed - Anrufe in diese Richtung sind verboten. | string | wenn Ereignis=ABGESCHLOSSEN, CALL_COMPLETED |
| record_link | link zur Anrufaufzeichnung, falls LiraX diesen sofort bereitstellen kann; andernfalls wird der Link über den Befehl „record“ gesendet. | string | wenn Ereignis=ABGESCHLOSSEN, CALL_COMPLETED |
| tid | Tracking Id | ||
| cid | Client Id | ||
| cs | Quelle | ||
| cm | Medium | ||
| cc | Kampagne | ||
| ct | Therm | ||
| keys | IVR-Menü mit letzter Auswahl | json | wenn Ereignis = CALL_COMPLETED |
| From_LiraX_token | das in den Integrationseinstellungen angegebene WPP-Token | string |
Beispielabfrage:
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=303cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | { "error": "Invalid parameters" } | Falsche Parameter übergeben |
| 401 | { "error": "Invalid token" } | Ungültiges Token übergeben |
record#
Die Nachricht enthält Informationen über die Gesprächsaufzeichnung.
Abfrageparameter:
| Name | Beschreibung | Datentyp/Format | Notiz |
|---|---|---|---|
| cmd | operationstyp, in diesem Fall Datensatz | string | |
| callid | eindeutige Anrufer-ID | string | |
| record_link | link zur Anrufaufzeichnung | string | |
| from_LiraX_token | das in den Integrationseinstellungen angegebene WPP-Token | string |
Beispielabfrage:
POST https://domain/LiraX
cmd=record
callid=D10D0EB124F4E64AF4EA01511
record_link=https://link/file.wav
from_LiraX_token=303cb962ac59075b964b07152d234b70Antwortmöglichkeiten:
| HTTP code | Körper | Beschreibung |
|---|---|---|
| 200 | OK | |
| 400 | { "error": "Invalid parameters" } | Falsche Parameter übergeben |
| 401 | { "error": "Invalid token" } | Ungültiges Token übergeben |
ChangeLog#
2021-01-28
make2calls- das Feld „FirstInternal“ wurde hinzugefügt.2021-02-18
getContact- methode hinzugefügt2021-02-19
getStatInfo- methode hinzugefügt2021-04-12
AskQuestion- methode hinzugefügt2021-04-13
AddTag- methode hinzugefügt2021-04-13
DelTag- methode hinzugefügt2021-04-14
checkContact — tag-Feld hinzugefügt2021-08-13
get_sip_route_in — methode hinzugefügt2021-08-13
set_sip_route_in — methode hinzugefügt2021-09-12
SecondInternal in der Funktion make2calls2021-09-12
SpeechNoWait in der Funktion make2calls2021-10-26
set_call_lost- methode hinzugefügt2021-10-28
get_makecall_data - methode hinzugefügt2021-11-19
set_call_lost - hinzugefügte Informationen, Minuten, Stunden, Tage, Wochen, Monate Felder2021-12-30
createTask — e-Mail-Parameter hinzugefügt; falls der Kontakt nicht existiert, wird ein neuer erstellt.2022-08-25
Event — parameter call_duration hinzugefügt2022-11-10
send_cloud_message - methode hinzugefügt2023-10-04
get_calls- methode hinzugefügt2023-10-20
AddTaskResult- methode hinzugefügt2024-09-24
GetTask- methode hinzugefügt2026-09-16
Die Domain api.lirax.net wird verwendet