Obecný popis
Webhook
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
- URL - adresa webového serveru
- login/heslo - přihlašovací údaje pro http basic authentication
Formát zpráv
formát JSON
- 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
- Reason - důvod ukončení hovoru
EventName
- Ringing - vyzvánění hovoru
- Answered - zvednutí hovoru
- Hangup - položení hovoru
- AgentLogin, AgentLogout,AgentPaused,AgentUnPaused - informace o stavech agenta v Call Centru
{ EventName: Ringing, From: 777888999, To: 222333444, Line: 444, Email: petr.novak@jehofirma.cz, Login: petr.novak, UniqueId: 1412256225.1941 }
Schéma
Další příklady
Přihlášení agenta
{ "EventName":"AgentLogin", "Queue":"NOC", "Login":"janecek", "Line":"163", "Email":"nejaky@email.cz" }
Odhlášení agenta
{ "EventName":"AgentLogout", "Queue":"NOC", "Login":"janecek", "Line":"163", "Email":"nejaky@email.cz" }
Pauza agenta
{ "EventName":"AgentPaused", "Queue":"NOC", "Login":"janecek", "Line":"163", "Email":"nejaky@email.cz", "PauseName":"Oběd" }
Odpauzování agenta
{ "EventName":"AgentUnPaused", "Queue":"NOC", "Login":"janecek", "Line":"163", "Email":"nejaky@email.cz" }
Zmeškaný hovor
Další událostí, kterou platforma posílá je informace o hovoru, který nezvedla žádná "živá" osoba. Takový hovor je evidován jako "nevyřízený".
V události přibyl parametr "Reason", který obsahuje text "No user response" v případě, že hovor je nevyřízený.
{ "EventName": "Hangup", "From": "777888999", "To": "222333444", "Line": "", "Email": "", "Login": "", "UniqueId": "1412256225.1941", "Reason": "No user response" }
Odchozí hovory
Informace o odchozích hovorech.
Informace o směru hovoru je obsažena v parametru "Direction". Může nabývat hodnot
- incoming - příchozí hovor
- outgoing - odchozí hovor
- incomingLocal - příchozí v rámci ústředny
- outgoingLocal - odchozí v rámci ústředny
{ "EventName": "Ringing", "From": "777888999", "To": "222333444", "Line": "20", "Email": "", "Login": "", "UniqueId": "1412256225.1941", "Direction": "incoming" }
{ "EventName": "Hangup", "From": "777888999", "To": "222333444", "Line": "20", "Email": "", "Login": "cervenka", "UniqueId": "1412256225.1941", "Direction": "incoming", "Reason": "No user response" }
Examples
V níže uvedeném repozitáři naleznete příklady jak funkci implementovat. Dostupné jsou příklady pro jazyky PHP 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