- Hjem
- /
- Artikel
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, analyse og rapportering uden at skulle forespørge hver kunde individuelt.
Oversigt
Webhook for detaljerede opkaldsregistreringer tilbyder en sikker, skalerbar, og robust løsning drevet af begivenheder snarere end anmodninger. Denne webhook giver større synlighed i dine kunders Webex Calling aktiviteter og understøtter brugssager fra fakturering til skræddersyet rapportering.
Du kan bruge denne webhook til at indsamle poster bekvemt for alle kunder, der administreres via Partner Hub uden at spørge hver kunde individuelt. Denne webhook giver dig mulighed for at udvikle brugerdefineret rapportering, fakturering, og analytiske applikationer til både interne forretningskrav og merværditjenester.
For en introduktion til webhook og dens ledsagende API'er, se denne Vidcast: Webex Calling Partner Detailed Call History API.
Hvad Partner webhook leverer
Webhook leverer detaljerede opkaldshistorikoptegnelser hver 5 minutter. Hver webhook nyttelast indeholder:
- Opkaldsoptegnelser, der sluttede mellem 10 minutter og 5 minutter før det aktuelle tidspunkt.
- Eventuelle sene optegnelser behandlet af Webex Calling skyen.
- Udfylder automatisk sene opkaldsoptegnelser i de efterfølgende webhook-nyttelaster for at sikre pålidelig levering.
Hvis du vil vise, hvordan opkaldsposter er inkluderet i hver nyttelast, skal du overveje følgende eksempel:
- En nyttelast modtaget kl. 14:05 indeholder opkald, der sluttede mellem 13:55 og 14:00.
- Opkald, der slutter mellem kl. 14.00 og 14.05, er inkluderet i nyttelasten 14:10.
- Optegnelser, der er gennemført tidligere (f.eks. et opkald, der sluttede kl. 14:04), men behandlet sent af Webex Calling skyen (f.eks. kl. 14:11), medtages i den næste planlagte nyttelast ( f.eks. 14:15).
Webhooks leverer pålideligt optegnelser. Du kan dog modtage duplikatposter i efterfølgende webhook-nyttelaster, når systemet genoptager poster under visse betingelser. Du er ansvarlig for at håndtere deduplikering af poster. Hvis du vil identificere duplikatposter, skal du bruge feltet Re portID som primærnøgle og feltet ReportTime til at bestemme, hvornår et opkald blev gennemført eller behandlet. Brug disse felter til at opdatere eller indsætte posterne i dine interne datalagre.
Webhook i Partner Hub
Ved at levere en webhook giver du analyseplatformen mulighed for at sende opkaldsoptegnelser til din tilbagekaldelsesadresse, når de genereres.
Webex Callingposter leveres i samme format som de eksisterende API'er for detaljerede opkaldsoptegnelser. Du kan oprette en webhook og vælge mellem to typer feed:
- Analyse — Omfatter alle opkaldsposter for alle kundeorganisationer, som partneren har et Webex Calling forhold til. Dette omfatter organisationer, hvor:
- Partneren administrerer kundeorganisationen med rollen Fuld Partner Administrator.
- Kundeorganisationen har et aktivt Webex Calling abonnement inden for partnerorganisationen.
- Fakturering — Omfatter opkaldsoptegnelser for opkald foretaget af brugere med en Webex Calling licens, der er solgt og leveret af partneren. Opkaldsposter for arbejdsområder er inkluderet i dette feed.
Adgang og databeskyttelse
Kun den ejende partner kan få adgang til Call Detail Records (CDR) til fakturering.
- En partner (eller underpartner), der administrerer den licens, der er knyttet til opkaldsposten, bliver ejerpartner.
- Ejerskabet bestemmes af: Bruger-id > Licens-id > Abonnements-id > Partner -id.
- Hver CDR er tilgængelig for en enkelt partner.
- Nogle opkaldsposter knyttes ikke til en faktureringspartner, og ikke alle partnere, der er tilknyttet en organisation, får lige adgang til alle poster, da disse poster kan indeholde personligt identificerbare oplysninger (PII).
Opsæt en webhook-tilbagekalds-URL
Konfigurer webhook'en i Partner Hub. Du kan kun oprette én webhook pr. partner organisation.
Sørg for, at du har den fulde administratorrolle Partner med „Fuld adgang til administrator niveau for organisationer“ og markeret i Control Hub (under Administr ation > gere skal du vælge en fuld administrator eller fuldgyldig partner administrator og derefter vælge Administratorroller > Partner).
De samme adgangskrav gælder, når du bruger API'erne for partnerafstemning og poster.
| 1 |
Log ind på Partner Hub. |
| 2 |
Gå til .
|
| 3 |
Indtast en URL, der skal bruges under Webhook. Webadressen skal slutte med /webhook (f.eks. https://yourdomain.com/webhook).
|
| 4 |
Hvis du gerne vil godkende dine webhook-nyttelaster med et hemmeligt token, kan du tilføje en. Du kan finde flere oplysninger om Webex webhooks og hemmelige tokens under Webex til udviklere: Webhooks. |
| 5 |
Vælg en af følgende ressourcetype, der skal bruges til webhook'en:
|
Partner API-slutpunkter
Ud over webhooken, Webex Calling leverer API-slutpunkter til understøttelse af 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 Recon ction API og Records API.
Optegnelser fra disse API'er er tilgængelige i 30 dage. For at sikre, at du modtager alle forventede poster, anbefaler vi, at du afstemmer dine pladebutikker med jævne mellemrum, f.eks. Hver 12. eller 24. time.
Du skal bruge et partneradgangstoken for at få adgang til disse API'er. Den autentificerende bruger skal være en Partner Fuld Administrator med fuld adgang til administratorniveau for organisationen og skal have Webex CallingCDR API-adgang aktiver et. OAuth-tokenet skal indeholde omfanget spark-admin:calling_cdr_read. Skrivebeskyttede administratorroller er ikke tilstrækkelige til API'erne partnerafstemning og poster.
Brug slut analytics-callingpunktet til kundeorganisationens Webex Calling dataregion. Brug den relevante basiswebadresse til både Afstemnings- og Poster-API'erne:
- USA og Canada:
https://analytics-calling.webexapis.com - Europa:
https://analytics-calling-eu.webexapis.com - Indien:
https://analytics-calling-in.webexapis.com - Australien:
https://analytics-calling-au.webexapis.com
API-vinduesintervaller gælder for begge slutpunkter for bedre at håndtere servicebelastning.
- For tidsintervaller, der er større end 48 timer, er den maksimale tilladte vinduesvarighed 12 timer (håndhævet).
- For et partnerorganisations-id er API'erne hastighedsbegrænset til én indledende API-anmodning pr. minut pr. tokenomfang. Hvis der anvendes paginering, er op til 10 yderligere paginerede API-anmodninger pr. minut pr. token tilladt, og disse kan foretages umiddelbart efter den første 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 bekræfte dit lokale lager og identificere eventuelle manglende eller inkonsekvente opkaldsposter for bestemte kunder.
Adgangskrav: Den godkendende bruger skal være en partneradministrator med fuld adgang på administratorniveau og have Webex CallingCDR API-adgang aktiveret. Adgangstokenet skal indeholde spark-admin:calling_cdr_readomfanget.
Hvis du administrerer mere end 200 kundeorganisationer, paginerer API'en resultaterne for at forbedre læsbarheden.
Afstemnings-API-slutpunkts-URL'en 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 opkaldsoptegnelser fra de sidste 30 dage. Det 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-opkald.
API-parametrene er:
-
Starttid (påkrævet, streng) —Startdato og -klokkeslæt (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.
- Startdato og -klokkeslæt må ikke være ældre end 30 dage fra den aktuelle UTC-tid.
- Vinduet mellem
startTimeogendTimekan ikke overstige 12 timer.
- Du formaterer tiden som
-
EndTime (påkrævet, streng) —Slutdato og -klokkeslæt (UTC) for de poster, du vil indsamle. Optegnelser er baseret på rapporteringstid, hvilket er når opkaldet er udført. Sørg for, at:
- Du formaterer tiden som
YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel,2025-08-15T18:00:00.000Z. - Slutdato og -klokkeslæt skal være 5 minutter før den aktuelle UTC-tid og ikke ældre end 30 dage.
- Slutdato og klokkeslæt skal være større end
startTime. - Vinduet mellem
startTimeogendTimekan ikke overstige 12 timer.
- Du formaterer tiden som
Eksempel på et JSON-svar for 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-svaroverskrifterne angiver det samlede antal organisationer, der returneres, og om der er flere sider tilgængelige. Kontroller følgende sidehovedparametre for at sikre, at du har spurgt alle sider:
- num-pages: Samlet antal sider (f.eks. 2)
- total-orgs: Samlet antal organisationer inkluderet i svaret (for eksempel 283)
- current-page: Det aktuelle sidetal (f.eks. 1)
Hvis overskrifterne f.eks. viser num-pages=2, total-orgs=283 og current-page=1, ser du den første side i et svar på to sider, der indeholder 283 organisationer i alt. For at få adgang til den næste side skal du tilføje parameteren page=2 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
Registrerer API-slutpunkt
API-slutpunktet for poster bruges til at forespørge om manglende opkaldsposter for specifikke organisationer, hvor uoverensstemmelser eller manglende data blev identificeret ved hjælp af Afstemnings-API'en.
Anbefalet flow: Ring /v1/partners/cdrcountbyorgførst. Brug derefter det nøjagtige orgIdreturnerede, cdr_counts[].orgIdnår du ringer /v1/partners/cdrsbyorg.
API'en for poster returnerer opkaldsposter i JSON-format, identisk med det format, der er beskrevet i API'en Detaljeret opkaldshistorik. Den returnerede nyttelast indeholder identiske felter som den returnerede nyttelast i Detaljeret opkaldshistorik. Du kan finde flere oplysninger om felterne og deres værdier under Webex CallingDetaljeret opkaldshistorikrapport.
API'en giver opkaldsoptegnelser, der sluttede 5 minutter før det aktuelle tidspunkt. For at sikre, at alle opkaldsposter er tilgængelige, anbefaler vi, at du spørger API'en en time efter dit foretrukne tidsvindue.
URL-adressen til slutpunktet for Records API 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 kundeorganisations-id, som du vil hente poster for. Parameternavnet skelner mellem store og små bogstaver. Du kan hente organisations-id'er fra svarfeltet Afstemnings-APIcdr_counts[].orgId. -
Starttid (påkrævet, streng) —Startdato og -klokkeslæt (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. - Startdato og -klokkeslæt må ikke være ældre end 30 dage fra den aktuelle UTC-tid.
- Intervallet mellem
startTimeogendTimemå ikke overstige 12 timer i en enkelt API-anmodning.
- Du formaterer tiden som
-
EndTime (påkrævet, streng) —Slutdato og -klokkeslæt (UTC) for den sidste post, du vil indsamle. Optegnelser er baseret på rapporteringstid, hvilket er når opkaldet er udført. Sørg for, at:
- Du formaterer tiden som
YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel,2025-08-15T18:00:00.000Z. - Slutdato og -klokkeslæt skal være mindst 5 minutter før den aktuelle UTC-tid og ikke ældre end 30 dage.
- Slutdato og klokkeslæt skal være større end
startTime. - Intervallet mellem
startTimeogendTimemå ikke overstige 12 timer i en enkelt API-anmodning.
- Du formaterer tiden som
-
max (valgfrit, antal) —Begrænser det maksimale antal poster pr. side i svaret. Sørg for, at:
- Rækkevidden er fra 500 til 5000. Standardværdien er 5000. For eksempel,
max=1000. - Hvis API'en har flere poster, der skal returneres end den angivne maksimale væ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.
- Rækkevidden er fra 500 til 5000. Standardværdien er 5000. For eksempel,
Paginering
Hvis du vil identificere, om API-svar er pagineret, skal du kontrollere svaroverskrifterne for en Link-overskrift. Hvis der findes et nextlink i Link-overskriften, skal du udtrække det og bruge startTimeForNextFetchværdien 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 fremsættes med det samme, men skal begrænses til maksimalt 10 paginerede anmodninger pr. Minut, pr. tokenomfang.
Brug idempotent behandling og de-duplikering, når du henter poster, herunder på tværs af paginerede svar eller gentagne afstemningsvinduer. Brug reportIdsom primærnøgle og reportTimetil at bestemme den senest behandlede post.
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 Link-overskriften i svaret:
<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"
Paginering bruger kun rel="next"Link-overskriften. Hvis svaret indeholder et rel="next"link, skal du bruge denne webadresse til at hente den næste side med poster. Hvis svaret ikke indeholder et rel="next"link, har du hentet alle tilgængelige poster for det valgte tidsinterval.
Paginering for denne API følger RFC5988 (Web Linking) standarden. Du kan finde flere oplysninger i Grund læggende om REST API.
Forstå API-slutpunktsresponskoder
Dette afsnit indeholder en oversigt over almindelige svarkoder, der kan opstå, når du arbejder med afstemnings- API-slutpunktet og API-slutpunktet Records. Disse slutpunkter spiller en afgørende rolle i datasyn kronisering, validering og rapportering. Forståelse af disse svarkoder er afgørende for effektiv fejlfinding og for at opretholde pålidelige, stabile integrationer.
|
Svarkode |
Beskrivelse af svarkode |
|---|---|
|
200 |
OK |
|
400 |
Dårlig anmodning: An modningen var ugyldig eller kan ikke leveres på anden måde. En medfølgende fejlmeddelelse vil forklare yderligere. |
|
401 |
Uautoriseret: Godkendelseslegitimationsoplysninger manglede eller var forkerte. |
|
403 |
Forbudt: Anmodningen forstås, men den er blevet afvist, eller adgang er ikke tilladt. |
|
404 |
Ikke fundet: Den anmodede URI er ugyldig, eller den ønskede ressource, f.eks. en bruger, findes ikke. Returneres også, når det ønskede format ikke understøttes af den ønskede metode. |
|
405 |
Metode ikke tilladt: Anmodningen blev foretaget til en ressource ved hjælp af en HTTP-anmodningsmetode, der ikke understøttes. |
|
409 |
Konflikt: Anmodningen kunne ikke behandles, fordi den er i konflikt med en eller anden etableret regel i systemet. For eksempel kan en person ikke føjes til et værelse mere end én gang. |
|
410 |
Bor te: Den ønskede ressource er ikke længere tilgængelig. |
|
415 |
Ikke-understøttet mediety pe: Anmodningen blev foretaget til en ressource uden at angive en medietype eller brugte en medietype, der ikke understøttes. |
|
423 |
Låst: Den anmodede ressource er midlertidigt utilgængelig. Der kan være en Retry-After-overskrift, der angiver, hvor mange sekunder du skal vente, før du forsøger anmodningen igen. |
|
428 |
Forudsætning påkrævet: Fil (er) kan ikke scannes for malware og skal tvinges downloadet. |
|
429 |
For mange anmodninger: Der er sendt for mange anmodninger inden for et givet tidsrum, og anmodningen er blevet begrænset. En Retry-After-overskrift skal være til stede, der angiver, hvor mange sekunder du skal vente, før en vellykket anmodning kan foretages. |
|
451 |
Som standard dirigeres anmod |
|
500 |
Intern serverfejl: Noget gik galt på serveren. Hvis problemet fortsætter, er du velkommen til at kontakte [Webex Developer Support team] (/explore/support). |
|
502 |
Dårlig gateway: Serveren modtog et ugyldigt svar fra en opstrømsserver under behandlingen af anmodningen. Prøv igen senere. |
|
503 |
Tjenesten er ikke tilgængelig: Serveren er overbelastet med anmodninger. Prøv igen senere. |
|
504 |
Gateway Timeout: En opstrømsserver kunne ikke reagere til tiden. Hvis din forespørgsel bruger max parameter, prøv at reducere den. |
API for partnerrapporter/skabeloner
Du kan generere og downloade rapporter, der er tilgængelige i Partner Hub, ved hjælp af API'erne for partnerrapporter. Du kan finde flere oplysninger i partnerrapporten/skabelonerne.
Partnere kan også få adgang til og downloade flere rapporter direkte fra Partner Hub. Du kan finde flere oplysninger i Partner Hub-rapporter.
Revisionshistorik
Dokumentrevisionshistorik
|
Revisionsdato |
Vi har foretaget følgende ændringer i artiklen |
|---|---|
|
13/08/26 |
|
|
2/04/2026 |
|