Mulțumim pentru feedback.

Webhook-ul Detailed Call Records oferă o soluție sigură, scalabilă și robustă condusă de evenimente, mai degrabă decât de solicitări. Acest webhook oferă o vizibilitate mai mare asupra Webex Calling activităților clienților dvs., sprijinind cazurile de utilizare de la facturare la raportare personalizată.

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

Pentru o introducere în webhook și API-urile sale însoțitoare, urmăriți acest Vidcast: API pentru istoricul apel Webex Calling urilor detaliate pentru parteneri.

Ce oferă webhook-ul partenerului

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

• Înregistrări de apeluri care s-au încheiat între 10 minute și 5 minute înainte de ora curentă.
• Orice înregistrări târzii procesate de Webex Calling cloud.
• Completează automat înregistrările apelurilor târzii în sarcinile utile ulterioare webhook pentru a asigura livrarea fiabilă.

Pentru a arăta modul în care înregistrările de apeluri sunt incluse î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 orele 14:00 și 14:05 sunt incluse în sarcina utilă 14:10.
• Înregistrările finalizate mai devreme (de exemplu, un apel care s-a încheiat la 14:04), dar proces ate 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 hub-ul partenerilor

Furnizând un webhook, permiteți platformei de analiză să trimită înregistrări de apeluri la adresa URL de apel înapoi ori de câte ori sunt generate.

Webex Callingînregistrările sunt livrate utilizând același format ca API-urile existente pentru înregistrări detaliate ale apelurilor. Puteți configura un webhook și puteți alege între două tipuri de feed:

• Analiză — Include toate înregistrările apelurilor pentru toate organizațiile client cu care partenerul are o Webex Calling relație. Aceasta include organizațiile în care:
  • Partenerul gestionează organizația client cu un rol de administrator complet partener.
  • Organizația client are un Webex Calling abonament activ în cadrul organizației partenere.
• Facturare — Include înregistrări de apeluri pentru apelurile efectuate de utilizatori cu o Webex Calling licență vândută și furnizată de partener. Înregistrările de apeluri pentru spațiile de lucru sunt incluse în acest feed.

Accesul și confidențialitatea datelor

Numai partenerul proprietar poate accesa Call Details Records (CDR) pentru facturare.

• Un partener (sau sub-partener) care gestionează licența asociată înregistrării apelurilor devine partenerul proprietar.
• Proprietatea este determinată de: ID utilizator > ID licență > ID abonament > ID partener.
• Fiecare CDR este accesibil unui singur partener.
• Unele înregistrări de apeluri nu se asociază cu un partener de facturare și nu toți partenerii asociați unei organizații beneficiază de acces egal la toate înregistrările, deoarece aceste înregistrări pot conține informații de identificare personală (PII).

În plus față de webhook, Webex Calling oferă puncte finale API pentru a sprijini reconcilierea datelor. Aceste puncte finale vă permit să recuperați sau să reconciliați stocurile de date cu orice înregistrări lipsă pe care ascultătorul dvs. webhook ar putea să nu le fi primit. Cele două puncte finale API sunt API-ul Rec onciliere și API- ul În registrări.

Î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ă vă reconciliați periodic magazinele de discuri, cum ar fi la fiecare 12 sau 24 de ore.

Trebuie să utilizați un token de acces partener pentru a accesa aceste API-uri. Utilizatorul care se autentifică trebuie să fie un administrator complet partener cu acces complet la nivel de administrare organizațional și trebuie să aibă activ Webex Callingat accesul CDR API. Tokenul OAuth trebuie să includă domeniul de spark-admin:calling_cdr_readaplicare. Rolurile de administrator numai pentru citire nu sunt suficiente pentru API-urile Reconciliere parteneri și Înregistrări.

Utilizați punctul analytics-callingfinal pentru regiunea de Webex Calling date a organizației client. Utilizați adresa URL de bază aplicabilă atât pentru API-urile Reconciliere, cât și pentru Înregistrări:

• SUA și Canada: https://analytics-calling.webexapis.com
• Europa: https://analytics-calling-eu.webexapis.com
• India: https://analytics-calling-in.webexapis.com
• Australia: https://analytics-calling-au.webexapis.com

Punct final API de reconciliere

Punctul final API 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 mai mult de 200 de organizații clienți, API-ul paginează rezultatele pentru a îmbunătăți lizibilitatea.

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

Parametrii API

Puteți utiliza API-ul pentru a prelua î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) — Data și ora de începere (UTC) pentru prima înregistrare pe care doriți să o colectați. Asiguraţi-vă că:
  • Formatați ora ca YYYY-MM-DDTHH:MM:SS.mmmZ. De exemplu, 2025-08-15T06:00:00.000Z.
  • Data și ora de începere nu trebuie să depășească 30 de zile de la ora UTC curentă.
  • Fereastra dintre startTimeși nu endTimepoate depăși 12 ore.
• EndTime (obligatoriu, șir) —Data și ora de încheiere (UTC) pentru înregistrările pe care doriți să le colectați. Înregistrările se bazează pe ora raportului, care este momentul în care apelul este finalizat. Asiguraţi-vă că:
  • Formatați 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 nu mai vechi de 30 de zile.
  • Data și ora de încheiere trebuie să fie mai mari decât startTime.
  • Fereastra dintre startTimeși nu endTimepoate depăși 12 ore.

Exemplu de răspuns JSON pentru punctul final API 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-pages: Numărul total de pagini (de exemplu, 2)
• total-orgs: Numărul total de organizații incluse în răspuns (de exemplu, 283)
• pagina curentă: Numărul de pagină curent (de exemplu, 1)

De exemplu, dacă anteturile afișează num-pages=2, total-orgs=283 și current-page=1, vizualizați prima pagină a unui răspuns de două pagini care conține 283 de organizații în total. Pentru a accesa pagina următoare, adăugați parametrul page=2 la solicitarea 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

Înregistrează punctul final API

Punctul final API Înregistrări este utilizat pentru a interoga înregistrările de apeluri lipsă pentru anumite organizații în care au fost identificate discrepanțe sau date lipsă utilizând API-ul Reconciliere.

Flux recomandat: Sunați /v1/partners/cdrcountbyorgmai întâi. Apoi utilizați exact orgIdreturnată cdr_counts[].orgIdatunci când sunați /v1/partners/cdrsbyorg.

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

API-ul oferă înregistrări de apeluri 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ă fereastra de timp preferată.

Adresa URL a punctului final API 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

Parametrii API

• orgId(obligatoriu, șir) —ID-ul organizației clientului pentru care doriți să preluați înregistrările. Numele parametrului este sensibil la majuscule. Puteți obține ID-uri de organizație din câmpul de răspuns API Reconciliere cdr_counts[].orgId.
• StartTime (obligatoriu, șir) — Data și ora de începere (UTC) pentru prima înregistrare pe care doriți să o colectați. Asiguraţi-vă că:
  • Formatați ora ca YYYY-MM-DDTHH:MM:SS.mmmZ. De exemplu, 2025-08-15T06:00:00.000Z.
  • Data și ora de începere nu trebuie să depășească 30 de zile de la ora UTC curentă.
  • Intervalul dintre startTimeși nu endTimetrebuie să depășească 12 ore într-o singură solicitare API.
• EndTime (obligatoriu, șir) — Data și ora de încheiere (UTC) pentru ultima înregistrare pe care doriți să o colectați. Înregistrările se bazează pe ora raportului, care este momentul în care apelul este finalizat. Asiguraţi-vă că:
  • Formatați 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 nu mai vechi de 30 de zile.
  • Data și ora de încheiere trebuie să fie mai mari decât startTime.
  • Intervalul dintre startTimeși nu endTimetrebuie să depășească 12 ore într-o singură solicitare API.
• max (opțional, număr) — Limitează numărul maxim de înregistrări pe pagină în 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ă până la 5000.

Paginare

Pentru a identifica dacă răspunsurile API sunt paginate, verificați anteturile de răspuns pentru un antet Link. Dacă un nextlink este prezent în antetul Link, extrageți-l și utilizați startTimeForNextFetchvaloarea pentru a solicita următorul set de înregistrări. Dacă nu există un link următor, atunci toate rapoartele pentru intervalul de timp selectat sunt colectate.

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

Utilizați procesarea și deduplicarea idempotent atunci când preluați înregistrări, inclusiv în răspunsuri paginate sau ferestre de reconciliere repetate. Utilizați reportIdca cheie primară și reportTimepentru a determina cea mai recentă înregistrare procesată.

De exemplu, dacă cererea inițială API 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:

<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&startTimeForNextFetch=2025-08-15T09:30:00.000Z&totalCount=20000&max=5000>; rel="next"

Paginarea utilizează numai antetul rel="next"Link. Dacă răspunsul include un rel="next"link, utilizați acea adresă URL pentru a prelua următoarea pagină de înregistrări. Dacă răspunsul nu include un rel="next"link, ați recuperat toate înregistrările disponibile pentru intervalul de timp selectat.

Puteți genera și descărca rapoarte disponibile în Partner Hub utilizând API-urile pentru rapoarte pentru parteneri. Pentru mai multe informații, consultați rapoartul /șab loanele partenerului.

De asemenea, partenerii pot accesa și descărca mai multe rapoarte direct din Partner Hub. Pentru mai multe informații, consultați rapoartele Partner Hub.