Grazie per il feedback.

Il webhook Detailed Call Records offre una soluzione sicura, scalabile e robusta basata sugli eventi anziché sulle richieste. Questo webhook offre una maggiore visibilità sulle Webex Calling attività dei suoi clienti, supportando i casi d'uso, dalla fatturazione ai report personalizzati.

Può utilizzare questo webhook per raccogliere comodamente i record di tutti i clienti gestiti tramite Partner Hub senza interrogare ogni cliente individualmente. Questo webhook Le consente di sviluppare applicazioni personalizzate di reporting, fatturazione e analisi sia per i requisiti aziendali interni che per i servizi a valore aggiunto.

Per un'introduzione al webhook e alle relative API, guardi questa API di cronologia dettagliata delle chiamate di Vidcast: Webex Calling Partner.

Cosa offre il webhook Partner

Il webhook fornisce registrazioni dettagliate della cronologia delle chiamate ogni 5 minuti. Ogni payload del webhook contiene :

• Registrazioni delle chiamate terminate tra 10 minuti e 5 minuti prima dell'ora corrente.
• Qualsiasi registrazione tardiva elaborata dal Webex Calling cloud.
• Riempie automaticamente i registri delle chiamate in ritardo nei successivi payload del webhook per garantire una consegna affidabile.

Per mostrare come i registri delle chiamate sono inclusi in ogni payload, consideri il seguente esempio:

• Un payload ricevuto alle 14:05 contiene chiamate terminate tra le 13:55 e le 14:00.
• Le chiamate che terminano tra le 14:00 e le 14:05 sono incluse nel payload delle 14:10.
• I record completati in precedenza (ad esempio, una chiamata terminata alle 14:04) ma elaborati in ritardo dal Webex Calling cloud (ad esempio, alle 14:11) sono inclusi nel payload programmato successivo ( ad esempio, 14:15).

Webhook nel Partner Hub

Fornendo un webhook, consente alla piattaforma di analisi di inviare i record delle chiamate al suo URL di callback ogni volta che vengono generati.

Webex Callingi record vengono consegnati utilizzando lo stesso formato delle API Detailed Call Records esistenti. Può configurare un webhook e scegliere tra due tipi di feed:

• Analisi: include tutti i registri delle chiamate per tutte le organizzazioni clienti con cui il partner ha una Webex Calling relazione. Ciò include le organizzazioni in cui:
  • Il partner gestisce l'organizzazione del cliente con il ruolo di Amministratore completo del partner.
  • L'organizzazione cliente ha un Webex Calling abbonamento attivo all'interno dell'organizzazione partner.
• Fatturazione: include i registri delle chiamate effettuate dagli utenti con una Webex Calling licenza venduta e fornita dal partner. I registri delle chiamate per Workspaces sono inclusi in questo feed.

Accesso e privacy dei dati

Solo il partner proprietario può accedere ai Call Detail Records (CDR) per la fatturazione.

• Un partner (o subpartner) che gestisce la licenza associata al registro delle chiamate diventa il partner proprietario.
• La proprietà è determinata da: ID utente > ID licenza > ID abbonamento > ID partner.
• Ogni CDR è accessibile a un singolo partner.
• Alcuni registri delle chiamate non corrispondono a un partner di fatturazione e non tutti i partner associati a un' organizzazione hanno lo stesso accesso a tutti i record, poiché questi record possono contenere informazioni di identificazione personale (PII).

Oltre al webhook, Webex Calling fornisce endpoint API per supportare la riconciliazione dei dati. Questi endpoint Le consentono di recuperare o riconciliare i suoi archivi di dati con eventuali record mancanti che il suo ascoltatore di webhook potrebbe non aver ricevuto. I due endpoint API sono l'API di riconciliazione e l'API Records.

I record di queste API sono disponibili per 30 giorni. Per assicurarci di ricevere tutti i record previsti, le consigliamo di riconciliare i suoi negozi di dischi periodicamente, ad esempio ogni 12 o 24 ore.

È necessario utilizzare un token di accesso partner per accedere a queste API. L'utente che esegue l'autenticazione deve essere un Partner Full Administrator con accesso completo a livello di amministratore organizzativo e deve avere l'accesso all'API Webex Calling CDR abilitato. Il token OAuth deve includere l'spark-admin:calling_cdr_readambito. I ruoli di amministratore di sola lettura non sono sufficienti per le API Partner Reconciliation and Records.

Usa l'analytics-callingendpoint per l'area Webex Calling dati dell'organizzazione del cliente. Utilizza l'URL di base applicabile per le API Reconciliation e Records:

• Stati Uniti e 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

Endpoint dell'API di riconciliazione

L'endpoint dell'API di riconciliazione restituisce il numero totale di registrazioni delle chiamate generate per ogni cliente gestito dal partner entro il periodo di tempo specificato. Può utilizzare questi totali per verificare la sua memoria locale e identificare eventuali registrazioni delle chiamate mancanti o incoerenti per clienti specifici.

Se gestisce più di 200 organizzazioni di clienti, l'API impagina i risultati per migliorare la leggibilità.

L'URL dell'endpoint dell'API di riconciliazione utilizza il seguente formato:

Parametri API

Può utilizzare l'API per recuperare i registri delle chiamate degli ultimi 30 giorni. La finestra oraria selezionata deve iniziare almeno 5 minuti prima dell'ora UTC corrente e non può superare le 12 ore tra l'ora di inizio e di fine in una singola chiamata API.

I parametri dell'API sono:

• startTime (obbligatorio, stringa): la data e l'ora di inizio (UTC) del primo record che desidera raccogliere. Si assicuri che:
  • Formatta l'ora come YYYY-MM-DDTHH:MM:SS.mmmZ. Ad esempio, 2025-08-15T06:00:00.000Z.
  • La data e l'ora di inizio non devono essere più vecchie di 30 giorni dall'ora UTC corrente.
  • La finestra tra startTimee non endTimepuò superare le 12 ore.
• EndTime (obbligatorio, stringa): la data e l'ora di fine (UTC) dei record che desidera raccogliere. I registri si basano sull'ora del rapporto, ovvero quando la chiamata è terminata. Si assicuri che:
  • Formatta l'ora come YYYY-MM-DDTHH:MM:SS.mmmZ. Ad esempio, 2025-08-15T18:00:00.000Z.
  • La data e l'ora di fine devono essere 5 minuti prima dell'ora UTC corrente e non più vecchie di 30 giorni.
  • La data e l'ora di fine devono essere successive al startTime.
  • La finestra tra startTimee non endTimepuò superare le 12 ore.

Esempio di risposta JSON dell'endpoint dell'API di riconciliazione:

          {
          "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
          }
          ]
          }          
        

Le intestazioni delle risposte dell'API indicano il numero totale di organizzazioni restituite e se sono disponibili pagine aggiuntive. Controlli i seguenti parametri dell'intestazione per assicurarsi di aver interrogato tutte le pagine:

• num-pages: numero totale di pagine (ad esempio, 2)
• total-orgs: Numero totale di organizzazioni incluse nella risposta (ad esempio, 283)
• pagina corrente: il numero di pagina corrente (ad esempio, 1)

Ad esempio, se le intestazioni mostrano num-pages=2, total-orgs=283 e current-page=1, sta visualizzando la prima pagina di una risposta di due pagine contenente 283 organizzazioni in totale. Per accedere alla pagina successiva, aggiunga il parametro page=2 alla sua richiesta GET, come mostrato di seguito:

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

Endpoint API dei record

L'endpoint Records API viene utilizzato per interrogare i record delle chiamate mancanti per organizzazioni specifiche in cui sono state identificate discrepanze o dati mancanti utilizzando l'API di riconciliazione.

Flusso consigliato: chiami /v1/partners/cdrcountbyorgprima. Quindi usi l'esatto orgIdrestituito cdr_counts[].orgIdquando chiama /v1/partners/cdrsbyorg.

L'API Records restituisce i record delle chiamate in formato JSON, identico al formato descritto nell'API Cronologia dettagliata delle chiamate. Il payload restituito contiene campi identici al payload restituito dalla cronologia dettagliata delle chiamate. Per ulteriori informazioni sui campi e sui relativi valori, vedere Rapporto Webex Calling dettagliato sulla cronologia delle chiamate.

L'API fornisce i registri delle chiamate terminati 5 minuti prima dell'ora corrente. Per garantire che tutti i registri delle chiamate siano disponibili, consigliamo di interrogare l'API un'ora dopo la sua finestra oraria preferita.

L'URL dell'endpoint Records API utilizza il seguente formato:

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(obbligatorio, stringa): l'ID dell'organizzazione del cliente per cui desidera recuperare i record. Il nome del parametro fa distinzione tra maiuscole e minuscole. Può ottenere gli ID dell'organizzazione dal campo di risposta dell'API di riconciliazione. cdr_counts[].orgId
• startTime (obbligatorio, stringa): la data e l'ora di inizio (UTC) del primo record che desidera raccogliere. Si assicuri che:
  • Formatta l'ora come YYYY-MM-DDTHH:MM:SS.mmmZ. Ad esempio, 2025-08-15T06:00:00.000Z.
  • La data e l'ora di inizio non devono essere più vecchie di 30 giorni dall'ora UTC corrente.
  • L'intervallo tra startTimee non endTimedeve superare le 12 ore in una singola richiesta API.
• EndTime (obbligatorio, stringa): la data e l'ora di fine (UTC) dell'ultimo record che desidera raccogliere. I registri si basano sull'ora del rapporto, ovvero quando la chiamata è terminata. Si assicuri che:
  • Formatta l'ora come YYYY-MM-DDTHH:MM:SS.mmmZ. Ad esempio, 2025-08-15T18:00:00.000Z.
  • La data e l'ora di fine devono essere almeno 5 minuti prima dell'ora UTC corrente e non più vecchie di 30 giorni.
  • La data e l'ora di fine devono essere successive al startTime.
  • L'intervallo tra startTimee non endTimedeve superare le 12 ore in una singola richiesta API.
• max (opzionale, numero) —Limita il numero massimo di record per pagina nella risposta. Si assicuri che:
  • L'intervallo va da 500 a 5000. Il valore predefinito è 5000. Ad esempio, max=1000.
  • Se l'API ha più record da restituire rispetto al valore massimo specificato, la risposta viene impaginata.
  • Se viene specificato un valore inferiore a 500, viene automaticamente portato a 500. Se viene specificato un valore superiore a 5000, viene ridotto a 5000.

Impaginazione

Per identificare se le risposte dell'API sono impaginate, controlli le intestazioni delle risposte per un'intestazione Link. Se è presente un nextlink nell'intestazione Link, lo estragga e usi il startTimeForNextFetchvalore per richiedere il set di record successivo. Se non c'è un link successivo, vengono raccolti tutti i report per l'intervallo di tempo selezionato.

Le richieste API per le pagine successive possono essere effettuate immediatamente, ma devono essere limitate a un massimo di 10 richieste impaginate al minuto, per ambito di token.

Usa l'elaborazione e la deduplicazione idempotenti quando recupera i record, anche tra risposte impaginate o finestre di riconciliazione ripetute. Utilizzare reportIdcome chiave primaria e reportTimeper determinare l'ultimo record elaborato.

Ad esempio, se la richiesta API iniziale è:

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

allora l'intestazione del Link nella risposta è:

<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"

Pagination utilizza solo l'intestazione rel="next"Link. Se la risposta include un rel="next"link, usi quell'URL per recuperare la pagina successiva dei record. Se la risposta non include un rel="next"link, ha recuperato tutti i record disponibili per l'intervallo di tempo selezionato.

Può generare e scaricare i report disponibili in Partner Hub utilizzando le API Partner Reports. Per ulteriori informazioni, consulti il rapporto/i modelli per i partner.

I partner possono anche accedere e scaricare più report direttamente da Partner Hub. Per ulteriori informazioni, consulti i report di Partner Hub.