Il webhook Record di chiamata dettagliato ti consente di avere una maggiore visibilità sull'attività Webex Calling dei tuoi clienti per diversi scopi, dalla fatturazione al reporting personalizzato. Puoi utilizzare questo webhook per raccogliere facilmente i record per tutti i tuoi clienti senza dover interrogare i record di ciascun cliente uno alla volta. Questo webhook consente di sviluppare report personalizzati e applicazioni analitiche per scopi aziendali interni o per la fornitura di servizi a valore aggiunto ai clienti. Per un'introduzione al webhook e alle relative API, puoi guardare questo vidcast.

Il webhook consegna record ogni 5 minuti. Ciascun payload webhook contiene i record per le chiamate terminate tra 10 e 5 minuti fa. Ad esempio, un payload ricevuto alle 17:00 include le chiamate terminate tra 16:50 e 16:55. Le chiamate che terminano tra le 16:55 e le 17:00 saranno nel payload 17:05.

I record Webex Calling vengono consegnati utilizzando lo stesso formato delle API di record di chiamata dettagliati esistenti. È possibile impostare un webhook e scegliere tra due tipi di feed:

• Analisi: include tutti i record di chiamata per tutte le organizzazioni dei clienti con cui il partner ha una relazione Webex Calling. Sono incluse le organizzazioni per le quali:
  • Il partner gestisce l'organizzazione del cliente con un ruolo di amministratore completo del partner.
  • L'organizzazione del cliente dispone di un abbonamento a Webex Calling attivo all'interno dell'organizzazione partner.
• Fatturazione: include solo i record di chiamata per le chiamate effettuate dagli utenti con una licenza Webex Calling venduta dal partner. I record delle chiamate per gli spazi di lavoro sono inclusi in questo feed.

Forniamo due endpoint API insieme al webhook per facilitare la riconciliazione dei dati. Questi endpoint consentono di "recuperare" o riconciliare i datastore con i record mancanti che non vengono ricevuti dall'ascoltatore webhook. Queste due API sono l'endpoint API di riconciliazion e e l'endpoint API di registrazione.

I record sono disponibili da queste API per 48 ore. Si consiglia di riconciliare i record memorizzati periodicamente, ad esempio ogni 12 o 24 ore, in modo che tutti i record vengano ricevuti come previsto. Per utilizzare questa API è necessario un token di accesso partner. È possibile ottenere un token di accesso partner e gestirlo in base ai principi di gestione dei token di accesso per sviluppatori Webex standard.

Endpoint API di riconciliazione

L'endpoint dell'API di riconciliazione restituisce il numero di record generati da ciascun cliente gestito dal partner nel periodo di tempo specificato. Se un partner gestisce più di 200 organizzazioni di clienti, i risultati dell'API verranno impaginati per una migliore leggibilità. È possibile utilizzare questi totali per verificare l'archiviazione locale se mancano record per clienti specifici. L'URL dell'endpoint API di riconciliazione è disponibile qui:

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

Parametri

L'API di riconciliazione può essere richiamata solo per una durata massima di 1 ora, con i parametri startTime e endTime a non più di 60 minuti di distanza. L'API può essere utilizzata per qualsiasi periodo di 1 ora compreso tra 5 minuti e 48 ore fa, ma per gestire il carico del servizio, è possibile chiamare solo 1 ora alla volta.

I parametri disponibili sono:

• startTime (stringa): ora del primo report che si desidera raccogliere. L'ora del report specifica l'ora di completamento della chiamata.

  È necessario formattare l'ora come YYYY-MM-DDTHH:MM:SS.mmmZ.

• endTime (stringa): ora dell'ultimo report che si desidera raccogliere. L'ora del report specifica l'ora di completamento della chiamata.

  L'ora specificata deve essere successiva all'Ora di inizio , ma non oltre 48 ore e occorre formattare l'ora come AAAA-MM-DDTHH:MM:SS.mmmZ.

Di seguito un esempio di payload di ritorno JSON dell'endpoint di API di riconciliazione:

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

Le intestazioni della risposta API indicano il numero totale di organizzazioni restituite e se sono presenti pagine aggiuntive. Controllare i parametri seguenti per verificare che tutte le pagine siano state interrogate.

 num-pagine = 2 organizzazioni in totale = 283 pagina corrente = 1

I parametri sopra riportati mostrano che la pagina corrente è la prima pagina, che ci sono 2 pagine totali e che l'intera risposta contiene 283 organizzazioni. Accedere alla seconda pagina aggiungendo il parametro page=2 alla richiesta GET , come mostrato di seguito.

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

Registra endpoint API

Questo endpoint API restituisce i record di chiamata in formato JSON, identico al formato descritto nell'API di cronologia chiamate dettagliata. Il payload restituito contiene campi identici al payload restituito per la cronologia dettagliata delle chiamate. Ulteriori dettagli sui valori in ciascun campo restituito sono disponibili qui. L'endpoint API dei record viene utilizzato per eseguire query sui record mancanti per le organizzazioni per le quali mancano i record. L'URL dell'endpoint API dei record è disponibile qui:

https://analytics.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

• orgID: l'ID dell'organizzazione per cui si desidera eseguire query sui record. È possibile aprire questi identificativi dall'endpoint di riconciliazione precedente.

• startTime (stringa): ora del primo report che si desidera raccogliere. L'ora del report specifica l'ora di completamento della chiamata.

  L'orario specificato deve essere compreso tra 5 minuti e 48 ore fa e occorre formattare il formato come YYYY-MM-DDTHH:MM:SS.mmmZ.

• endTime (stringa): ora dell'ultimo report che si desidera raccogliere. L'ora del report specifica l'ora di completamento della chiamata.

  L'ora specificata deve essere successiva all'Ora di inizio , ma non oltre 48 ore e occorre formattare l'ora come AAAA-MM-DDTHH:MM:SS.mmmZ.