Rozhraní pro ústředny verze 3.x a do 4.5.x je popsáno v PDF. (VD-29687955-040920-1212.pdf)
Další text je vázán na rozhraní ústředny od verze 4.6.x a vyšší.
Detailní popisy jednotlivých integrací - Integrace s ERP/CRM systémy
SOAP
POZOR: Podpora protokolu SOAP bude ukončena k 1.7.2017. Funkce budou dostupné v rámci REST API
On-line výpis událostí SOAP serveru včetně možnosti získání historických záznamů o provozu.
V logu jsou dostupné diagnostické údaje k SOAP serveru.
Zapnutím podrobnějšího logování v záložce nastavení je možné logovat např. obsah proměnných atd.
Toto nastavení nedoporučujeme používát pro produkční režim.
Obecné informace k SOAPu jsou dostupné na adrese
http://www.ipex.cz/ustredny-a-telefony/ipbx/erp-crm-integrace/soap-rozhrani#soap-funkce
Webhook
Detailní popis - Server side integration (Webhooks)
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
Přihlašovací jméno a heslo - přihlašovací údaje pro http basic authentication
FORMÁT ZPRÁV
formát JSON
EventName - nazev 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
EventName
Ringing - vyzvánění hovoru
Answered - zvednutí hovoru
Hangup - položení hovoru
Příklad
{ EventName: Ringing, From: 777888999, To: 222333444, Line: 444, Email: petr.novak@jehofirma.cz, Login: petr.novak, UniqueId: 1412256225.1941 } |
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
REST
Dokumentace REST API je dostupná ve službě apiary.io na adrese http://docs.ipbx.apiary.io/