Overzicht

Met de webhook Gedetailleerde gespreksrecords hebt u meer zicht op de Webex Calling-activiteit van uw klanten voor verschillende doeleinden, van facturering tot rapportage op maat. U kunt deze webhook gebruiken om gemakkelijk records te verzamelen voor al uw klanten zonder dat u records voor elke klant één voor één hoeft op te vragen. Met deze webhook kunt u aangepaste rapportage- en analyticatoepassingen ontwikkelen voor zowel interne zakelijke doeleinden als het leveren van diensten met toegevoegde waarde aan klanten. Voor een kennismaking met de webhook en de bijbehorende API's kunt u deze vidcast bekijken.

De webhook levert elke 5 minuten records. Elke webhook-payload bevat records voor gesprekken die tussen 10 en 5 minuten geleden zijn beëindigd. Een payload die om 17:00 wordt ontvangen, omvat bijvoorbeeld gesprekken die tussen 16:50 en 16:55 zijn beëindigd. Gesprekken die tussen 16:55 en 17:00 worden beëindigd, worden in de payload 17:05 weergegeven.

Webex Calling-records worden geleverd met dezelfde indeling als de bestaande API's voor gedetailleerde gespreksrecords. U kunt een webhook instellen en kiezen tussen twee typen feed:

  • Analyse: bevat alle gespreksrecords voor alle klantorganisaties waarmee de partner een Webex Calling-relatie heeft. Hieronder vallen ook organisaties waarvoor:
    • De partner beheert de klantorganisatie met de rol Volledige partnerbeheerder.
    • De klantorganisatie heeft een actief Webex Calling-abonnement binnen de partnerorganisatie.
  • Facturering: bevat alleen gespreksrecords voor gesprekken van gebruikers met een Webex Calling-licentie die door de partner wordt verkocht. Gespreksrecords voor werkplekken zijn opgenomen in deze feed.

Een webhookteterugroep-URL instellen

Configureer de webhook in de Partnerhub. U kunt slechts één webhook per partnerorganisatie instellen. U moet een volledige beheerder zijn om een webhook in te stellen.

1

Meld u aan bij Partner Hub.

2

Ga naar Organisatie-instellingen > Records met gespreksgegevens.

3

Voer onder Webhook een te gebruiken URL in.

4

Als u de payloads van uw webhook met een geheim token wilt verifiëren, kunt u er een toevoegen. Meer informatie over Webex-webhooks en geheime tokens vindt u hier.

5

Selecteer een van de volgende resourcetype n voor de webhook:

  • Analyse: bevat alle gespreksrecords voor alle klantorganisaties waarmee de partner een Webex Calling-relatie heeft.
  • Facturering: bevat alleen gespreksrecords waarnaar de partner Webex Calling-licenties heeft verkocht. Deze feed bevat gespreksrecords voor werkplekken.
Gedetailleerde records voor gespreksopnamen instellen webhook in Partnerhub

API-eindpunten

We bieden twee API-eindpunten samen met de webhook om te helpen bij het afstemmen van gegevens. Met deze eindpunten kunt u uw gegevensopslag 'inhalen' of combineren met ontbrekende records die niet zijn ontvangen door de webhookluisteraar. Deze twee API's zijn het API-eindpunt voor afstemmin g en het API-eindpunt voor records.

Records zijn gedurende 48 uur beschikbaar via deze API's. We raden aan om de opnameopslag periodiek te verzoenen, bijvoorbeeld om de 12 of 24 uur, zodat alle records naar verwachting worden ontvangen. Een toegangstoken voor partners is vereist om deze API te gebruiken. U kunt een toegangstoken voor partners verkrijgen en beheren volgens de standaard beheerprincipes voor toegangstoken voor ontwikkelaars van Webex.

Afstemming API-eindpunt

Het API-eindpunt voor afstemming geeft het aantal records terug dat is gegenereerd door elke klant en wordt beheerd door de partner in de opgegeven tijdsperiode. Als een partner meer dan 200 klantorganisaties beheert, worden de resultaten van de API gepagineerd voor een betere leesbaarheid. U kunt deze totalen gebruiken om te controleren met uw lokale opslag als er records ontbreken voor specifieke klanten. U kunt de afstemming-API-eindpunt-URL hier vinden:

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

Parameters

De afstemming-API kan slechts worden gebeld voor een maximale duur van 1 uur, waarbij de parameters startTime en endTime niet meer dan 60 minuten tussen elkaar liggen. De API kan tussen 5 minuten en 48 uur geleden worden gebruikt voor elke periode van 1 uur, maar om de servicelading te beheren, kan slechts 1 uur tegelijk worden gebeld.

De beschikbare parameters zijn:

  • startTime (tekenreeks): de tijd van het eerste rapport dat u wilt verzamelen. De rapporttijd geeft de voltooiingstijd van het gesprek aan.

    U moet de tijd opmaken als JJJJ-MM-DDTHH:MM:SS.mmmZ.

  • endTime (tekenreeks): de tijd van het laatste rapport dat u wilt verzamelen. De rapporttijd geeft de voltooiingstijd van het gesprek aan.

    De opgegeven tijd moet na startTime liggen, maar niet later dan 48 uur. U moet de tijd opmaken als JJJJ-MM-DDTHH:MM:SS.mmmZ.

Dit is een voorbeeld van hoe een JSON-retourpayload voor een API-eindpunt voor afstemming eruit ziet:

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

De kopteksten van de API-reactie geven het totale aantal geretourneerde organisaties aan en of er extra pagina's zijn. Controleer de volgende parameters om er zeker van te zijn dat alle pagina's zijn opgevraagd.

 num-pagina's = 2 totaal-organisaties = 283 huidige-pagina = 1

De bovenstaande parameters laten zien dat de huidige pagina de eerste pagina is, dat er in totaal 2 pagina's zijn en dat het gehele antwoord 283 organisaties bevat. Open de tweede pagina door de parameter pagina=2 toe te voegen aan het GET -verzoek, zoals hieronder wordt weergegeven.

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

API-eindpunt voor records

Dit API-eindpunt retourneert gespreksrecords in JSON-indeling, identiek aan de indeling zoals beschreven in de API voor gedetailleerde gespreksgeschiedenis. De geretourneerde payload bevat identieke velden voor de gedetailleerde gespreksgeschiedenis van de geretourneerde payload. Meer details over de waarden in elk teruggestuurd veld vindt u hier. Het API-eindpunt voor records wordt gebruikt om ontbrekende records op te vragen voor organisaties voor wie er records ontbreken. U kunt de URL van het API-eindpunt voor records hier vinden:

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

Parameters

  • orgID: de organisatie-id waarvoor u records wilt opvragen. U kunt deze id's openen vanaf het vorige afstemmingseindpunt.

  • startTime (tekenreeks): de tijd van het eerste rapport dat u wilt verzamelen. De rapporttijd geeft de voltooiingstijd van het gesprek aan.

    De opgegeven tijd moet tussen 5 minuten en 48 uur geleden liggen en u moet de tijd opmaken als JJJJ-MM-DDTHH:MM:SS.mmmZ.

  • endTime (tekenreeks): de tijd van het laatste rapport dat u wilt verzamelen. De rapporttijd geeft de voltooiingstijd van het gesprek aan.

    De opgegeven tijd moet na startTime liggen, maar niet later dan 48 uur. U moet de tijd opmaken als JJJJ-MM-DDTHH:MM:SS.mmmZ.