I den här artikeln
Översikt
Konfigurera en webhook-URL för återringning
dropdown icon
Partner-API-slutpunkter
    Slutpunkt för avstämnings-API
    Slutpunkt för Records API
    Partner reports/templates API

Detaljerade samtalsregister webhook för Webex Calling i Partner Hub

list-menuI den här artikeln
list-menuHar du feedback?

Webex Calling-partners med flera hyresgäster (MT) kan konfigurera en webhook för att samla in 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

Webhooken 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 enkelt samla in poster för alla kunder som hanteras via Partner Hub utan att fråga varje kund individuellt. Denna webhook låter dig utveckla anpassade rapporterings-, fakturerings- och analysapplikationer för både interna affärskrav och mervärdestjänster.

För en introduktion till webhooken och dess tillhörande API:er, titta på denna Vidcast: Webex Calling Partner Detaljerad samtalshistorik-API.

Vad Partner-webhooken levererar

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

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

För att visa hur samtalsposter inkluderas i varje nyttolast, betrakta följande exempel:

  • En nyttolast mottagen kl. 14:05 innehåller samtal som avslutades mellan 13:55 och 14:00.
  • Samtal som slutar mellan 14:00 och 14:05 ingår i 14:10 nyttolast.
  • Tidigare slutförda poster (till exempel ett samtal som avslutades kl. 14:04) men bearbetas sent av Webex Calling-molnet (till exempel kl. 14:11) ingår i nästa schemalagda nyttolast (till exempel, 14:15).

Webhooks levererar poster på ett tillförlitligt sätt. Du kan dock få dubbletter av poster i efterföljande webhook-nyttolaster när systemet spelar upp poster under vissa förhållanden. Du ansvarar för att hantera duplicering av poster. För att identifiera dubbletter av poster, använd fältet reportId som primärnyckel och fältet reportTime för att avgöra när ett samtal slutfördes eller bearbetades. 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 aktiverar du analysplattformen att skicka samtalsposter till din återuppringnings-URL när de genereras.

Webex-samtalposter levereras med samma format som de befintliga detaljerade API:erna för samtalsposter. Du kan konfigurera en webhook och välja mellan två typer av flöden:

  • 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 Fullständig partneradministratö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 detta flöde.

Åtkomst och dataskydd

Endast den ägande partnern har åtkomst till samtalsdetaljposter (CDR) för fakturering.

  • En partner (eller underpartner) som hanterar licensen som är kopplad till samtalsposten blir ägande partner.
  • Äganderätten 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 partners som är kopplade till en organisation har lika åtkomst till alla poster, eftersom dessa poster kan innehålla personligt identifierbar information (PII).

Konfigurera en webhook-URL för återringning

Konfigurera webhooken i partnerhubben. Du kan bara konfigurera en webhook per partnerorganisation.

Se till att du har rollen Partner fullständig administratör med "Organisationsåtkomst fullständig administratörsnivå" och Webex Calling CDR API-åtkomst markerad i Control Hub (under Management > Användare, välj en fullständig administratör eller partnerfull administratör och välj sedan Administratörsroller > Partner).

Skärmdump som visar inställningar för administratörsroller med partneradministratör och fullständig partneradministratör valda, tillsammans med Webex Calling CDR API-åtkomst markerad under funktionella inställningar.

1

Logga in på Partner Hub.

2

Gå till Organisationsinställningar > Samtalsdetaljer.

Skärmdump av organisationsinställningar för samtalsdetaljposter, som visar fält för Webhook-URL, hemlig token och resurstyp med Analytics vald.
3

Ange en URL som ska användas under Webhook.

URL:en 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. För mer information om Webex webhooks och hemliga tokens, se Webex för utvecklare: Webhooks.

5

Välj en av följande Resurstyp att använda för webhooken:

  • Analys– Inkluderar alla samtalsposter för alla kundorganisationer 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 detta flöde.

Partner-API-slutpunkter

Förutom webhooken tillhandahåller Webex Calling API-slutpunkter för att stödja dataavstämning. Med dessa slutpunkter kan du komma ikapp eller stämma av dina datalager med eventuella saknade poster som din webhook-lyssnare kanske inte har tagit emot. De två API-slutpunkterna är Avstämnings-API och Records API.

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 dokument rekommenderar vi att du stämmer av dina dokumentförråd regelbundet, till exempel var 12:e eller 24:e timme.

Du måste använda en partneråtkomsttoken för att få åtkomst till dessa API:er. Hämta och hantera din partneråtkomsttoken enligt standard Webex Developer-hanteringspraxis för åtkomsttoken.

API-fönsterintervall är tillämpliga för båda slutpunkterna för att bättre hantera tjänstbelastningen.

  • För tidsintervall större än 48 timmar är den maximala tillåtna fönstertiden 12 timmar (rekommenderas och tillämpas).
  • För tidsintervall på 48 timmar eller mindre är den maximalt tillåtna fönstertiden 48 timmar (rekommenderas inte; det här alternativet kommer att vara föråldrat från och med den 30 januari 2026).
  • För ett partnerorganisations-ID är API:erna begränsade till en initial API-begäran per minut, per token-omfattning. Om paginering används tillåts upp till 10 ytterligare paginerade API-förfrågningar per minut och token, och dessa kan göras omedelbart efter den första begäran.

Slutpunkt för avstämnings-API

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

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

Slutpunkts-URL:en för avstämnings-API:et 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 samtalsregister från de senaste 30 dagarna. Ditt valda tidsfönster 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 (obligatorisk, 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 startTime och endTime får inte överstiga 12 timmar.
  • endTime (obligatorisk, sträng)—Slutdatum och -tid (UTC) för de poster du vill samla in. Journalerna baseras på rapporteringstid, 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.
    • Slutdatumet och -tiden måste vara större än startTime.
    • Fönstret mellan startTime och endTime får inte överstiga 12 timmar.

Exempel på ett JSON-svar för en slutpunkt för avstämnings-API:n:


          {
          "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 returneras och om ytterligare sidor finns tillgängliga. Kontrollera följande rubrikparametrar för att säkerställa att du har frågat alla sidor:

  • antal sidor: Totalt antal sidor (till exempel 2)
  • totala-organisationer: Totalt antal organisationer som ingår i svaret (till exempel 283)
  • aktuell sida: Aktuellt sidnummer (till exempel 1)

Om till exempel rubrikerna visar num-pages=2, total-orgs=283, och current-page=1, Du tittar på den första sidan av ett tvåsidigt svar som innehåller totalt 283 organisationer. För att komma åt nästa sida, lägg till page=2 parameter till din GET-förfrågan, 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

Slutpunkt för Records API

Slutpunkten för Records API används för att fråga efter saknade samtalsposter för specifika organisationer där avvikelser eller saknade data identifierades med hjälp av Reconciliation API.

Records API returnerar samtalsposter i JSON-format, identiskt med formatet som beskrivs i Detailed Call History API. Den returnerade nyttolasten innehåller identiska fält som den returnerade nyttolasten Detaljerad samtalshistorik. För mer information om fälten och deras värden, se Webex Calling Detaljerad samtalshistorikrapport.

API:et tillhandahåller samtalsregister som avslutades 5 minuter före aktuell tid. För att säkerställa att alla samtalsregister blir tillgängliga rekommenderar vi att du frågar API:et en timme efter ditt önskade tidsfönster.

Slutpunkts-URL:en för Records API 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) – Organisations-ID:t som du vill hämta poster för. Du kan hämta organisations-ID:n från avstämnings-API:et.
  • startTime (obligatorisk, 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 startTime och endTime får inte överstiga 12 timmar i en enda API-förfrågan.
  • endTime (obligatorisk, sträng)—Slutdatum och -tid (UTC) för den sista posten du vill samla in. Journalerna baseras på rapporteringstid, 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.
    • Slutdatumet och -tiden måste vara större än startTime.
    • Intervallet mellan startTime och endTime får inte överstiga 12 timmar i en enda API-förfrågan.
  • Max (valfritt, antal) – Begränsar det maximala antalet poster per sida i svaret. Se till att:
    • Intervallet ä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 ned till 5000.

Sidnumrering

För att identifiera om API-svar är paginerade, kontrollera svarsrubrikerna för en länkrubrik. Om en next -länk finns i länkrubriken, extrahera den och använd värdet startTimeForNextFetch 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 vara begränsade till maximalt 10 paginerade förfrågningar per minut, per token-omfattning.

Till exempel, om den initiala 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änkrubriken i svaret:

; rel="next"

Andra möjliga länkvärden inkluderar rel="first" och rel="prev" för den första respektive föregående sidan.

Paginering för detta API följer RFC5988-standarden (webblänkning). För mer information, se Grunderna i REST API.

Partner reports/templates API

Du kan generera och ladda ner rapporter som är tillgängliga i Partner Hub med hjälp av Partner Reports API:er . För mer information, se partner report/templates.

Partners kan också komma åt och ladda ner flera rapporter direkt från Partner Hub. För mer information, se Partner Hub-rapporter.

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