Aperçu

Le point d’ancrage web détaillé des enregistrements d’appels vous permet d’avoir une meilleure visibilité sur l’activité Webex Calling de vos clients à diverses fins, de la facturation à la création de rapports personnalisés. Vous pouvez utiliser ce webhook pour collecter facilement des enregistrements pour tous vos clients sans avoir à demander des enregistrements pour chaque client un par un. Ce webhook vous permet de développer des applications de reporting et d’analyse personnalisées à des fins commerciales internes ou pour la fourniture de services à valeur ajoutée aux clients. Pour une introduction au webhook et à ses API, vous pouvez regarder ce vidcast.

Le point d’ancrage web fournit des enregistrements toutes les 5 minutes. Chaque charge utile du point d’ancrage web contient des enregistrements pour les appels qui ont pris fin il y a entre 10 et 5 minutes. Par exemple, une charge utile reçue à 17:00 inclut les appels qui se sont terminés entre 16:50 et 16:55. Les appels se terminant entre 16:55 et 17:00 seront dans la charge utile 17:05.

Les enregistrements Webex Calling sont fournis en utilisant le même format que les API d’enregistrements d’appels détaillés existantes. Vous pouvez configurer un webhook et choisir entre deux types de flux :

  • Analyses—Inclut tous les enregistrements d’appels pour toutes les organisations clientes avec lesquelles le partenaire a une relation Webex Calling. Cela inclut les organisations pour lesquelles :
    • Le partenaire gère l’organisation du client avec un rôle d’administrateur complet du partenaire.
    • L’organisation du client dispose d’un abonnement Webex Calling actif au sein de l’organisation partenaire.
  • Facturation–Inclut uniquement les enregistrements d’appels passés par des utilisateurs disposant d’une licence Webex Calling vendue par le partenaire. Les enregistrements d’appels pour les espaces de travail sont inclus dans ce flux.

Configurer l’URL de rappel d’un webhook

Configurez le point d’ancrage web dans le Hub partenaire. Vous ne pouvez configurer qu’un seul point d’ancrage web par organisation partenaire. Vous devez être un administrateur complet pour configurer un webhook.

1

Connectez-vous au Hub partenaire.

2

Allez dans Paramètres de l’organisation > Enregistrements détaillés des appels.

3

Saisissez une URL à utiliser sous Webhook.

4

Si vous souhaitez authentifier vos données utiles de webhook à l’aide d’un jeton secret, vous pouvez en ajouter un. Vous trouverez plus d’informations sur les webhooks et jetons secrets Webex ici.

5

Sélectionnez l'un des Type de ressourc e suivants à utiliser pour le webhook :

  • Analyses—Inclut tous les enregistrements d’appels pour toutes les organisations clientes avec lesquelles le partenaire a une relation Webex Calling.
  • Facturation—Inclut uniquement les enregistrements d’appels auxquels le partenaire a vendu des licences Webex Calling. Ce flux inclut les enregistrements d’appels pour les espaces de travail.
Configuration du point d’ancrage web des enregistrements détaillés des appels dans Partner Hub

Points de terminaison de l'API

Nous fournissons deux points de terminaison API avec le webhook pour aider à la réconciliation des données. Ces points de terminaison vous permettent de « rattraper votre retard » ou de réconcilier vos banques de données avec des enregistrements manquants qui ne sont pas reçus par l’auditeur du webhook. Ces deux API sont le point de terminaison de l’API de réconciliatio n et le point de terminaison de l’API des enregistrements.

Les enregistrements sont disponibles à partir de ces API pendant 48 heures. Nous vous recommandons de rapprocher les magasins d'enregistrements périodiquement, comme toutes les 12 ou 24 heures, afin que tous les enregistrements soient reçus comme prévu. Un jeton d’accès partenaire est nécessaire pour utiliser cette API. Vous pouvez obtenir un jeton d’accès partenaire et le gérer conformément aux principes standard de gestion des jetons d’accès des développeurs Webex.

Point de terminaison de l’API de réconciliation

Le point de terminaison API de réconciliation renvoie le nombre d’enregistrements générés par chaque client qui sont gérés par le partenaire au cours de la période de temps spécifiée. Si un partenaire gère plus de 200 organisations clients, les résultats de l'API seront paginés pour une meilleure lisibilité. Vous pouvez utiliser ces totaux pour vérifier par rapport à votre stockage local si des enregistrements sont manquants pour des clients spécifiques. Vous pouvez trouver l'URL du point de terminaison de l'API de réconciliation ici :

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

Paramètres

L’API de réconciliation ne peut être appelée que pour une durée maximale d’1 heure, les paramètres startTime et endTime étant séparés d’un maximum de 60 minutes. L'API peut être utilisée pour toute période d'1 heure comprise entre 5 minutes et 48 heures, mais pour gérer la charge du service, seule 1 heure peut être appelée à la fois.

Les paramètres disponibles sont les suivants :

  • startTime (chaîne)—Heure du premier rapport que vous souhaitez collecter. L'heure du rapport spécifie l'heure de fin de l'appel.

    Vous devez formater l'heure comme étant AAAA-MM-DDTHH:MM:SS.mmmZ.

  • endTime (chaîne)—Heure du dernier rapport que vous souhaitez collecter. L'heure du rapport spécifie l'heure de fin de l'appel.

    L'heure spécifiée doit être postérieure à startTime mais pas plus tard que 48 heures et vous devez formater l'heure comme AAAA-MM-DDTHH:MM:SS.mmmZ.

Voici un exemple de ce à quoi ressemble une charge utile de retour JSON d'un point de terminaison API de réconciliation :

{"cdr_counts": [{"orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyyyy", "count": 3009 }, {« ID de l'organisation » : « yyyyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyyyyyyyy », « nombre » : 129 }, {« ID de l'organisation » : « xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyyyyy », « nombre » : 278 } ] } 

Les en-têtes de la réponse de l'API indiquent le nombre total d'organisations renvoyées et s'il y a des pages supplémentaires. Vérifiez les paramètres suivants pour vous assurer que toutes les pages ont été interrogées.

 num-pages = 2 total-orgs = 283 page actuelle = 1

Les paramètres ci-dessus montrent que la page actuelle est la première page, qu'il y a 2 pages au total et que l'ensemble de la réponse contient 283 organisations. Accédez à la deuxième page en ajoutant le paramètre page=2 à la demande GET , comme indiqué ci-dessous.

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

Enregistre le point de terminaison de l’API

Ce point de terminaison de l'API renvoie les enregistrements d'appels au format JSON, identique au format décrit dans l'API d'historique détaillé des appels. La charge utile renvoyée contient des champs identiques à la charge utile renvoyée de l'historique détaillé des appels. Vous trouverez plus de détails sur les valeurs de chaque champ retourné ici. Le point de terminaison de l'API des enregistrements est utilisé pour interroger les enregistrements manquants pour les organisations pour lesquelles des enregistrements sont manquants. Vous pouvez trouver l'URL du point de terminaison de l'API des enregistrements ici :

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

Paramètres

  • orgID—L'ID de l'organisation pour lequel vous souhaitez interroger les enregistrements. Vous pouvez ouvrir ces identifiants à partir du point de terminaison de réconciliation précédent.

  • startTime (chaîne)—Heure du premier rapport que vous souhaitez collecter. L'heure du rapport spécifie l'heure de fin de l'appel.

    L'heure spécifiée doit être comprise entre 5 minutes et 48 heures et vous devez formater l'heure comme étant AAAA-MM-DDTHH:MM:SS.mmmZ.

  • endTime (chaîne)—Heure du dernier rapport que vous souhaitez collecter. L'heure du rapport spécifie l'heure de fin de l'appel.

    L'heure spécifiée doit être postérieure à startTime mais pas plus tard que 48 heures et vous devez formater l'heure comme AAAA-MM-DDTHH:MM:SS.mmmZ.