I denne artikel
Oversigt
Opsæt en URL-adresse til webhook-tilbagekald
dropdown icon
Partner API-slutpunkter
    Afstemnings-API-slutpunkt
    Records API-slutpunkt
    Partner reports/templates API'en

Detaljerede webhooks for opkaldsregistreringer til Webex Calling i Partner Hub

list-menuI denne artikel
list-menuHar du feedback?

Webex Calling multi-tenant (MT)-partnere kan oprette en webhook til at indsamle Webex Calling-poster for alle dine kunder. Dette muliggør effektiv faktureringsafstemning, analyser og rapportering uden at det er nødvendigt at forespørge hver kunde individuelt.

Overblik

Webhooken med detaljerede opkaldsregistreringer tilbyder en sikker, skalerbar og robust løsning, der er drevet af hændelser snarere end anmodninger. Denne webhook giver større indsigt i dine kunders Webex Calling-aktiviteter og understøtter brugsscenarier fra fakturering til skræddersyet rapportering.

Du kan bruge denne webhook til nemt at indsamle poster for alle kunder, der administreres via Partner Hub, uden at skulle forespørge hver kunde individuelt. Denne webhook giver dig mulighed for at udvikle brugerdefinerede rapporterings-, fakturerings- og analyseapplikationer til både interne forretningskrav og værdiskabende tjenester.

For en introduktion til webhooken og dens tilhørende API'er, se denne Vidcast: Webex-opkaldspartners detaljerede opkaldshistorik-API.

Hvad Partner-webhooken leverer

Webhooken leverer detaljerede opkaldshistorikoptegnelser hvert 5. minut. Hver webhook-nyttelast indeholder:

  • Opkaldsoptegnelser, der sluttede mellem 10 minutter og 5 minutter før det aktuelle tidspunkt.
  • Alle forsinkede optegnelser, der behandles af Webex Calling Cloud.
  • Udfylder automatisk forsinkede opkaldsposter i de efterfølgende webhook-nyttelaster for at sikre pålidelig levering.

For at vise, hvordan opkaldsposter er inkluderet i hver data, kan du se følgende eksempel:

  • En nyttelast modtaget kl. 14:05 indeholder opkald, der sluttede mellem 13:55 og 14:00.
  • Opkald der slutter mellem 14:00 og 14:05 er inkluderet i 14:10 nyttelast.
  • Optegnelser, der er afsluttet tidligere (f.eks. et opkald, der sluttede kl. 14:04) men behandlet sent af Webex Calling Cloud (for eksempel kl. 14:11) er inkluderet i den næste planlagte nyttelast (for eksempel 14:15).

Webhooks leverer pålideligt poster. Du kan dog modtage dubletter i efterfølgende webhook-nyttelaster, når systemet afspiller poster under visse betingelser. Du er ansvarlig for at håndtere deduplikering af poster. For at identificere dublerede poster skal du bruge feltet reportId som primærnøgle og feltet reportTime til at bestemme, hvornår et kald blev fuldført eller behandlet. Brug disse felter til at opdatere eller indsætte posterne i dine interne datalagre.

Webhook i Partner Hub

Ved at angive en webhook gør du det muligt for analyseplatformen at sende opkaldsposter til din callback-URL, når de genereres.

Webex-opkaldsposter leveres i samme format som de eksisterende Detaljerede opkaldspost-API'er. Du kan oprette en webhook og vælge mellem to typer feeds:

  • Analyse – Omfatter alle opkaldsposter for alle kundeorganisationer, som partneren har en Webex Calling-relation med. Dette omfatter organisationer, hvor:
    • Partneren administrerer kundeorganisationen med rollen som partneradministrator.
    • Kundeorganisationen har et aktivt Webex Calling-abonnement i partnerorganisationen.
  • Fakturering – Omfatter opkaldsposter for opkald foretaget af brugere med en Webex Calling-licens, der er solgt og klargjort af partneren. Opkaldsposter for arbejdsområder er inkluderet i dette feed.

Adgang og databeskyttelse

Kun den ejerende partner kan få adgang til opkaldsdetaljeposter (CDR) til fakturering.

  • En partner (eller underpartner), der administrerer den licens, der er knyttet til opkaldsposten, bliver den ejerende partner.
  • Ejerskab bestemmes af: Bruger-ID > Licens-ID > Abonnements-ID > Partner-ID.
  • Hver CDR er tilgængelig for én partner.
  • Nogle opkaldsposter er ikke knyttet til en faktureringspartner, og ikke alle partnere, der er tilknyttet en organisation, har lige adgang til alle poster, da disse poster kan indeholde personligt identificerbare oplysninger (PII).

Opsæt en URL-adresse til webhook-tilbagekald

Konfigurer webhooken i Partner Hub. Du kan kun oprette én webhook pr. partnerorganisation.

Sørg for, at du har rollen som partner som fuld administrator med 'Organisatorisk fuld administratoradgang' og Webex Calling CDR API-adgang markeret i Control Hub (under Administration > Brugere, vælg en fuld administrator eller en fuld partneradministrator, og vælg derefter Administratorroller > Partner).

Skærmbillede, der viser indstillinger for administratorroller med partneradministrator og fuld partneradministrator valgt, sammen med Webex Calling CDR API-adgang markeret under funktionelle indstillinger.

1

Log ind på Partner Hub.

2

Gå til Organisationsindstillinger > Opkaldsdetaljer.

Skærmbillede af organisationsindstillinger for opkaldsdetaljeposter, der viser felter for Webhook-URL, hemmelig token og ressourcetype med Analytics valgt.
3

Indtast en URL, der skal bruges under Webhook.

URL'en skal slutte med /webhook (for eksempel, https://yourdomain.com/webhook).
4

Hvis du vil godkende dine webhook-nyttelaster med et hemmeligt token, kan du tilføje et. For at finde mere information om Webex webhooks og hemmelige tokens, se Webex for udviklere: Webhooks.

5

Vælg en af følgende Ressourcetype til brug for webhooken:

  • Analyse– Omfatter alle opkaldsposter for alle kundeorganisationer, som partneren har en Webex Calling-relation med.
  • Fakturering– Inkluderer opkaldsposter for brugere, som partneren solgte Webex Calling-licenser til. Opkaldsposter for arbejdsområder er inkluderet i dette feed.

Partner API-slutpunkter

Ud over webhooken leverer Webex Calling API-slutpunkter til at understøtte dataafstemning. Disse slutpunkter giver dig mulighed for at indhente eller afstemme dine datalagre med eventuelle manglende poster, som din webhook-lytter muligvis ikke har modtaget. De to API-slutpunkter er Afstemnings-API'en og Records-API'en.

Poster fra disse API'er er tilgængelige i 30 dage. For at sikre, at du modtager alle forventede optegnelser, anbefaler vi, at du afstemmer dine optegnelser med jævne mellemrum, f.eks. hver 12. eller 24. time.

Du skal bruge et partneradgangstoken for at få adgang til disse API'er. Hent og administrer dit partneradgangstoken i henhold til standard Webex Developer-adgangstokenadministrationspraksis.

API-vinduesintervaller gælder for begge slutpunkter for bedre at håndtere tjenestebelastningen.

  • For tidsintervaller på over 48 timer er den maksimalt tilladte vinduesvarighed 12 timer (anbefalet og håndhævet).
  • For tidsintervaller på 48 timer eller mindre er den maksimalt tilladte vinduesvarighed 48 timer (anbefales ikke; denne mulighed udfases fra den 30. januar 2026).
  • For et partnerorganisations-ID er API'erne hastighedsbegrænset til én indledende API-anmodning pr. minut pr. token-område. Hvis paginering anvendes, er op til 10 yderligere paginerede API-anmodninger pr. minut pr. token tilladt, og disse kan foretages umiddelbart efter den oprindelige anmodning.

Afstemnings-API-slutpunkt

Afstemnings-API-slutpunktet returnerer det samlede antal opkaldsposter, der er genereret for hver kunde, der administreres af partneren inden for den angivne tidsperiode. Du kan bruge disse totaler til at verificere din lokale lagring og identificere eventuelle manglende eller inkonsistente opkaldsposter for bestemte kunder.

Hvis du administrerer mere end 200 kundeorganisationer, paginerer API'en resultaterne for at forbedre læsbarheden.

URL'en for afstemnings-API'ens slutpunkt bruger følgende format:

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

API-parametre

Du kan bruge API'en til at hente opkaldsregistreringer fra de sidste 30 dage. Dit valgte tidsvindue skal starte mindst 5 minutter før den aktuelle UTC-tid og må ikke overstige 12 timer mellem start- og sluttidspunktet i et enkelt API-kald.

API-parametrene er:

  • startTime (påkrævet, streng) – Startdatoen og -tidspunktet (UTC) for den første post, du vil indsamle. Sørg for at:
    • Du formaterer tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel, 2025-08-15T06:00:00.000Z.
    • Startdatoen og -tidspunktet må ikke være ældre end 30 dage fra den aktuelle UTC-tid.
    • Vinduet mellem startTime og endTime må ikke overstige 12 timer.
  • endTime (påkrævet, streng) – Slutdatoen og -tidspunktet (UTC) for de poster, du vil indsamle. Optegnelser er baseret på rapporteringstidspunkt, hvilket er det tidspunkt, hvor opkaldet er afsluttet. Sørg for at:
    • Du formaterer tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel, 2025-08-15T18:00:00.000Z.
    • Slutdatoen og -tidspunktet skal være 5 minutter før den aktuelle UTC-tid og ikke ældre end 30 dage.
    • Slutdatoen og -tidspunktet skal være større end startTime.
    • Vinduet mellem startTime og endTime må ikke overstige 12 timer.

Eksempel på et JSON-svar for et afstemnings-API-slutpunkt:


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

API-svarheaderne angiver det samlede antal returnerede organisationer, og om der er yderligere sider tilgængelige. Kontrollér følgende headerparametre for at sikre, at du har forespurgt alle sider:

  • antal sider: Samlet antal sider (f.eks. 2)
  • total-organisationer: Samlet antal organisationer inkluderet i svaret (for eksempel 283)
  • nuværende side: Det aktuelle sidetal (for eksempel 1)

Hvis overskrifterne f.eks. viser num-pages=2, total-orgs=283, og current-page=1, Du ser den første side af et to-siders svar, der indeholder i alt 283 organisationer. For at få adgang til den næste side skal du tilføje page=2 parameter til din GET-anmodning, som vist nedenfor:

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

Records API-slutpunkt

Records API-slutpunktet bruges til at forespørge på manglende opkaldsposter for specifikke organisationer, hvor der blev identificeret uoverensstemmelser eller manglende data ved hjælp af Reconciliation API'en.

Records API'en returnerer opkaldsposter i JSON-format, identisk med det format, der er beskrevet i Detailed Call History API. Den returnerede nyttelast indeholder identiske felter som den returnerede nyttelast af typen Detaljeret opkaldshistorik. For mere information om felterne og deres værdier, se Webex Calling Detaljeret opkaldshistorikrapport.

API'en leverer opkaldsregistreringer, der sluttede 5 minutter før det aktuelle tidspunkt. For at sikre at alle opkaldsregistreringer er tilgængelige, anbefaler vi at du forespørger API'en en time efter dit foretrukne tidsvindue.

URL'en for Records API-slutpunktet bruger følgende format:

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

  • OrgID (påkrævet, streng) – Det organisations-ID, som du vil hente poster for. Du kan hente organisations-id'er fra afstemnings-API'en.
  • startTime (påkrævet, streng) – Startdatoen og -tidspunktet (UTC) for den første post, du vil indsamle. Sørg for at:
    • Du formaterer tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel, 2025-08-15T06:00:00.000Z.
    • Startdatoen og -tidspunktet må ikke være ældre end 30 dage fra den aktuelle UTC-tid.
    • Intervallet mellem startTime og endTime må ikke overstige 12 timer i en enkelt API-anmodning.
  • endTime (påkrævet, streng) – Slutdatoen og -tidspunktet (UTC) for den sidste post, du vil indsamle. Optegnelser er baseret på rapporteringstidspunkt, hvilket er det tidspunkt, hvor opkaldet er afsluttet. Sørg for at:
    • Du formaterer tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel, 2025-08-15T18:00:00.000Z.
    • Slutdatoen og -tidspunktet skal være mindst 5 minutter før den aktuelle UTC-tid og ikke ældre end 30 dage.
    • Slutdatoen og -tidspunktet skal være større end startTime.
    • Intervallet mellem startTime og endTime må ikke overstige 12 timer i en enkelt API-anmodning.
  • Maks. (valgfrit, antal) – Begrænser det maksimale antal poster pr. side i svaret. Sørg for at:
    • Intervallet er fra 500 til 5000. Standardværdien er 5000. For eksempel, Max=1000.
    • Hvis API'en har flere poster at returnere end den angivne maksimumsværdi, pagineres svaret.
    • Hvis der angives en værdi under 500, justeres den automatisk op til 500. Hvis der angives en værdi over 5000, justeres den ned til 5000.

Sideinddeling

For at identificere, om API-svar er paginerede, skal du kontrollere svarheaderne for en linkheader. Hvis der findes et next -link i linkheaderen, skal du udtrække det og bruge værdien startTimeForNextFetch til at anmode om det næste sæt poster. Hvis der ikke er noget næste link, indsamles alle rapporter for det valgte tidsinterval.

API-anmodninger til efterfølgende sider kan foretages med det samme, men skal være begrænset til maksimalt 10 paginerede anmodninger pr. minut pr. token-område.

For eksempel, hvis den oprindelige API-anmodning er:

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

så er linkheaderen i svaret:

; rel="next"

Andre mulige linkværdier inkluderer rel="first" og rel="prev" for henholdsvis den første og forrige side.

Paginering for denne API følger RFC5988-standarden (Web Linking). For mere information, se REST API-grundlæggende.

Partner reports/templates API'en

Du kan generere og downloade rapporter, der er tilgængelige i Partner Hub, ved hjælp af Partner Reports API'er. For yderligere information, se partner report/templates.

Partnere kan også få adgang til og downloade flere rapporter direkte fra Partner Hub. For yderligere information, se Partner Hub-rapporter.

Var denne artikel nyttig?
Var denne artikel nyttig?