In dit artikel
Overzicht
Een webhookteterugroep-URL instellen
dropdown icon
Partner API-eindpunten
    Eindpunt van de verzoenings-API
    Eindpunt van de API voor records
    Partner reports/templates API

Gedetailleerde webhook voor oproepregistratie voor Webex Calling in Partner Hub

list-menuIn dit artikel
list-menuFeedback?

Multi-tenant (MT)-partners van Webex Calling kunnen een webhook instellen om Webex Calling-records voor al uw klanten te verzamelen. Hierdoor is efficiënte afstemming van facturen, analyses en rapportage mogelijk zonder dat u elke klant afzonderlijk hoeft te raadplegen.

Overzicht

De webhook Gedetailleerde oproepregistraties biedt een veilige, schaalbare en robuuste oplossing die wordt aangestuurd door gebeurtenissen in plaats van verzoeken. Deze webhook biedt meer inzicht in de Webex Calling-activiteiten van uw klanten en ondersteunt use cases variërend van facturering tot op maat gemaakte rapportages.

Met deze webhook kunt u op een eenvoudige manier records verzamelen voor alle klanten die via Partner Hub worden beheerd, zonder dat u elke klant afzonderlijk hoeft te raadplegen. Met deze webhook kunt u aangepaste rapportage-, facturerings- en analysetoepassingen ontwikkelen voor zowel interne bedrijfsvereisten als diensten met toegevoegde waarde.

Bekijk deze Vidcast voor een introductie tot de webhook en de bijbehorende API's: Gedetailleerde gespreksgeschiedenis API van Webex Calling Partner.

Wat de Partner webhook levert

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

  • Gespreksopnames die tussen 10 en 5 minuten vóór het huidige tijdstip zijn beëindigd.
  • Te laat verwerkte records door de Webex Calling-cloud.
  • Vult automatisch late oproepgegevens in de daaropvolgende webhook-payloads in om een betrouwbare levering te garanderen.

Om te laten zien hoe oproeprecords in elke payload worden opgenomen, kunt u het volgende voorbeeld bekijken:

  • Een lading ontvangen op 14:05 bevat oproepen die eindigden tussen 13:55 En 14:00.
  • Gesprekken eindigend tussen 14:00 En 14:05 zijn opgenomen in de 14:10 lading.
  • Eerder voltooide gegevens (bijvoorbeeld een gesprek dat eindigde om 14:04) maar laat verwerkt door Webex Calling cloud (bijvoorbeeld op 14:11) zijn opgenomen in de volgende geplande payload (bijvoorbeeld, 14:15).

De webhooks leveren op betrouwbare wijze records. Het is echter mogelijk dat u dubbele records ontvangt in latere webhook-payloads wanneer het systeem records onder bepaalde omstandigheden opnieuw afspeelt. U bent verantwoordelijk voor het verwijderen van dubbele records. Om dubbele records te identificeren, gebruikt u het veld reportId als primaire sleutel en het veld reportTime om te bepalen wanneer een oproep is voltooid of verwerkt. Met deze velden kunt u de records in uw interne gegevensopslag bijwerken of toevoegen.

Webhook in Partner Hub

Door een webhook te verstrekken, kan het analyseplatform oproeprecords naar uw callback-URL sturen wanneer deze worden gegenereerd.

Webex Calling-records worden geleverd met dezelfde indeling als de bestaande Gedetailleerde oproeprecords-API's. U kunt een webhook instellen en kiezen tussen twee soorten feeds:

  • Analytics: bevat alle gespreksgegevens voor alle klantorganisaties waarmee de partner een Webex Calling-relatie heeft. Dit omvat organisaties waar:
    • De partner beheert de klantorganisatie met de rol Partner Full Administrator.
    • De klantorganisatie heeft een actief Webex Calling-abonnement binnen de partnerorganisatie.
  • Facturering: bevat gespreksgegevens van gebruikers met een Webex Calling-licentie die door de partner is verkocht en ingericht. In deze feed zijn oproepgegevens voor werkruimten opgenomen.

Toegang en gegevensprivacy

Alleen de eigenaar heeft toegang tot Call Detail Records (CDR) voor facturering.

  • De partner (of subpartner) die de licentie beheert die aan de oproepregistratie is gekoppeld, wordt de eigenaarpartner.
  • Het eigendom wordt bepaald door: Gebruikers-ID > Licentie-ID > Abonnements-ID > Partner-ID.
  • Elke CDR is toegankelijk voor één enkele partner.
  • Sommige oproeprecords kunnen niet worden gekoppeld aan een factureringspartner. Bovendien hebben niet alle partners die aan een organisatie zijn gekoppeld, gelijke toegang tot alle records, aangezien deze records persoonlijk identificeerbare informatie (PII) kunnen bevatten.

Een webhookteterugroep-URL instellen

Configureer de webhook in de Partner Hub. U kunt slechts één webhook per partnerorganisatie instellen.

Zorg ervoor dat u de volledige beheerdersrol van Partner hebt met 'Toegang op volledig beheerdersniveau voor de organisatie' en Webex Calling CDR API-toegang aangevinkt in Control Hub (onder Beheer > Gebruikers, selecteer een volledige beheerder of partner volledige beheerder en selecteer vervolgens Beheerdersrollen > Partner).

Schermafbeelding van de instellingen voor beheerdersrollen waarbij Partnerbeheerder en Partnerbeheerder volledig zijn geselecteerd en Webex Calling CDR API-toegang is aangevinkt onder Functionele instellingen.

1

Meld u aan bij Partner Hub.

2

Ga naar Organisatie-instellingen > Gespreksdetailrecords.

Schermafbeelding van organisatie-instellingen voor oproepdetailrecords, met velden voor Webhook-URL, Geheim token en Resourcetype, met Analytics geselecteerd.
3

Voer een URL in die u wilt gebruiken onder Webhook.

De URL moet eindigen op /webhook (Bijvoorbeeld, https://yourdomain.com/webhook).
4

Als u uw webhook-payloads wilt verifiëren met een geheim token, kunt u er een toevoegen. Voor meer informatie over Webex-webhooks en geheime tokens, zie Webex voor ontwikkelaars: Webhooks.

5

Selecteer een van de volgende Resourcetype om te gebruiken voor de webhook:

  • Analytics— Bevat alle oproeprecords voor alle klantorganisaties waarmee de partner een Webex Calling-relatie heeft.
  • Facturering— Bevat gespreksgegevens voor gebruikers aan wie de partner Webex Calling-licenties heeft verkocht. In deze feed zijn oproepgegevens voor werkruimten opgenomen.

Partner API-eindpunten

Naast de webhook biedt Webex Calling API-eindpunten ter ondersteuning van gegevensafstemming. Met deze eindpunten kunt u uw gegevensopslag bijwerken of afstemmen op eventuele ontbrekende records die uw webhook-listener mogelijk niet heeft ontvangen. De twee API-eindpunten zijn de Reconciliation API en de Records API.

Records van deze API's zijn 30 dagen beschikbaar. Om ervoor te zorgen dat u alle verwachte gegevens ontvangt, adviseren wij u om uw gegevensopslag periodiek af te stemmen, bijvoorbeeld elke 12 of 24 uur.

Voor toegang tot deze API's moet u een partnertoegangstoken gebruiken. Verkrijg en beheer uw partnertoegangstoken volgens de standaard Webex Developer-toegangstokenbeheerpraktijken.

API-vensterbereiken zijn van toepassing op beide eindpunten om de servicebelasting beter te verwerken.

  • Voor tijdsperioden groter dan 48 uur bedraagt de maximaal toegestane vensterduur 12 uur (aanbevolen en gehandhaafd).
  • Voor tijdsperioden van 48 uur of korter bedraagt de maximaal toegestane vensterduur 48 uur (niet aanbevolen; deze optie is vanaf 30 januari 2026 niet meer beschikbaar).
  • Voor een partnerorganisatie-ID zijn de API's beperkt tot één eerste API-aanvraag per minuut, per tokenbereik. Als paginering wordt gebruikt, zijn maximaal 10 extra gepagineerde API-verzoeken per minuut per token toegestaan. Deze kunnen direct na het eerste verzoek worden gedaan.

Eindpunt van de verzoenings-API

Het eindpunt van de Reconciliatie-API retourneert het totale aantal oproeprecords dat is gegenereerd voor elke klant die door de partner wordt beheerd binnen de opgegeven periode. U kunt deze totalen gebruiken om uw lokale opslag te controleren en ontbrekende of inconsistente oproeprecords voor specifieke klanten te identificeren.

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

De eindpunt-URL van de Reconciliatie-API gebruikt de volgende indeling:

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

API-parameters

Met de API kunt u oproepgegevens van de afgelopen 30 dagen ophalen. Het door u geselecteerde tijdsvenster moet minimaal 5 minuten vóór de huidige UTC-tijd beginnen en er mag niet meer dan 12 uur zitten tussen de start- en eindtijd in één API-aanroep.

De API-parameters zijn:

  • startTime (vereist, tekenreeks) — De startdatum en -tijd (UTC) voor de eerste record die 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 venster tussen startTime en endTime mag niet langer zijn dan 12 uur.
  • endTime (vereist, tekenreeks) — De einddatum en -tijd (UTC) voor de records die u wilt verzamelen. Registraties zijn gebaseerd op het tijdstip van melden, dat wil zeggen het tijdstip waarop het gesprek is beëindigd. 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 startTime.
    • Het venster tussen startTime en endTime mag niet langer zijn dan 12 uur.

Voorbeeld van een JSON-respons van 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-responsheaders geven het totale aantal geretourneerde organisaties aan en of er aanvullende pagina's beschikbaar zijn. Controleer de volgende headerparameters om er zeker van te zijn dat u alle pagina's hebt opgevraagd:

  • aantal pagina's: Totaal aantal pagina's (bijvoorbeeld 2)
  • totale-orgs: Totaal aantal organisaties opgenomen in de respons (bijvoorbeeld 283)
  • huidige pagina: Het huidige paginanummer (bijvoorbeeld 1)

Als de headers bijvoorbeeld het volgende laten zien: num-pages=2, total-orgs=283, En current-page=1, U bekijkt de eerste pagina van een reactie van twee pagina's met in totaal 283 organisaties. Om toegang te krijgen tot de volgende pagina, voegt u de page=2 parameter aan uw GET-verzoek toe, 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

Eindpunt van de API voor records

Het Records API-eindpunt wordt gebruikt om ontbrekende oproeprecords op te vragen voor specifieke organisaties waarbij discrepanties of ontbrekende gegevens zijn geïdentificeerd via de Reconciliation API.

De Records API retourneert oproeprecords in JSON-formaat, identiek aan het formaat dat wordt beschreven in de Gedetailleerde oproepgeschiedenis API. De geretourneerde payload bevat identieke velden als de geretourneerde payload Gedetailleerde oproepgeschiedenis. Voor meer informatie over de velden en hun waarden, zie Webex Calling Gedetailleerd gespreksgeschiedenisrapport.

De API levert oproepgegevens die 5 minuten vóór de huidige tijd zijn beëindigd. Om ervoor te zorgen dat alle oproepgegevens beschikbaar zijn, raden we aan de API één uur na het door u gewenste tijdsbestek te raadplegen.

De eindpunt-URL van de Records API 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 (verplicht, tekenreeks): de organisatie-ID waarvan u records wilt ophalen. U kunt organisatie-ID's verkrijgen via de Reconciliation API.
  • startTime (vereist, tekenreeks) — De startdatum en -tijd (UTC) voor de eerste record die 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 startTime en endTime mag niet langer zijn dan 12 uur in één API-aanvraag.
  • endTime (verplicht, tekenreeks) — De einddatum en -tijd (UTC) voor de laatste record die u wilt verzamelen. Registraties zijn gebaseerd op het tijdstip van melden, dat wil zeggen het tijdstip waarop het gesprek is beëindigd. 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 minimaal 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 startTime.
    • Het interval tussen startTime en endTime mag niet langer zijn dan 12 uur in één API-aanvraag.
  • Max (optioneel, getal) — Beperkt het maximale aantal records per pagina in het antwoord. Zorg ervoor dat:
    • Het bereik ligt tussen 500 en 5000. De standaardwaarde is 5000. Bijvoorbeeld, Max=1000.
    • Als de API meer records moet retourneren dan de opgegeven Max-waarde, wordt het antwoord gepagineerd.
    • Indien een waarde lager dan 500 wordt opgegeven, wordt deze automatisch aangepast naar 500. Indien een waarde boven de 5000 wordt opgegeven, wordt deze naar beneden bijgesteld naar 5000.

Paginering

Om te bepalen of API-reacties gepagineerd zijn, controleert u de reactieheaders op een Link-header. Als er een next -koppeling in de Link-header aanwezig is, extraheer deze dan en gebruik de startTimeForNextFetch -waarde om de volgende set records op te vragen. Als er geen volgende link is, worden alle rapporten voor het geselecteerde tijdsbestek verzameld.

API-verzoeken voor volgende pagina's kunnen onmiddellijk worden gedaan, maar moeten worden beperkt tot maximaal 10 paginaverzoeken per minuut, per tokenbereik.

Als het eerste API-verzoek bijvoorbeeld:

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 Link-header in het antwoord:

; rel="next"

Andere mogelijke linkwaarden zijn rel="first" en rel="prev" voor respectievelijk de eerste en vorige pagina.

De paginering voor deze API voldoet aan de RFC5988-standaard (Web Linking). Voor meer informatie, zie REST API Basics.

Partner reports/templates API

U kunt rapporten genereren en downloaden die beschikbaar zijn in Partner Hub met behulp van de Partner Reports API's. Voor meer informatie, zie de partner report/templates.

Partners kunnen ook rechtstreeks vanuit Partner Hub toegang krijgen tot meerdere rapporten en deze downloaden. Voor meer informatie, zie Partner Hub-rapporten.

Vond u dit artikel nuttig?
Vond u dit artikel nuttig?