Extragere informatii apelant via Webservice¶
Webservice (REST API) care va fi apelat de While1 Voice, pe GET, pe un URL de tipul:
https://example.com/api/while1voice?phone=[PHONE]&dnid=[DNID]&token=some_secret_token
URL-ul se seteaza pe fiecare proiect (API URL). Placeholder-ele [PHONE] si [DNID] sunt inlocuite la apel (se poate folosi si %s in loc de [PHONE]). Daca URL-ul nu are parametri, se adauga automat ?phone=[PHONE]&dnid=[DNID].
Parametri transmisi pe GET:- phone => numarul de telefon al clientului (Caller ID)
- dnid => numarul de telefon pe care a sunat clientul; la apelurile outbound (ctk_action=outgoing), caller ID-ul apelantului (agent / linie)
- ctk_action => tipul cererii: incoming, incoming_no_schedule, outgoing, missed, answer
- ctk_uniqueid => ID-ul unic al apelului
- ctk_pin => PIN-ul introdus de client, daca exista
- ctk_dnid_identifier => identificatorul rutei Inbound, daca exista
- ctk_agent_username, ctk_agent_remote_id => agentul, daca e cunoscut (ex: la answer)
- ctk_external_id, ctk_external_info => valorile external_id si external_info trimise la API - OriginateCall, doar la ctk_action=outgoing (pentru a lega apelul de o inregistrare din CRM, ex: un ticket), daca exista
Timeout-ul cererii este de 3 secunde.
Ne veti raspunde cu HTTP 200 si JSON cu urmatoarele date (cheile id sau name sunt obligatorii, alte chei sunt ignorate):- id => id-ul intern al clientului
- name => nume, prenume
- backend_link => link pt popup la incoming call answer, incepand cu http(s)://
- direct_line => folosit la apelurile Inbound pentru transfer direct catre operator sau coada (ex: SIP/ion-popescu, Local/ion-popescu sau sales-queue), optional
- queue_position => pozitia in coada, numeric / NULL, optional
- route_identifier => numarul sau identificatorul (Identifier) unei rute din Inbound routes; la apelurile outbound se foloseste numarul de Outbound al acelei rute, optional
- outbound_number => numarul cu care se iese la apelurile outbound; trebuie sa fie din plaja furnizorului, optional
- language => limba canalului pentru mesajele audio (ex: ro, en), optional
- external_id => ID extern, salvat in CDR (external_id), optional
Daca clientul nu este gasit, raspundeti cu HTTP 204 (fara continut). Orice alt raspuns este considerat eroare, iar cautarea se face in Contactele din While1 Voice. Raspunsurile sunt pastrate in cache conform setarii AGI cache for getCallerInfo (hours) (implicit 24 ore, 0 = dezactivat).
Exemplu extragere informatii apelant din aplicatia proprie:
$contact_info = $db->get_row("SELECT * FROM contacts WHERE telephone = '" . $db->escape($_GET['phone']) . "'");
Exemplu trimitere informatii:
$result = array(
'id' => 12345,
'name' => 'John Doe',
'queue_position' => null,
'direct_line' => null,
'backend_link' => 'https://your-crm.com/example-popup?id=12345',
'route_identifier' => null,
'outbound_number' => null,
'language' => null,
'external_id' => null
);
header('Content-Type: application/json');
echo json_encode($result);
Exemplu raspuns contact gasit json:
{
"id": 12345,
"name": "John Doe",
"queue_position": null,
"direct_line": null,
"backend_link": "https://your-crm.com/example-popup?id=12345",
"route_identifier": null,
"outbound_number": null,
"language": null,
"external_id": null
}
Daca clientul nu este gasit, raspundeti cu HTTP 204 (fara continut). Un JSON cu id / name null este tratat ca un client gasit, cu date goale.
Conectarea la URL se va face de la IP-ul dedicat centralei dvs. Atentie: trebuie sa securizati accesul la acel URL prin restrictie pe IP sau token acces.
Pentru a face posibila transmiterea fisei de client extrase via Webservice catre agentul care raspunde apelului, continuati cu pasii descrisi la punctul 2 din sectiunea Pop-up fisa client.
URL-ul va fi pe fiecare proiect in parte (API URL), iar parametri pentru fiecare tip de API conform datelor de mai jos (sectiunea Help din pagina proiectului)
Api params usage: Generic: type=json&bearer_token=YOUR-TOKEN&root_tag=&send_request_headers=0&ignore_response=0&event_prefix=ctk_ Freshdesk: domain=&api_key= Gomag: ApiShop=&ApiKey= Hubspot: portalId=&token=&search_prefix=+4&add_country_code=1 Kommo: vendor=kommo.com&subdomain=&secret_key=&integration_id= (sau token=) iStoma: domain=yourclinic.istomadmain.ro&key=yourkey MedSoft: client_path=&api_key= MiniCRM: SystemId=&APIKey=&APIKeyVoip= MondayCRM: domain=&token=&boards_id=&column_id=&create_contact=1 Pipedrive: domain=&user=&token=&default_owner_id=&default_activity_id=1&create_activity=1&create_lead=1&create_deal=1&update_deal=1&send_call_skip_person_id=0 PrestaShop: domain=&key=&screenpop_uri=screenpop.php Soap: func_name=getCallerInfo&init_params[login]=asdf&init_params[password]=1234&func_params[do_something]=true Ticketsys: - Vaunt: uuid=&token= WooCommerce: domain=&consumer_key=&consumer_secret=&search_key=billing_phone
Disponibil in alte limbi: EN