Call log API

Soluțiile PBX bazate pe cloud și locale pot transmite istoricul apelurilor către MiniCRM pentru a reduce necesitatea înregistrării manuale a datelor în CRM.
Înregistrările istorice pot fi trimise după fiecare apel efectuat / primit / ratat sau în loturi, la intervale de timp stabilite.

API Endpoint

Înainte de a trimite cereri către acest punct final, ar trebui să furnizați adresa IP pentru listarea albă

  • Metoda HTTP: POST
  • Date de intrare codificate în format JSON:

– ApiKey: cheie API Call-Log, utilizatorii pot genera chei în MiniCRM / Setări / Sistem. Este o cheie separată de cheia API „generică” MiniCRM, care nu funcționează cu API-ul Call-Log.

– UserExtension: numărul de telefon intern al utilizatorului care a inițiat / primit apelul. Numerele interne ale utilizatorului pot fi setate în MiniCRM / Profile. Dacă PBX nu folosește numere interne, numărul complet de telefon al utilizatorului poate fi trimis în acest câmp.

– Date: matrice de articole istorice, fiecare constând din:

Număr (șir): numărul de telefon al celeilalte părți din apel
Durata (int): durata apelului în secunde
CallType (int):
0: Ieșire
1: Primite
2: Pierdută

– Data (șir, datetime): data și ora în care a început apelul trebuie să utilizeze fusul orar UTC

– ReferenceId (șir) [opțional]:

Identificator unic al apelului înregistrat, dacă apelul a fost înregistrat.
MiniCRM poate descărca și reda înregistrări mp3. Pentru aceasta, trebuie să furnizați un punct final sigur precum https: // user: pass@your.domain.com/record? Rec = {% RefereceId%}.
Acest punct final trebuie să poată fi accesat de pe adresele noastre IP: 195.228.75.210, 195.228.75.211

Răspuns

Dacă totul a mers bine, API-ul răspunde cu codul de răspuns HTTP 200 / OK. În caz de erori, codurile HTTP 4XX sau HTTP 5XX sunt trimise împreună cu descrierea erorii.
Conținutul de răspuns este un obiect codificat JSON cu statistici rezumative ale înregistrărilor istorice procesate:
  • Omis: numărul de înregistrări în care cel puțin unul dintre parametri lipsea.
  • NotFound: numărul de înregistrări în care nu a fost găsit numărul de telefon al celeilalte părți.
  • Procesat: procesare reușită, înregistrări istorice salvate în MiniCRM.

Request Exemplu #1

 

$ curl -v -X POST https://r3.minicrm.hu/Api/CallLog -d ‘{„ApiKey”:”PWrhIE2fmpGUq7ZYTLSuCeb1azViF0kQ”,”UserExtension”:”001″,”Data”:{„Date”:”2016-03-02 16:00:12″, „Number”:”0620123456″, „CallType”:”2″, „Duration”:”132″, „ReferenceId”:”UniqueReferenceId”}}’

Răspuns exemplu #1

{„Skipped”:0,”Processed”:1,”Exists”:0}

Request Exemplu #2

Prima înregistrare conține erori, a doua este dintr-un număr necunoscut, iar al treilea element poate fi salvat.

 

$ curl -v -X POST https://r3.minicrm.hu/Api/CallLog -d ‘{„ApiKey”:”PWrhIE2fmpGUq7ZYTLSuCeb1azViF0kQ”,”UserExtension”:”001″,”Data”:[{„Date”:”2016-aíYA03-02 16:00:12″, „CallType”:”2″, „Duration”:”132″, „ReferenceId”:”UniqueReferenceId”},{„Date”:”2016-03-02 16:00:12″, „Number”:”0620123456″, „CallType”:”2″, „Duration”:”132″, „ReferenceId”:”UniqueReferenceId”},{„Date”:”2016-03-03 12:12:12″, „Number”:”0620123456″, „CallType”:”2″, „Duration”:”132″, „ReferenceId”:”UniqueReferenceId”}]}’

 

Răspuns exemplu #2

 

{„Skipped”:1,”Processed”:1,”Exists”:1}

 

Ascultarea apelurilor în MiniCRM

Dacă ReferenceId este trimis împreună cu apelurile, este posibil să ascultați apelurile în MiniCRM. Fără ReferenceId, numai metadatele apelului apar în istoricul foilor de date. O funcție opțională plus este redarea apelului înregistrat (dacă există). Sunt două lucruri de făcut. Orice apel înregistrat trebuie să trimită un ID unic în câmpul „ReferenceId”.

Apoi, trimiteți șablonul URL de recuperare la suport@minicrm.ro. Ar trebui să fie un șablon pe care îl folosim pentru a genera adresa URL de la care MiniCRM poate descărca fișierul audio înregistrat.

Exemplu de URL: https://your.domain.com/recordings.php?Rec={%RefereceId%}

HTTPS – comunicați pe un canal securizat, apelurile înregistrate sunt date sensibile.
Your.domain.com este serverul utilizat de furnizorul de servicii VoIP pentru a stoca înregistrări.

Vom descărca fișierele de pe adresele IP 195.228.75.210, 195.228.75.211. Este recomandat să introduceți o restricție IP la punctul final pentru a vă asigura că numai aceste adrese IP le pot accesa