I den här artikeln
Översikt
Ställ in en webhook-återuppringningsadress
dropdown icon
Partner API-slutpunkter
    API-slutpunkt för avstämning
    Registrerar API-slutpunkt
Förstå svarskoder för API-slutpunkter
API för partnerrapporter/mallar
Revisionshistorik
Detaljerad webbhook för samtalsposter för Webex Calling i Partner Hub
list-menuI den här artikeln
list-menuHar du feedback?

Webex Calling multi-tenant (MT) partners kan skapa en webhook för att samla Webex Calling -poster för alla dina kunder. Detta möjliggör effektiv faktureringsavstämning, analys och rapportering utan att behöva fråga varje kund individuellt.

Översikt

Webhook för detaljerade samtalsregister erbjuder en säker, skalbar, och robust lösning som drivs av händelser snarare än förfrågningar. Denna webhook ger större insyn i dina kunders Webex Calling aktiviteter och stöder användningsfall från fakturering till skräddarsydd rapportering.

Du kan använda den här webhooken för att samla in poster bekvämt för alla kunder som hanteras via Partner Hub utan att fråga varje kund individuellt. Denna webhook låter dig utveckla anpassad rapportering, fakturering, och analytiska applikationer för både interna affärskrav och mervärdestjänster.

För en introduktion till webhooken och dess medföljande API: er, titta på denna Vidcast: Webex Calling Partnerdetaljerad samtalshistorik API.

Vad Partner webhook levererar

Webhook levererar detaljerade samtalshistorikposter var 5: e minut. Varje webhook nyttolast innehåller:

  • Samtalsposter som slutade mellan 10 minuter och 5 minuter före aktuell tid.
  • Eventuella sena poster som behandlas av Webex Calling molnet.
  • Återfyller automatiskt sena samtalsposter i efterföljande webhook-nyttolaster för att säkerställa tillförlitlig leverans.

Om du vill visa hur samtalsposter ingår i varje nyttolast kan du tänka på följande exempel:

  • En nyttolast som tas emot klockan 14:05 innehåller samtal som slutade mellan 13:55 och 14:00.
  • Samtal som slutar mellan 14:00 och 14:05 ingår i nyttolasten 14:10.
  • Poster som slutförts tidigare (till exempel ett samtal som slutade kl. 14:04) men som bearbetats sent av Webex Calling molnet (till exempel kl. 14:11) inkluderas i nästa schemalagda nyttolast ( till exempel 14:15).

Webhooks levererar tillförlitligt register. Du kan dock få dubbla poster i efterföljande webhook-nyttolaster när systemet spelar upp poster under vissa förhållanden. Du är ansvarig för att hantera borttagning av dubbletter av poster. Om du vill identifiera dubbletter av poster använder du fältet Re portID som primärnyckel och fältet ReportTime för att avgöra när ett samtal slutfördes eller behandlades. Använd dessa fält för att uppdatera eller infoga posterna i dina interna datalager.

Webhook i Partner Hub

Genom att tillhandahålla en webhook tillåter du analysplattformen att skicka samtalsposter till din återuppringnings-URL när de genereras.

Webex Callingposter levereras med samma format som de befintliga API:erna för detaljerade samtalsposter. Du kan ställa in en webhook och välja mellan två typer av flöde:

  • Analys — Inkluderar alla samtalsposter för alla kundorganisationer som partnern har en Webex Calling relation med. Detta inkluderar organisationer där:
    • Partnern hanterar kundorganisationen med rollen Partner Fullständig administratör.
    • Kundorganisationen har en aktiv Webex Calling prenumeration inom partnerorganisationen.
  • Fakturering — Inkluderar samtalsposter för samtal som gjorts av användare med en Webex Calling licens som sålts och tillhandahållits av partnern. Samtalsposter för arbetsytor ingår i det här flödet.

Åtkomst och datasekretess

Endast den ägande partnern kan komma åt Call Detail Records (CDR) för fakturering.

  • En partner (eller underpartner) som hanterar licensen som är kopplad till samtalsposten blir ägarpartner.
  • Ägarskapet bestäms av: Användar-ID > Licens-ID > Prenumerations-ID > Partner -ID.
  • Varje CDR är tillgänglig för en enda partner.
  • Vissa samtalsposter mappas inte till en faktureringspartner, och inte alla partner som är associerade med en organisation får lika tillgång till alla poster, eftersom dessa poster kan innehålla personligt identifierbar information (PII).

Ställ in en webhook-återuppringningsadress

Konfigurera webhooken i Partner Hub. Du kan bara ställa in en webhook per partner organisation.

Kontrollera att du har den fullständiga administratörsrollen Partner med ”Fullständig administratörsnivå för organisation ” och Webex CallingCDR-API-åtkomst markerad i Control Hub (under Han tering > Använ dare väljer du en fullständig administratör eller fullständig partneradministratör och väljer sedan Administratörsroller > Partner).

Samma åtkomstkrav gäller när du använder API:erna för partneravstämning och 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

Logga in på Partner Hub.

2

Gå till Organisationsinställningar > Samtalsdetaljposter.

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

Ange en URL som ska användas under Webhook.

Webbadressen måste sluta med /webhook (till exempel https://yourdomain.com/webhook).
4

Om du vill autentisera dina webhook-nyttolaster med en hemlig token kan du lägga till en. Mer information om Webex webhooks och hemliga tokens finns i Webex för utvecklare: Webhooks.

5

Välj en av följande resurstyp som ska användas för webhooken:

  • Analytics — Inkluderar alla samtalsposter för alla kund organisationer som partnern har en Webex Calling relation med.
  • Fakturering — Inkluderar samtalsposter för användare som partnern sålde Webex Calling licenser till. Samtalsposter för arbetsytor ingår i det här flödet.

Partner API-slutpunkter

Förutom webhook, Webex Calling tillhandahåller API-slutpunkter för att stödja dataavstämning. Med dessa slutpunkter kan du komma ikapp eller förena dina datalager med eventuella saknade poster som din webhook-lyssnare kanske inte har fått. De två API-slutpunkterna är Av stämningsAPI:et och API :et för poster.

Poster från dessa API:er är tillgängliga i 30 dagar. För att säkerställa att du får alla förväntade poster rekommenderar vi att du avstämmer dina skivbutiker regelbundet, till exempel var 12 eller 24: e timme.

Du måste använda en partneråtkomsttoken för att komma åt dessa API:er. Den autentiserande användaren måste vara en fullständig partneradministratör med fullständig administratörsnivå för organisationen och måste ha Webex CallingCDR API-åtkomst aktiverad. OAuth-token måste innehålla omfattningen spark-admin:calling_cdr_read. Skrivskyddade administratörsroller är inte tillräckliga för API:erna för partneravstämning och poster.

Använd analytics-callingslutpunkten för kundorganisationens Webex Calling dataregion. Använd den tillämpliga baswebbadressen för API:erna för både Avstämning och Poster:

  • USA och Kanada: 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-fönsterintervall är tillämpliga på båda slutpunkterna för att bättre hantera servicebelastning.

  • För tidsintervall som är längre än 48 timmar är den maximala tillåtna fönsterlängden 12 timmar (tvingas).
  • För ett partnerorganisations-ID är API:erna hastighetsbegränsade till en initial API-begäran per minut, per tokenomfattning. Om sidnumrering används tillåts upp till 10 ytterligare paginerade API-förfrågningar per minut, per token, och dessa kan göras omedelbart efter den första begäran.

API-slutpunkt för avstämning

API-slutpunkten för avstämning returnerar det totala antalet samtalsposter som genererats för varje kund som hanteras av partnern inom den angivna tidsperioden. Du kan använda dessa summor för att verifiera din lokala lagring och identifiera eventuella saknade eller inkonsekventa samtalsposter för specifika kunder.

Åtkomstkrav: Den autentiserande användaren måste vara en partneradministratör med fullständig åtkomst på administratörsnivå och ha Webex CallingCDR API-åtkomst aktiverad. Åtkomsttoken måste innehålla spark-admin:calling_cdr_readomfattningen.

Om du hanterar fler än 200 kundorganisationer paginerar API:et resultaten för att förbättra läsbarheten.

URL:en för slutpunkten för avstämnings-API använder följande format:

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

API-parametrar

Du kan använda API:et för att hämta samtalsposter från de senaste 30 dagarna. Det valda tidsfönstret måste börja minst 5 minuter före aktuell UTC-tid och får inte överstiga 12 timmar mellan start- och sluttiderna i ett enda API-anrop.

API-parametrarna är:

  • StartTime (obligatoriskt, sträng) —Startdatum och -tid (UTC) för den första posten du vill samla in. Se till att:
    • Du formaterar tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. Till exempel, 2025-08-15T06:00:00.000Z.
    • Startdatum och -tid får inte vara äldre än 30 dagar från aktuell UTC-tid.
    • Fönstret mellan startTimeoch endTimefår inte överstiga 12 timmar.
  • Sluttid (obligatoriskt, sträng) —Slutdatum och tid (UTC) för posterna du vill samla in. Posterna baseras på rapporttid, vilket är när samtalet är klart. Se till att:
    • Du formaterar tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. Till exempel, 2025-08-15T18:00:00.000Z.
    • Slutdatum och tid måste vara 5 minuter före aktuell UTC-tid och inte äldre än 30 dagar.
    • Slutdatum och tid måste vara större än startTime.
    • Fönstret mellan startTimeoch endTimefår inte överstiga 12 timmar.

Exempel på ett JSON-svar för avstämnings-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-svarsrubrikerna anger det totala antalet organisationer som returnerats och om ytterligare sidor finns tillgängliga. Kontrollera följande rubrikparametrar för att säkerställa att du har frågat alla sidor:

  • num-pages: Totalt antal sidor (till exempel 2)
  • total-orgs: Totalt antal organisationer som ingår i svaret (till exempel 283)
  • current-page: Aktuellt sidnummer (till exempel 1)

Om rubrikerna till exempel visar num-pages=2, total-orgs=283 och current-page=1 visas den första sidan i ett tvåsidigt svar som innehåller 283 organisationer totalt. För att komma åt nästa sida, lägg till parametern page=2 till din GET-begäran, som visas nedan:

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

Registrerar API-slutpunkt

API-slutpunkten för poster används för att fråga saknade samtalsposter för specifika organisationer där avvikelser eller saknade data identifierades med hjälp av Avstämnings-API.

Rekommenderat flöde: Ring /v1/partners/cdrcountbyorgförst. Använd sedan exakt det orgIdsom returneras cdr_counts[].orgIdnär du ringer /v1/partners/cdrsbyorg.

API:et för poster returnerar samtalsposter i JSON-format, identiskt med det format som beskrivs i API:et Detaljerad samtalshistorik. Den returnerade nyttolasten innehåller identiska fält som den returnerade nyttolasten Detaljerad samtalshistorik. Mer information om fälten och deras värden finns i Webex CallingDetaljerad samtalshistorikrapport.

API:et tillhandahåller samtalsposter som slutade 5 minuter före aktuell tid. För att säkerställa att alla samtalsposter görs tillgängliga rekommenderar vi att du frågar API:et en timme efter önskat tidsfönster.

URL:en för Poster-API:s slutpunkt använder följande 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-parametrar

  • orgId(obligatoriskt, sträng) — Kundens organisations-ID som du vill hämta poster för. Parameternamnet är skiftlägeskänsligt. Du kan hämta organisations-ID:n från svarsfältet Avstämnings-API cdr_counts[].orgId.
  • StartTime (obligatoriskt, sträng) —Startdatum och -tid (UTC) för den första posten du vill samla in. Se till att:
    • Du formaterar tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. Till exempel, 2025-08-15T06:00:00.000Z.
    • Startdatum och -tid får inte vara äldre än 30 dagar från aktuell UTC-tid.
    • Intervallet mellan startTimeoch endTimefår inte överstiga 12 timmar i en enda API-begäran.
  • EndTime (obligatoriskt, sträng) —Slutdatum och tid (UTC) för den sista posten du vill samla in. Posterna baseras på rapporttid, vilket är när samtalet är klart. Se till att:
    • Du formaterar tiden som YYYY-MM-DDTHH:MM:SS.mmmZ. Till exempel, 2025-08-15T18:00:00.000Z.
    • Slutdatum och tid måste vara minst 5 minuter före aktuell UTC-tid och inte äldre än 30 dagar.
    • Slutdatum och tid måste vara större än startTime.
    • Intervallet mellan startTimeoch endTimefår inte överstiga 12 timmar i en enda API-begäran.
  • max (valfritt, antal) — Begränsar det maximala antalet poster per sida i svaret. Se till att:
    • Räckvidden är från 500 till 5000. Standardvärdet är 5000. Till exempel, max=1000.
    • Om API:et har fler poster att returnera än det angivna maxvärdet pagineras svaret.
    • Om ett värde under 500 anges justeras det automatiskt upp till 500. Om ett värde över 5000 anges justeras det ner till 5000.

Paginering

För att identifiera om API-svar är paginerade, kontrollera svarsrubrikerna för en länkhuvud. Om en nextlänk finns i länkhuvudet extraherar du den och använder startTimeForNextFetchvärdet för att begära nästa uppsättning poster. Om det inte finns någon nästa länk samlas alla rapporter för det valda tidsintervallet in.

API-förfrågningar för efterföljande sidor kan göras omedelbart, men måste begränsas till högst 10 paginerade förfrågningar per minut, per tokenomfattning.

Använd idempotent bearbetning och borttagning av dubbletter när du hämtar poster, inklusive över paginerade svar eller upprepade avstämningsfönster. Använd reportIdsom primärnyckel och reportTimeför att bestämma den senast bearbetade posten.

Till exempel, om den ursprungliga API-begäran är:

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

då är länkhuvudet 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"

Pagination använder endast rel="next"länkhuvudet. Om svaret innehåller en rel="next"länk använder du den webbadressen för att hämta nästa sida med poster. Om svaret inte innehåller en rel="next"länk har du hämtat alla tillgängliga poster för det valda tidsintervallet.

Paginering för detta API följer standarden RFC5988 (Web Linking). Mer information finns i Grunderna för REST API.

Förstå svarskoder för API-slutpunkter

I det här avsnittet finns en översikt över vanliga svarskoder som kan uppstå när du arbetar med API-slutpunkten för avstämning och API-slutpunkten för poster. Dessa slutpunkter spelar en avgörande roll i datasyn kronisering, validering och rapportering. Att förstå dessa svarskoder är avgörande för effektiv felsökning och för att upprätthålla tillförlitliga, stabila integrationer.

Tabell 1. API Endpoint-svarskoder

Svarskod

Beskrivning av svarskod

200

OK

400

Dålig begäran: Begäran var ogiltig eller kan inte tillhandahållas på annat sätt. Ett medföljande felmeddelande kommer att förklara ytterligare.

401

Obehörig: Autentiseringsuppgifter saknades eller var felaktiga.

403

För bjudet: Begäran förstås, men den har vägrats eller åtkomst är inte tillåten.

404

Hittades inte: Den begärda URI-adressen är ogiltig eller den begärda resursen, till exempel en användare, finns inte. Returneras också när det begärda formatet inte stöds av den begärda metoden.

405

Metod ej tillåten: Begäran gjordes till en resurs med hjälp av en HTTP-förfrågningsmetod som inte stöds.

409

Konflikt: Begäran kunde inte behandlas eftersom den strider mot någon etablerad regel i systemet. Till exempel får en person inte läggas till i ett rum mer än en gång.

410

Bor ta: Den begärda resursen är inte längre tillgänglig.

415

Medietyp som inte stöds: Begäran gjordes till en resurs utan att ange en medietyp eller använde en medietyp som inte stöds.

423

Låst: Den begärda resursen är tillfälligt otillgänglig. En Retry-After-rubrik kan vara närvarande som anger hur många sekunder du måste vänta innan du försöker begäran igen.

428

Förutsättning krävs: Fil (er) kan inte skannas efter skadlig kod och måste tvingas laddas ner.

429

För många förfrågningar: För många förfrågningar har skickats under en viss tid och begäran har begränsats. En Retry-After-rubrik bör finnas som anger hur många sekunder du måste vänta innan en lyckad begäran kan göras.

451

Som standard diriger analytics-calling.webexapis.comas begäranden till närmaste regionala servrar. Om dessa servrar är värd för organisationens data returnerar API:et data. Annars returnerar API:et HTTP 451 och svarsorganet identifierar slutpunkten där du kan hämta organisationens data.

500

Internt serverfel: Något gick fel på servern. Om problemet kvarstår är du välkommen att kontakta [Webex Developer Support team] (/explore/support).

502

Dålig gateway: Servern fick ett ogiltigt svar från en uppströmsserver under behandlingen av begäran. Försök igen senare.

503

Tjänsten är inte tillgänglig: Servern är överbelastad med förfrågningar. Försök igen senare.

504

Gateway Timeout: En uppströmsserver kunde inte svara i tid. Om din fråga använder max parameter, försök att minska den.

Revisionshistorik

Dokumentrevisionshistorik

Revisionsdatum

Vi gjorde följande ändringar i artikeln

13/08/26

  • Avstämnings-API-slutpunktsrollskrav: Den autentiserande användaren måste vara en partneradministratör med fullständig åtkomst på administratörsnivå. Dessutom måste Webex Calling CDR-API-åtkomsten vara aktiverad.

  • Responskoderna för att förstå API-slutpunkter uppdateras för att inkludera 451-felkod.

  • Lade till de regionala slutpunkterna för kundorganisationens Webex Calling dataregion.

2/04/2026

  • Skapade en tabell över revideringshistorik som spårar alla ändringar som gjorts över tiden.

  • Uppdaterade avsnitten Avstämnings-API-slutpunkt och poster API-slutpunktsavsnitt för att inkludera värden för en tabell eller felkod.

Var den här artikeln användbar?
Var den här artikeln användbar?