Webhook-ul Detailed Call Records oferă o soluție sigură, scalabilă și robustă, bazată pe evenimente, nu pe solicitări. Acest webhook oferă o vizibilitate sporită asupra activităților Webex Calling ale clienților dvs., oferind suport pentru diverse cazuri de utilizare, de la facturare la raportare personalizată.

Puteți utiliza acest webhook pentru a colecta înregistrări în mod convenabil pentru toți clienții gestionați prin intermediul Partner Hub, fără a interoga fiecare client în parte. Acest webhook vă permite să dezvoltați aplicații personalizate de raportare, facturare și analiză, atât pentru cerințele interne ale afacerii, cât și pentru serviciile cu valoare adăugată.

Pentru o introducere în webhook și API-urile sale aferente, urmăriți acest videoclip: API-ul Istoricului Apelurilor Detaliat al Partenerilor de Apel Webex.

Ce oferă webhook-ul Partner

Webhook-ul oferă înregistrări detaliate ale istoricului apelurilor la fiecare 5 minute. Fiecare payload webhook conține:

• Înregistrări ale apelurilor care s-au încheiat cu 10 minute și 5 minute înainte de ora curentă.
• Orice înregistrări întârziate procesate de cloud-ul Webex Calling.
• Completează automat înregistrările apelurilor întârziate în sarcinile webhook ulterioare pentru a asigura o livrare fiabilă.

Pentru a arăta cum sunt incluse înregistrările apelurilor în fiecare sarcină utilă, luați în considerare următorul exemplu:

• O sarcină utilă primită la 14:05 conține apeluri care s-au încheiat între 13:55 şi 14:00.
• Apelurile care se termină între 14:00 şi 14:05 sunt incluse în 14:10 încărcătură utilă.
• Înregistrări finalizate anterior (de exemplu, un apel care s-a încheiat la 14:04) dar procesat târziu de Webex Calling Cloud (de exemplu, la 14:11) sunt incluse în următoarea sarcină utilă programată (de exemplu, 14:15).

Webhook în Partener Hub

Prin furnizarea unui webhook, activați platforma de analiză să trimită înregistrări de apeluri către adresa URL de apel invers de fiecare dată când acestea sunt generate.

Înregistrările de apeluri Webex sunt livrate folosind același format ca și API-urile Detailed Call Recordsexistente. Puteți configura un webhook și puteți alege între două tipuri de feed-uri:

• Analiză – Include toate înregistrările de apeluri pentru toate organizațiile clienților cu care partenerul are o relație Webex Calling. Aceasta include organizații în care:
  • Partenerul gestionează organizația clientului cu rolul de Administrator complet partener.
  • Organizația client are un abonament Webex Calling activ în cadrul organizației partenere.
• Facturare – Include înregistrări ale apelurilor efectuate de utilizatori cu o licență Webex Calling vândută și furnizată de partener. Înregistrările apelurilor pentru Spațiile de lucru sunt incluse în acest flux.

Accesul și confidențialitatea datelor

Doar partenerul proprietar poate accesa înregistrările cu detalii despre apeluri (CDR) pentru facturare.

• Un partener (sau subpartener) care gestionează licența asociată cu înregistrarea apelului devine partenerul proprietar.
• Proprietatea este determinată de: ID-ul de utilizator > ID-ul licenței > ID-ul abonamentului > ID-ul partenerului.
• Fiecare CDR este accesibil unui singur partener.
• Unele înregistrări de apeluri nu sunt asociate cu un partener de facturare și nu toți partenerii asociați cu o organizație primesc acces egal la toate înregistrările, deoarece aceste înregistrări pot conține informații de identificare personală (PII).

Pe lângă webhook, Webex Calling oferă endpoint-uri API pentru a sprijini reconcilierea datelor. Aceste puncte finale vă permit să recuperați sau să reconciliați depozitele de date cu orice înregistrări lipsă pe care ascultătorul webhook-ului dvs. s-ar putea să nu le fi primit. Cele două puncte finale API sunt Reconciliation API și Records API.

Înregistrările din aceste API-uri sunt disponibile timp de 30 de zile. Pentru a vă asigura că primiți toate înregistrările așteptate, vă recomandăm să reconciliați periodic magazinele de discuri, cum ar fi la fiecare 12 sau 24 de ore.

Trebuie să utilizați un token de acces al partenerului pentru a accesa aceste API-uri. Obțineți și gestionați tokenul de acces al partenerului conform practicilor standard de gestionare a tokenurilor de acces pentru dezvoltatori Webex.

Punct final API de reconciliere

Punctul final al API-ului de reconciliere returnează numărul total de înregistrări de apeluri generate pentru fiecare client gestionat de partener în perioada de timp specificată. Puteți utiliza aceste totaluri pentru a verifica spațiul de stocare local și pentru a identifica orice înregistrări de apeluri lipsă sau inconsistente pentru anumiți clienți.

Dacă gestionați peste 200 de organizații clienți, API-ul paginază rezultatele pentru a îmbunătăți lizibilitatea.

Adresa URL a punctului final al API-ului de reconciliere utilizează următorul format:

Parametri API

Puteți utiliza API-ul pentru a recupera înregistrările apelurilor din ultimele 30 de zile. Fereastra de timp selectată trebuie să înceapă cu cel puțin 5 minute înainte de ora UTC curentă și nu poate depăși 12 ore între orele de început și de sfârșit într-un singur apel API.

Parametrii API sunt:

• startTime (obligatoriu, șir de caractere) - Data și ora de începere (UTC) pentru prima înregistrare pe care doriți să o colectați. Asigurați-vă că:
  • Formatezi ora ca YYYY-MM-DDTHH:MM:SS.mmmZ. De exemplu, 2025-08-15T06:00:00.000Z.
  • Data și ora de începere nu trebuie să fie mai vechi de 30 de zile față de ora UTC curentă.
  • Intervalul dintre startTime și endTime nu poate depăși 12 ore.
• endTime (obligatoriu, șir de caractere) - Data și ora de încheiere (UTC) pentru înregistrările pe care doriți să le colectați. Înregistrările se bazează pe ora raportării, adică momentul în care apelul este finalizat. Asigurați-vă că:
  • Formatezi ora ca YYYY-MM-DDTHH:MM:SS.mmmZ. De exemplu, 2025-08-15T18:00:00.000Z.
  • Data și ora de încheiere trebuie să fie cu 5 minute înainte de ora UTC curentă și să nu fie mai vechi de 30 de zile.
  • Data și ora de încheiere trebuie să fie mai mari decât startTime.
  • Intervalul dintre startTime și endTime nu poate depăși 12 ore.

Exemplu de răspuns JSON la un punct final al API-ului de reconciliere:

          {
          "cdr_counts": [
          {
          "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 3009
          },
          {
          "orgId": "yyyyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 129
          },
          {
          "orgId": "xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 27895
          }
          ]
          }          
        

Anteturile de răspuns API indică numărul total de organizații returnate și dacă sunt disponibile pagini suplimentare. Verificați următorii parametri de antet pentru a vă asigura că ați interogat toate paginile:

• număr-pagini: Numărul total de pagini (de exemplu, 2)
• organizații-totale: Numărul total de organizații incluse în răspuns (de exemplu, 283)
• pagina curentă: Numărul paginii curente (de exemplu, 1)

De exemplu, dacă anteturile arată num-pages=2, total-orgs=283, şi current-page=1, Vizualizați prima pagină a unui răspuns de două pagini care conține în total 283 de organizații. Pentru a accesa pagina următoare, adăugați page=2 parametru la cererea GET, așa cum se arată mai jos:

https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2

Punct final al API-ului Records

Punctul final al API-ului Records este utilizat pentru a interoga înregistrările de apeluri lipsă pentru anumite organizații în care au fost identificate discrepanțe sau date lipsă folosind API-ul Reconciliation.

API-ul Records returnează înregistrări de apeluri în format JSON, identic cu formatul descris în Detailed Call History API. Sarcina utilă returnată conține câmpuri identice cu sarcina utilă returnată din Istoricul detaliat al apelurilor. Pentru mai multe informații despre câmpuri și valorile acestora, consultați Raportul detaliat al istoricului apelurilor Webex Calling.

API-ul oferă înregistrări ale apelurilor care s-au încheiat cu 5 minute înainte de ora curentă. Pentru a vă asigura că toate înregistrările apelurilor sunt disponibile, vă recomandăm să interogați API-ul la o oră după intervalul orar preferat.

Adresa URL a punctului final al API-ului Records utilizează următorul format:

https://analytics-calling.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z

Parametri API

• OrgID (obligatoriu, șir de caractere) - ID-ul organizației pentru care doriți să preluați înregistrări. Puteți obține ID-uri de organizație din API-ul de reconciliere.
• startTime (obligatoriu, șir de caractere) - Data și ora de începere (UTC) pentru prima înregistrare pe care doriți să o colectați. Asigurați-vă că:
  • Formatezi ora ca YYYY-MM-DDTHH:MM:SS.mmmZ. De exemplu, 2025-08-15T06:00:00.000Z.
  • Data și ora de începere nu trebuie să fie mai vechi de 30 de zile față de ora UTC curentă.
  • Intervalul dintre startTime și endTime nu trebuie să depășească 12 ore într-o singură solicitare API.
• endTime (obligatoriu, șir de caractere) - Data și ora de încheiere (UTC) pentru ultima înregistrare pe care doriți să o colectați. Înregistrările se bazează pe ora raportării, adică momentul în care apelul este finalizat. Asigurați-vă că:
  • Formatezi ora ca YYYY-MM-DDTHH:MM:SS.mmmZ. De exemplu, 2025-08-15T18:00:00.000Z.
  • Data și ora de încheiere trebuie să fie cu cel puțin 5 minute înainte de ora UTC curentă și să nu fie mai vechi de 30 de zile.
  • Data și ora de încheiere trebuie să fie mai mari decât startTime.
  • Intervalul dintre startTime și endTime nu trebuie să depășească 12 ore într-o singură solicitare API.
• Max (opțional, număr) - Limitează numărul maxim de înregistrări pe pagină din răspuns. Asigurați-vă că:
  • Intervalul este de la 500 la 5000. Valoarea implicită este 5000. De exemplu, Max=1000.
  • Dacă API-ul are mai multe înregistrări de returnat decât valoarea maximă specificată, atunci răspunsul este paginat.
  • Dacă este specificată o valoare sub 500, aceasta este ajustată automat până la 500. Dacă este specificată o valoare mai mare de 5000, aceasta este ajustată la 5000.

Paginație

Pentru a identifica dacă răspunsurile API sunt paginate, verificați anteturile de răspuns pentru un antet Link. Dacă în antetul Link este prezentă o legătură next, extrageți-o și utilizați valoarea startTimeForNextFetch pentru a solicita următorul set de înregistrări. Dacă nu există o legătură următoare, atunci sunt colectate toate rapoartele pentru intervalul de timp selectat.

Cererile API pentru paginile ulterioare pot fi făcute imediat, dar trebuie limitate la maximum 10 cereri paginate pe minut, per domeniu de aplicare al token-ului.

De exemplu, dacă solicitarea API inițială este:

https://analytics-calling.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=2025-08-15T18:00:00.000Z&startTime=2025-08-15T06:00:00.000Z&Max=5000

atunci antetul Link din răspuns este:

; rel="next"

Alte valori posibile pentru linkuri includ rel="first" și rel="prev" pentru prima pagină și, respectiv, pentru pagina anterioară.

Partener reports/templates API-ul

Puteți genera și descărca rapoarte disponibile în Partner Hub utilizând API-urile Partner Reports. Pentru mai multe informații, consultați partenerul report/templates.

Partenerii pot, de asemenea, accesa și descărca mai multe rapoarte direct din Centrul pentru parteneri. Pentru mai multe informații, consultați rapoartele Partner Hub.