Hartelijk dank voor uw feedback

De webhook voor gedetailleerde gespreksrecords biedt een veilige, schaalbare en robuuste oplossing die wordt aangedreven door gebeurtenissen in plaats van verzoeken. Deze webhook biedt meer inzicht in de Webex Calling activiteiten van uw klanten en ondersteunt gebruikssituaties, van facturering tot op maat gemaakte rapportage.

U kunt deze webhook gebruiken om gemakkelijk gegevens te verzamelen voor alle klanten die via de Partner Hub worden beheerd, zonder elke klant afzonderlijk te hoeven ondervragen. Met deze webhook kunt u aangepaste rapportage-, facturerings- en analysetoepassingen ontwikkelen voor zowel interne zakelijke vereisten als diensten met toegevoegde waarde.

Bekijk deze Vidcast: Webex Calling Partner Detailed Call History API voor een kennismaking met de webhook en de bijbehorende API's.

Wat de Partner webhook biedt

De webhook levert elke 5 minuten gedetailleerde gespreksgeschiedenis. Elke webhook-payload bevat :

• Gespreksgegevens die tussen 10 minuten en 5 minuten voor de huidige tijd zijn beëindigd.
• Alle gegevens die te laat zijn verwerkt door de Webex Calling cloud.
• Vult automatisch records van late gesprekken aan in de daaropvolgende webhook-payloads om een betrouwbare levering te garanderen .

Bekijk het volgende voorbeeld om te laten zien hoe gespreksrecords zijn opgenomen in elke payload:

• Een payload die om 14:05 werd ontvangen, bevat oproepen die zijn beëindigd tussen 13:55 en 14:00 uur.
• Gesprekken die eindigen tussen 14:00 en 14:05 zijn inbegrepen in de payload om 14:10 uur.
• Records die eerder zijn voltooid (bijvoorbeeld een gesprek dat eindigde om 14:04) maar die te laat via de Webex Calling cloud zijn verwerkt (bijvoorbeeld om 14:11), worden opgenomen in de volgende geplande payload ( bijvoorbeeld 14:15).

Webhook in de Partner Hub

Door een webhook aan te bieden, stelt u het analyseplatform in staat om gespreksgegevens naar uw terugbel-URL te sturen wanneer ze worden gegenereerd.

Webex Callingrecords worden geleverd in hetzelfde formaat als de bestaande API's voor gedetailleerde oproeprecords. U kunt een webhook opzetten en kiezen tussen twee soorten feeds:

• Analytics — Omvat alle gespreksgegevens van alle klantenorganisaties waarmee de partner een Webex Calling relatie heeft. Dit geldt ook voor organisaties waar:
  • De partner beheert de klantenorganisatie met de rol van Partner Full Administrator.
  • De klantenorganisatie heeft een actief Webex Calling abonnement binnen de partnerorganisatie.
• Facturering: omvat gespreksgegevens voor gesprekken van gebruikers met een Webex Calling licentie die door de partner is verkocht en beschikbaar gesteld. Oproepgegevens voor Workspaces zijn opgenomen in deze feed.

Toegang en gegevensprivacy

Alleen de partner die eigenaar is, heeft toegang tot de Call Detail Records (CDR) voor de facturering.

• Een partner (of subpartner) die de licentie beheert die aan het gespreksrecord is gekoppeld, wordt de eigenaar.
• Het eigendom wordt bepaald door: Gebruikers-ID > Licentie-ID > Abonnement-ID > Partner-ID.
• Elke CDR is toegankelijk voor één enkele partner.
• Sommige gespreksgegevens zijn niet gekoppeld aan een factureringspartner, en niet alle partners die verbonden zijn aan een organisatie krijgen gelijke toegang tot alle records, aangezien deze records mogelijk persoonlijk identificeerbare informatie (PII) bevatten.

Naast de webhook Webex Calling biedt het API-eindpunten ter ondersteuning van gegevensafstemming. Met deze eindpunten kunt u uw gegevensopslag inhalen of in overeenstemming brengen met ontbrekende records die uw webhook-luisteraar mogelijk niet heeft ontvangen. De twee API-eindpunten zijn de Reconciliation API en de Records API.

Gegevens van deze API's zijn 30 dagen beschikbaar. Om er zeker van te zijn dat u alle verwachte platen ontvangt, raden we u aan uw platenwinkels regelmatig bij elkaar te brengen, bijvoorbeeld elke 12 of 24 uur.

U moet een toegangstoken van een partner gebruiken om toegang te krijgen tot deze API's. De authenticerende gebruiker moet een volledige partnerbeheerder zijn met volledige toegang tot de organisatie op beheerdersniveau en moet de Webex CallingCDR API-toegang hebben ingeschakeld. Het OAuth-token moet het spark-admin:calling_cdr_readbereik bevatten. Beheerdersrollen die alleen kunnen worden gelezen, zijn niet voldoende voor de API Partner Reconciliation and Records.

Gebruik het analytics-callingeindpunt voor de Webex Calling gegevensregio van de klantorganisatie. Gebruik de toepasselijke basis-URL voor zowel de Reconciliation- als de Records-API's:

• VS en Canada: https://analytics-calling.webexapis.com
• Europa: https://analytics-calling-eu.webexapis.com
• India: https://analytics-calling-in.webexapis.com
• Australië: https://analytics-calling-au.webexapis.com

Endpoint voor de Reconciliation API

Het eindpunt van de Reconciliation API retourneert het totale aantal gespreksrecords dat is gegenereerd voor elke klant, beheerd door de partner binnen de gespecificeerde periode. U kunt deze totalen gebruiken om uw lokale opslag te verifiëren en eventuele ontbrekende of inconsistente gespreksgegevens voor specifieke klanten te identificeren.

Als u meer dan 200 klantenorganisaties beheert, pagineert de API de resultaten om de leesbaarheid te verbeteren.

De endpoint-URL van de Reconciliation API gebruikt de volgende indeling:

API-parameters

U kunt de API gebruiken om gespreksgegevens van de afgelopen 30 dagen op te halen. Het door u geselecteerde tijdvenster moet minstens 5 minuten vóór de huidige UTC-tijd beginnen en mag niet langer zijn dan 12 uur tussen de begin- en eindtijd in een enkele API-aanroep.

De API-parameters zijn:

• StartTime (vereist, tekenreeks) — De begindatum en -tijd (UTC) voor het eerste record dat u wilt verzamelen. Zorg ervoor dat:
  • U formatteert de tijd als YYYY-MM-DDTHH:MM:SS.mmmZ. Bijvoorbeeld 2025-08-15T06:00:00.000Z.
  • De startdatum en -tijd mogen niet ouder zijn dan 30 dagen vanaf de huidige UTC-tijd.
  • De periode tussen startTimeen endTimemag niet langer zijn dan 12 uur.
• EndTime (vereist, string) — De einddatum en -tijd (UTC) voor de records die u wilt verzamelen. De gegevens zijn gebaseerd op het tijdstip waarop het gesprek is voltooid. Zorg ervoor dat:
  • U formatteert de tijd als YYYY-MM-DDTHH:MM:SS.mmmZ. Bijvoorbeeld 2025-08-15T18:00:00.000Z.
  • De einddatum en -tijd moeten 5 minuten vóór de huidige UTC-tijd liggen en mogen niet ouder zijn dan 30 dagen.
  • De einddatum en -tijd moeten groter zijn dan de startTime.
  • De periode tussen de startTimeen endTimemag niet langer zijn dan 12 uur.

Voorbeeld van een JSON-antwoord voor een Reconciliation API-eindpunt:

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

De API-responskoppen geven aan hoeveel organisaties er in totaal zijn teruggestuurd en of er nog meer pagina's beschikbaar zijn. Controleer de volgende kopparameters om er zeker van te zijn dat u alle pagina's hebt opgevraagd:

• aantal pagina's: Totaal aantal pagina's (bijvoorbeeld 2)
• total-orgs: Totaal aantal organisaties dat in het antwoord is opgenomen (bijvoorbeeld 283)
• huidige pagina: Het huidige paginanummer (bijvoorbeeld 1)

Als de kopteksten bijvoorbeeld num-pages=2, total-orgs=283 en current-page=1 weergeven, bekijkt u de eerste pagina van een antwoord van twee pagina's dat in totaal 283 organisaties bevat. Om naar de volgende pagina te gaan, voegt u de parameter page=2 toe aan uw GET-aanvraag, zoals hieronder weergegeven:

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

Het Records API-eindpunt wordt gebruikt om ontbrekende gespreksrecords op te vragen voor specifieke organisaties waar discrepanties of ontbrekende gegevens zijn geïdentificeerd met behulp van de Reconciliation API.

Aanbevolen stroom: /v1/partners/cdrcountbyorgeerst bellen. Gebruik dan de exacte informatie orgIddie u hebt cdr_counts[].orgIdontvangen wanneer u belt /v1/partners/cdrsbyorg.

De Records API retourneert gespreksrecords in JSON-formaat, identiek aan het formaat dat wordt beschreven in de API voor gedetailleerde oproepgeschiedenis. De geretourneerde payload bevat velden die identiek zijn aan de geretourneerde payload met gedetailleerde oproepgeschiedenis. Zie het Webex Callinggedetailleerde rapport over de gespreksgeschiedenis voor meer informatie over de velden en hun waarden.

De API biedt gespreksgegevens die 5 minuten voor de huidige tijd zijn beëindigd. Om er zeker van te zijn dat alle gespreksgegevens beschikbaar zijn, raden we aan de API een uur na het door u gewenste tijdvenster te raadplegen.

De URL van het Records API-eindpunt gebruikt de volgende indeling:

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

API-parameters

• orgId(vereist, string) — De organisatie-ID van de klant waarvoor u gegevens wilt opvragen. De naam van de parameter is hoofdlettergevoelig. U kunt organisatie-ID's verkrijgen via het responsveld van de Reconciliation API cdr_counts[].orgId.
• StartTime (vereist, tekenreeks) — De begindatum en -tijd (UTC) voor het eerste record dat u wilt verzamelen. Zorg ervoor dat:
  • U formatteert de tijd als YYYY-MM-DDTHH:MM:SS.mmmZ. Bijvoorbeeld 2025-08-15T06:00:00.000Z.
  • De startdatum en -tijd mogen niet ouder zijn dan 30 dagen vanaf de huidige UTC-tijd.
  • Het interval tussen de startTimeen endTimemag niet langer zijn dan 12 uur in één API-aanvraag.
• EndTime (vereist, string) — De einddatum en -tijd (UTC) voor het laatste record dat u wilt verzamelen. De gegevens zijn gebaseerd op het tijdstip waarop het gesprek is voltooid. Zorg ervoor dat:
  • U formatteert de tijd als YYYY-MM-DDTHH:MM:SS.mmmZ. Bijvoorbeeld 2025-08-15T18:00:00.000Z.
  • De einddatum en -tijd moeten minstens 5 minuten vóór de huidige UTC-tijd liggen en mogen niet ouder zijn dan 30 dagen.
  • De einddatum en -tijd moeten groter zijn dan de startTime.
  • Het interval tussen de startTimeen endTimemag niet langer zijn dan 12 uur in één API-aanvraag.
• max (optioneel, aantal) — Beperkt het maximum aantal records per pagina in het antwoord. Zorg ervoor dat:
  • Het bereik varieert van 500 tot 5000. De standaardwaarde is 5000. Bijvoorbeeld max=1000.
  • Als de API meer records moet retourneren dan de opgegeven maximale waarde, dan wordt het antwoord gepagineerd.
  • Als een waarde lager dan 500 is gespecificeerd, wordt deze automatisch aangepast tot 500. Als een waarde hoger dan 5000 is gespecificeerd, wordt deze naar beneden bijgesteld naar 5000.

Paginering

Om vast te stellen of API-reacties gepagineerd zijn, controleert u in de antwoordkoppen of er een Link-header is. Als er een nextlink aanwezig is in de Link-header, pak die dan uit en gebruik de startTimeForNextFetchwaarde om de volgende reeks records aan te vragen. Als er geen volgende link is, dan worden alle rapporten voor de geselecteerde periode verzameld.

API-aanvragen voor volgende pagina's kunnen onmiddellijk worden gedaan, maar dit moet beperkt zijn tot maximaal 10 gepagineerde aanvragen per minuut, per tokenbereik.

Gebruik idempotente verwerking en deduplicatie wanneer u records ophaalt, onder meer over gepagineerde reacties of herhaalde afstemmingsperioden. Gebruik reportIdals primaire sleutel en reportTimeom het laatst verwerkte record te bepalen.

Als de initiële API-aanvraag bijvoorbeeld is:

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

dan is de koptekst van de link in het antwoord:

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

Bij de paginering wordt alleen de koptekst van de rel="next"link gebruikt. Als het antwoord een rel="next"link bevat, gebruik die URL dan om de volgende pagina met records op te halen. Als het antwoord geen rel="next"link bevat, hebt u alle beschikbare records voor de geselecteerde periode opgehaald.

U kunt rapporten genereren en downloaden die beschikbaar zijn in Partner Hub met behulp van de Partner Reports API's. Zie het partnerrapport/de sjablonen voor meer informatie.

Partners kunnen ook meerdere rapporten rechtstreeks vanuit de Partner Hub openen en downloaden. Zie de rapporten van de Partner Hub voor meer informatie.