Trimitere Events (WebHook)¶
Webservice-ul va fi apelat de While1 Voice la evenimentele de mai jos, pe URL-ul setat in Editare proiect, campul Send Event API URL (webhook). Se pot seta mai multe URL-uri, separate prin ||. Raspunsul webservice-ului trebuie sa aiba header 200 (sau 201); continutul nu este verificat.
Events se trimit doar daca proiectul este conectat prin API (Caller Info API) cu un tip care suporta webhook: Generic, iStoma sau Soap.
Se trimit events pentru urmatoarele tipuri de actiuni:- Answer Events (queue_answer, queue_answer_end, dial_answer, call_forward_answer)
- Apeluri Outgoing (dialout_answer, outgoing_end)
- Missed Calls (missed_calls)
Metoda GET sau POST¶
- GET (implicit): parametrii sunt adaugati in URL, ca in exemplele de mai jos. Cu parametrul API event_prefix (ex: event_prefix=ctk_) se adauga un prefix la toti parametrii (ex: ctk_event, ctk_telephone).
- POST: datele se trimit ca form-data (application/x-www-form-urlencoded), cu cheile event_type (tipul event-ului) si event_data (array cu aceiasi parametri ca la GET, fara event). Daca este activat parametrul Include raw data with Send Event (webhook) (Settings :: Parameters, grupul AGI), event_data contine si raw_data (toate datele apelului), iar in plus se trimit si events de tip external_calls, recording_consent, send_recording, custom_email, fax_tx.
1. Answer Events¶
Exemplu URL:
http://example.com/api/while1voice_ev?event=queue_answer&direction=IN&project_id=1&agent=test-user&remote_number=&telephone=0700000000&dnid=0300000000&dnid_identifier=&contact_id=&queue=callcenter-queue&uniqueid=1234567890.12Parametri trimisi (metoda GET):
- event => poate fi: queue_answer (raspuns in coada), queue_answer_end (final apel raspuns in coada), dial_answer (raspuns la apel direct catre user) sau call_forward_answer (raspuns la apel redirectionat)
- direction => IN
- project_id => identificatorul extern al proiectului
- agent => user-ul care a raspuns
- remote_number => numarul de mobil extern care a raspuns apelului (fallback_number sau remote_agent)
- telephone => numarul apelantului
- dnid => numarul la care s-a sunat
- dnid_identifier => PBX :: Inbound routes :: Edit route - External identifier
- contact_id => ID-ul furnizat din Webservice-ul de recunoastere apelant
- queue => numele cozii apelate
- uniqueid => ID-ul unic de apel
2. Missed calls¶
Exemplu URL:
http://example.com/api/while1voice_ev?event=missed_calls&project_id=123&queue=test-queue&queue_hold_time=1&telephone=0700000000&dnid=0210000000&dnid_identifier=&contact_id=123456&fail_reason=queue_hangup&explain_reason=&uniqueid=1234567890.12Parametri trimisi (metoda GET):
- event => poate fi: missed_calls
- project_id => identificatorul extern al proiectului
- queue => numele cozii
- queue_hold_time => timpul de asteptare in coada, in secunde
- telephone => numarul apelantului
- dnid => numarul la care s-a sunat
- dnid_identifier => PBX :: Inbound routes :: Edit route - External identifier
- contact_id => ID-ul furnizat din Webservice-ul de recunoastere apelant
- dnid_description => descrierea numarului din Inbound route
- ivr_menu_id => ID-ul meniului IVR, daca apelul a trecut printr-un IVR
- fail_reason => motivul pentru apelul ratat (ex: queue_hangup, forward_hangup, no_schedule, queue_busy)
- explain_reason => explicatia pentru fail_reason (statusul cozii sau al apelului)
- uniqueid => ID-ul unic de apel
3. Outgoing calls¶
Exemplu URL:
http://example.com/api/while1voice_ev?event=outgoing_end&direction=OUT&project_id=123&agent=test-user&telephone=0700000000&dnid=0210000000&dnid_identifier=&contact_id=123456&dialstatus=BUSY&external_id=ticket-123&external_info=CRM+Call&duration=8&uniqueid=1234567890.12Parametri trimisi (metoda GET):
- event => poate fi: dialout_answer (raspuns la apelul outbound) sau outgoing_end (final apel outbound)
- direction => OUT
- project_id => identificatorul extern al proiectului
- agent => userul care a apelat
- telephone => numarul apelatului
- dnid => numarul de la care s-a sunat
- dnid_identifier => PBX :: Inbound routes :: Edit route - External identifier
- contact_id => ID-ul furnizat din Webservice-ul de recunoastere a apelatului
- dialstatus => statusul apelului (ex: ANSWER, BUSY, NOANSWER, CANCEL, CONGESTION); doar la outgoing_end
- external_id => ID-ul extern trimis la API - OriginateCall, din Call Queue sau intors de Webservice-ul de recunoastere apelant; gol daca nu exista
- external_info => informatia externa trimisa la API - OriginateCall (ex: tipul inregistrarii din CRM); la apelurile pornite din While1 Voice poate fi crm sau dialer; gol daca nu exista
- duration => durata apelului in secunde (durata convorbirii daca s-a raspuns, altfel durata apelarii); doar la outgoing_end
- uniqueid => ID-ul unic de apel
Disponibil si in alte limbi: EN