Rozhraní pro ústředny verze 3.x a do 4.5.x je popsáno v PDF.
Další text je vázán na rozhraní ústředny od verze 4.6.x a vyšší.
Tato integrace s platformou VOIPEX umožňuje získávat informace o událostech formou přijímání HTTP POST komunikace.
V platformě jsou definovány parametry systému kam události posílat
adresa webového serveru
NewCall - inicializace příchozího/odchozího hovoru
Ringing - vyzvánění hovoru
Answered - zvednutí hovoru
Hangup - ukončení hovoru
AttendedTransfer - dokončení přepojení s konzultací
AgentLogin - přihlášení operátora do Call Centra
AgentLogout - odhlášení operátora do Call Centra
AgentPaused - pauza operátora
AgentUnPaused - zrušení pauzy operátora
CDR - dokončení zpracování a uložení záznamu hovoru do DB
Podrobnější příklady jsou zde
Přepis zdrojového čísla a cílového čísla:
Vybrané přepisy, které obsahují definice pravidel pro úpravy identifikace volajícího či volaného. Více zde v sekci Přepisy.
Basic - login/heslo - přihlašovací údaje pro http basic authentication.
Bearer - moznost získat bearer token pomocí requestu na zadanou url adresu s uvedenými hlavičkami. Data se posílají jako body requestu. Odpověď musí být ve formátu JSON. Klíč určuje název parametru v odpovědi, ve kterém je uložen bearer token.
Možnost použití výchozích klíčů nebo vlastních (přejmenování výchozích)
Výchozí klíče:
EventName - název události (Ringing,Answered,Hangup,...)
From - číslo volajícího
To - číslo volaného
Line - číslo zkrácené provolby
Email - email volaného(pokud je dostupný)
Login - login volaného(pokud je dostupný)
UniqueId - id hovoru
Queue - název fronty
Direction - směr hovoru [incoming, outgoing, incomingLocal, outgoingLocal, barge]
Reason - důvod ukončení hovoru
StartTime
Duration
EndTime
AnsweredTime
Abandoned
Content
Schema
Nastavení pro odfiltrování nežádoucích událostí
V níže uvedeném repositáři naleznete příklady jak funkci implementovat. Dostupné jsou příklady pro jazyky PHP, Node.js a C# (.NET).
https://bitbucket.org/ipex/examples/src/master/Server-side-integration/
V linuxu je možné příklady stáhnout např. takto
git clone https://bitbucket.org/ipex/examples.git