I denne artikkelen
Oversikt
Sett opp en webhook-tilbakeringingsnettadresse
dropdown icon
Partner API-endepunkter
    Avstemmings-API-endepunkt
    Registrerer API-endepunkt
Forstå API-endepunktsresponskoder
API for partnerrapporter/maler
Revisjonshistorikk
Detaljert webhook for anropsoppføringer for Webex Calling i Partner Hub
list-menuI denne artikkelen
list-menuTilbakemelding?

Webex Calling multi-tenant (MT) partnere kan sette opp en webhook for å samle Webex Calling -poster for alle kundene dine. Dette muliggjør effektiv faktureringsavstemming, analyse og rapportering uten å måtte spørre hver kunde individuelt.

Oversikt

Webhook for detaljerte samtaleregistreringer tilbyr en sikker, skalerbar, og robust løsning drevet av hendelser i stedet for forespørsler. Denne webhooken gir større synlighet i kundenes Webex Calling aktiviteter, og støtter brukstilfeller fra fakturering til skreddersydd rapportering.

Du kan bruke denne webhooken til å samle poster praktisk for alle kunder som administreres gjennom Partner Hub uten å spørre hver kunde individuelt. Denne webhooken lar deg utvikle tilpasset rapportering, fakturering, og analytiske applikasjoner for både interne forretningskrav og verdiskapende tjenester.

For en introduksjon til webhooken og tilhørende API-er, se denne Vidcast: Webex Calling Partner Detailed Call History API.

Hva Partner webhook leverer

Webhooken leverer detaljerte samtalehistorikkposter hver 5 minutter. Hver webhook nyttelast inneholder:

  • Samtaleopptegnelser som ble avsluttet mellom 10 minutter og 5 minutter før gjeldende tid.
  • Eventuelle sene poster behandlet av Webex Calling skyen.
  • Fyller automatisk ut sene anropsposter i de påfølgende webhook-nyttelastene for å sikre pålitelig levering.

Hvis du vil vise hvordan anropsposter er inkludert i hver nyttelast, kan du vurdere følgende eksempel:

  • En nyttelast mottatt klokken 14:05 inneholder samtaler som ble avsluttet mellom 13:55 og 14:00.
  • Samtaler som slutter mellom 14:00 og 14:05 er inkludert i nyttelasten 14:10.
  • Oppføringer som ble fullført tidligere (for eksempel et anrop som ble avsluttet kl. 14:04), men behandlet sent av Webex Calling skyen (for eksempel kl. 14:11), inkluderes i neste planlagte nyttelast (for eksempel 14:15).

Webhookene leverer pålitelig poster. Du kan imidlertid motta dupliserte poster i påfølgende webhook-nyttelaster når systemet spiller opp poster på nytt under visse forhold. Du er ansvarlig for å håndtere deduplisering av poster. Hvis du vil identifisere dupliserte poster, bruker du rapportID- feltet som primærnøkkel og ReportTime- feltet til å bestemme når et anrop ble fullført eller behandlet. Bruk disse feltene til å oppdatere eller sette inn postene i dine interne datalagre.

Webhook i Partner Hub

Ved å tilby en webhook, gjør du det mulig for analyseplattformen å sende anropsoppføringer til tilbakeringingsnettadressen din når de genereres.

Webex Callingposter leveres med samme format som eksisterende API-er for detaljerte samtaleposter. Du kan sette opp en webhook og velge mellom to typer feed:

  • Analytikk — Inkluderer alle anropsposter for alle kundeorganisasjoner som partneren har en Webex Calling relasjon til. Dette inkluderer organisasjoner der:
    • Partneren administrerer kundeorganisasjonen med en Partner Full Administrator-rolle.
    • Kundeorganisasjonen har et aktivt Webex Calling abonnement i partnerorganisasjonen.
  • Fakturering — Inkluderer anropsoppføringer for samtaler foretatt av brukere med en Webex Calling lisens som er solgt og klargjort av partneren. Samtaleposter for arbeidsområder er inkludert i denne feeden.

Tilgang og personvern

Bare den eiende partneren kan få tilgang til Call Detail Records (CDR) for fakturering.

  • En partner (eller underpartner) som administrerer lisensen som er knyttet til anropsoppføringen, blir eierpartneren.
  • Eierskap bestemmes av: Bruker-ID > Lisens-ID > Abonnement-ID > Partner -ID.
  • Hver CDR er tilgjengelig for en enkelt partner.
  • Noen anropsoppføringer tilordnes ikke til en faktureringspartner, og ikke alle partnere tilknyttet en organisasjon får lik tilgang til alle poster, siden disse postene kan inneholde personlig identifiserbar informasjon (PII).

Sett opp en webhook-tilbakeringingsnettadresse

Konfigurer webhooken i Partner Hub. Du kan bare sette opp én webhook per partner organisasjon.

Forsikre deg om at du har fulladministratorrollen Partner med full tilgang på organisasjons nivå og Webex CallingCDR API-tilgang sjekket i Control Hub (under Administ rasjon > Bru kere velger du en fullverdig administrator eller partner administrator, og velg deretter Administratorroller > Partner).

De samme tilgangskravene gjelder når du bruker API-ene for partneravstemming og poster.

Screenshot showing administrator roles settings with Partner admin and Partner full admin selected, along with Webex Calling CDR API Access checked under Functional settings.

1

Logg på Partner Hub.

2

Gå til Organisasjonsinnstillinger > Sam taledetaljer.

Screenshot of Organization Settings for Call Detail Records, displaying fields for Webhook URL, Secret token, and Resource Type with Analytics selected.
3

Skriv inn en URL som skal brukes under Webhook.

URL-en må slutte med /webhook (for eksempel https://yourdomain.com/webhook).
4

Hvis du vil autentisere webhook-nyttelastene dine med et hemmelig token, kan du legge til en. Hvis du vil finne mer informasjon om Webex webhooks og hemmelige tokens, kan du se Webex for utviklere: Webhooks.

5

Velg en av følgende ressurstype som skal brukes til webhooken:

  • Analy se — Inkluderer alle anropsposter for alle kunde organisasjoner som partneren har et Webex Calling forhold til.
  • Fakturering — Inkluderer anropsoppføringer for brukere som partneren solgte Webex Calling lisenser til. Samtaleposter for arbeidsområder er inkludert i denne feeden.

Partner API-endepunkter

I tillegg til webhooken, Webex Calling gir API-endepunkter for å støtte dataavstemming. Disse endepunktene lar deg fange opp eller avstemme datalagrene dine med manglende poster som webhook-lytteren din kanskje ikke har mottatt. De to API-endepunktene er Rec oncision API og Records API.

Opptegnelser fra disse API-ene er tilgjengelige i 30 dager. For å sikre at du mottar alle forventede poster, anbefaler vi å avstemme platebutikkene dine med jevne mellomrom, for eksempel hver 12. eller 24. time.

Du må bruke et partnertilgangstoken for å få tilgang til disse API-ene. Den autentiserende brukeren må være en Partner Full Administrator med full organisasjonstilgang på administratornivå og må ha Webex CallingCDR API-tilgang aktivert. OAuth-tokenet må inneholde omfanget spark-admin:calling_cdr_read. Skrivebeskyttede administratorroller er ikke tilstrekkelige for API-ene for partneravstemming og poster.

Bruk analytics-callingendepunktet for kundeorganisasjonens Webex Calling dataregion. Bruk gjeldende basisURL-adresse for API-ene for både Avstemming og Poster:

  • USA og Canada: https://analytics-calling.webexapis.com
  • Europa: https://analytics-calling-eu.webexapis.com
  • India: https://analytics-calling-in.webexapis.com
  • Australia: https://analytics-calling-au.webexapis.com

API-vindusområder gjelder for begge endepunktene for bedre å håndtere tjenestelast.

  • For tidsintervaller som er større enn 48 timer, er maksimal tillatt vindusvarighet 12 timer (håndhevet).
  • For en partnerorganisasjons-ID er API-ene hastighetsbegrenset til én innledende API-forespørsel per minutt, per tokenomfang. Hvis paginering brukes, tillates opptil 10 ekstra paginerte API-forespørsler per minutt, per token, og disse kan gjøres umiddelbart etter den første forespørselen.

Avstemmings-API-endepunkt

Avstemmings-API-endepunktet returnerer det totale antallet antall anropsposter som er generert for hver kunde administrert av partneren innen den angitte tidsperioden. Du kan bruke disse totalene til å bekrefte lokal lagring og identifisere eventuelle manglende eller inkonsekvente anropsposter for bestemte kunder.

Tilgangskrav: Den autentiserende brukeren må være en partneradministrator med full tilgang på administratornivå og må ha Webex CallingCDR API-tilgang aktivert. Tilgangstokenet må inneholde spark-admin:calling_cdr_readomfanget.

Hvis du administrerer mer enn 200 kundeorganisasjoner, paginerer API-en resultatene for å forbedre lesbarheten.

URL-adressen for sluttpunktet for avstemming API bruker 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-parametere

Du kan bruke API-en til å hente anropsoppføringer fra de siste 30 dagene. Det valgte tidsvinduet må starte minst 5 minutter før gjeldende UTC-tid og kan ikke overstige 12 timer mellom start- og slutttiden i et enkelt API-anrop.

API-parametrene er:

  • Starttid (påkrevd, streng) —Startdato og -klokkeslett (UTC) for den første posten du vil samle inn. Forsikre deg om at:
    • Du formaterer tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel, 2025-08-15T06:00:00.000Z.
    • Startdato og -klokkeslett må ikke være eldre enn 30 dager fra gjeldende UTC-tid.
    • Vinduet mellom startTimeog endTimekan ikke overstige 12 timer.
  • Slutttid (obligatorisk, streng) —Sluttdato og klokkeslett (UTC) for postene du vil samle inn. Registreringer er basert på rapporttid, som er når samtalen er ferdig. Forsikre deg om at:
    • Du formaterer tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel, 2025-08-15T18:00:00.000Z.
    • Sluttdato og klokkeslett må være 5 minutter før gjeldende UTC-tid og ikke eldre enn 30 dager.
    • Sluttdato og klokkeslett må være større enn startTime.
    • Vinduet mellom startTimeog endTimekan ikke overstige 12 timer.

Eksempel på et JSON-svar for avstemmings-API-endepunkt:


          {
          "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-svaroverskriftene angir det totale antallet organisasjoner som returneres, og om flere sider er tilgjengelige. Sjekk følgende overskriftsparametere for å sikre at du har spurt alle sidene:

  • num-pages: Totalt antall sider (for eksempel 2)
  • total-orgs: Totalt antall organisasjoner inkludert i svaret (for eksempel 283)
  • current-page: Gjeldende sidetall (for eksempel 1)

Hvis overskriftene for eksempel viser num-pages=2, total-orgs=283 og current-page=1, viser du den første siden i et to-siders svar som inneholder 283 organisasjoner totalt. For å få tilgang til neste side, legg til parameteren page=2 i GET-forespørselen din, 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-endepunkt

API-endepunktet for poster brukes til å spørre om manglende anropsposter for bestemte organisasjoner der avvik eller manglende data ble identifisert ved hjelp av Avstemnings-API.

Anbefalt flyt: Ring /v1/partners/cdrcountbyorgførst. Bruk deretter det nøyaktige orgIdsom returner cdr_counts[].orgIdes når du ringer /v1/partners/cdrsbyorg.

API-et for poster returnerer anropsposter i JSON-format, identisk med formatet beskrevet i Detaljert anropshistorikk API. Den returnerte nyttelasten inneholder identiske felt som den returnerte nyttelasten for detaljert anropshistorikk. Hvis du vil ha mer informasjon om feltene og verdiene deres, kan du se Webex CallingDetaljert anropsloggrapport.

API-en gir anropsoppføringer som ble avsluttet 5 minutter før gjeldende tid. For å sikre at alle anropsposter blir gjort tilgjengelige, anbefaler vi å spørre API-en en time etter ønsket tidsvindu.

URL-adressen for sluttpunktet for Records API bruker 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-parametere

  • orgId(påkrevd, streng) — Kundeorganisasjons-IDen du vil hente poster for. Parameternavnet skiller mellom store og små bokstaver. Du kan hente organisasjons-ID-er fra svarfeltet Avstemming API cdr_counts[].orgId.
  • Starttid (påkrevd, streng) —Startdato og -klokkeslett (UTC) for den første posten du vil samle inn. Forsikre deg om at:
    • Du formaterer tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel, 2025-08-15T06:00:00.000Z.
    • Startdato og -klokkeslett må ikke være eldre enn 30 dager fra gjeldende UTC-tid.
    • Intervallet mellom startTimeog endTimemå ikke overstige 12 timer i en enkelt API-forespørsel.
  • Slutttid (påkrevd, streng) —Sluttdato og klokkeslett (UTC) for den siste posten du vil samle inn. Registreringer er basert på rapporttid, som er når samtalen er ferdig. Forsikre deg om at:
    • Du formaterer tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. For eksempel, 2025-08-15T18:00:00.000Z.
    • Sluttdato og klokkeslett må være minst 5 minutter før gjeldende UTC-tid og ikke eldre enn 30 dager.
    • Sluttdato og klokkeslett må være større enn startTime.
    • Intervallet mellom startTimeog endTimemå ikke overstige 12 timer i en enkelt API-forespørsel.
  • maks (valgfritt, antall) —Begrenser maksimalt antall poster per side i svaret. Forsikre deg om at:
    • Rekkevidden er fra 500 til 5000. Standardverdien er 5000. For eksempel, max=1000.
    • Hvis API-en har flere poster å returnere enn den angitte maksverdien, blir svaret paginert.
    • Hvis en verdi under 500 er spesifisert, justeres den automatisk opp til 500. Hvis en verdi over 5000 er spesifisert, justeres den ned til 5000.

Paginering

For å identifisere om API-svar er paginert, sjekk svaroverskriftene for en koblingsoverskrift. Hvis det nextfinnes en kobling i koblingsoverskriften, trekker du den ut og bruker startTimeForNextFetchverdien til å be om neste sett med poster. Hvis det ikke er noen neste lenke, samles alle rapporter for det valgte tidsintervallet.

API-forespørsler for påfølgende sider kan gjøres umiddelbart, men må være begrenset til maksimalt 10 paginerte forespørsler per minutt, per tokenomfang.

Bruk idempotent behandling og de-duplisering når du henter poster, inkludert på tvers av paginerte svar eller gjentatte avstemmingsvinduer. Bruk reportIdsom primærnøkkel og reportTimefor å bestemme den sist behandlede posten.

For eksempel, hvis den første API-forespørselen 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

da 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 bruker bare rel="next"koblingsoverskriften. Hvis svaret inneholder en rel="next"kobling, bruker du den URL-adressen til å hente neste side med poster. Hvis svaret ikke inneholder en rel="next"kobling, har du hentet alle tilgjengelige poster for det valgte tidsintervallet.

Paginering for denne API-en følger RFC5988 (Web Linking) -standarden. Hvis du vil ha mer informasjon, kan du se Grun nleggende om REST API.

Forstå API-endepunktsresponskoder

Denne delen gir en oversikt over vanlige svarkoder som kan oppstå når du arbeider med Reconcision API-endepunkt og Records API-endepunkt. Disse endepunktene spiller en kritisk rolle i datasyn kronisering, validering og rapportering. Å forstå disse svarkodene er avgjørende for effektiv feilsøking og for å opprettholde pålitelige, stabile integrasjoner.

Tabell 1. API-endepunktsresponskoder

Svarkode

Beskrivelse av svarkode

200

OK

400

Dårlig forespørsel: Fo respørselen var ugyldig eller kan ikke serveres på annen måte. En medfølgende feilmelding vil forklare nærmere.

401

Uautorisert: Autentiseringsinformasjon manglet eller var feil.

403

Forbudt: Forespørselen er forstått, men den er avslått eller tilgang er ikke tillatt.

404

Ikke funnet: Den forespurte URI-en er ugyldig eller den forespurte ressursen, for eksempel en bruker, eksisterer ikke. Returneres også når det forespurte formatet ikke støttes av den forespurte metoden.

405

Metode ikke tillatt: Forespørselen ble gjort til en ressurs ved hjelp av en HTTP-forespørselsmetode som ikke støttes.

409

Konflikt: Forespørselen kunne ikke behandles fordi den er i konflikt med en etablert regel i systemet. For eksempel kan en person ikke legges til et rom mer enn en gang.

410

Borte: Den forespurte ressursen er ikke lenger tilgjengelig.

415

Medietype som ikke støttes: Forespørselen ble sendt til en ressurs uten å spesifisere en medietype eller brukte en medietype som ikke støttes.

423

Låst: Den forespurte ressursen er midlertidig utilgjengelig. En Retry-After-overskrift kan være til stede som angir hvor mange sekunder du må vente før du prøver forespørselen på nytt.

428

Forutsetning kreves: Fil (er) kan ikke skannes for skadelig programvare og må tvinges ned.

429

For mange forespørsler: For mange forespørsler er sendt i løpet av en gitt tidsperiode, og forespørselen har blitt begrenset. En Retry-After-overskrift bør være til stede som angir hvor mange sekunder du må vente før en vellykket forespørsel kan gjøres.

451

Som standard blir forespør analytics-calling.webexapis.comsler til rutet til nærmeste regionale servere. Hvis disse serverne er vert for organisasjonens data, returnerer API-en dataene. Ellers returnerer API-en HTTP 451, og svarkroppen identifiserer endepunktet der du kan hente organisasjonens data.

500

Intern serverfeil: Noe gikk galt på serveren. Hvis problemet vedvarer, er du velkommen til å kontakte [Webex Developer Support Team] (/explore/support).

502

Dårlig gateway: Tjeneren mottok et ugyldig svar fra en oppstrømsserver mens forespørselen ble behandlet. Prøv igjen senere.

503

Tjenesten er utilgjeng elig: Serveren er overbelastet med forespørsler. Prøv igjen senere.

504

Gateway Timeout: En oppstrømsserver kunne ikke svare i tide. Hvis spørringen bruker maks parameter, kan du prøve å redusere den.

API for partnerrapporter/maler

Du kan generere og laste ned rapporter som er tilgjengelige i Partner Hub ved hjelp av API-ene for partnerrapporter. Hvis du vil ha mer informasjon, kan du se partnerrapporten/malene.

Partnere kan også få tilgang til og laste ned flere rapporter direkte fra Partner Hub. Hvis du vil ha mer informasjon, kan du se Partner Hub-rapporter.

Revisjonshistorikk

Dokumentrevisjonshistorikk

Revisjonsdato

Vi har gjort følgende endringer i artikkelen

13/08/26

  • Krav til avstemming API-endepunktsrolle: Den autentiserende brukeren må være en partneradministrator med full tilgang på administratornivå. Webex CallingCDR API-tilgangen må også være aktivert.

  • Responskodene for forståelse API-endepunkt oppdateres til å inkludere 451 feilkode.

  • Lagt til de regionale endepunktene for kundeorganisasjonens Webex Calling dataregion.

2/04/2026

  • Opprettet en revisjonsloggtabell som sporer alle endringer som er gjort over tid.

  • Oppdaterte seksjonene Avstemnings-API-endepunkt og Records API-endepunktsseksjoner for å inkludere en tabell eller feilkodeverdier.

Var denne artikkelen nyttig?
Var denne artikkelen nyttig?