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šší.

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.

Image Added

Image Added

V platformě jsou definovány parametry systému kam události posílat

URL

...

adresa webového serveru

Události

• 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.

Autentizace

• Basic - login/heslo - přihlašovací údaje pro http basic authentication

Image Removed

Formát zpráv

formát JSON

• .

• 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.

Tělo zprávy

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

  hovoru  [incoming, outgoing, incomingLocal, outgoingLocal, barge]

• Reason - důvod ukončení hovoru

...

• StartTime

EventName

• Ringing - vyzvánění hovoru
• Answered - zvednutí hovoru
• Hangup - položení hovoru
• AgentLogin, AgentLogout,AgentPaused,AgentUnPaused - informace o stavech agenta v Call Centru

...

...

• Duration

• EndTime

• AnsweredTime

• Abandoned

• Content

• Schema

Filtrovat událost

Nastavení pro odfiltrování nežádoucích událostí

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

...

Příklady

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/

...

  git clone https://bitbucket.org/ipex/examples.git

...