Overblik

Webhook med detaljerede opkaldsoptegnelser giver dig større synlighed i dine kunders Webex Calling-aktivitet til forskellige formål, fra fakturering til skræddersyet rapportering. Du kan bruge denne webhook til at indsamle optegnelser bekvemt for alle dine kunder uden at skulle spørge om optegnelser for hver kunde en efter en. Denne webhook giver dig mulighed for at udvikle brugerdefinerede rapporterings- og analyseapplikationer til både interne forretningsformål eller levering af merværditjenester til kunder. For en introduktion til webhook og de tilhørende API'er kan du se denne vidcast.

Webhooken leverer optegnelser hvert 5. minut. Hver webhook-nyttelast indeholder poster for opkald, der sluttede for mellem 10 og 5 minutter siden. En nyttelast, der modtages kl. 17:00, omfatter f.eks. opkald, der sluttede mellem 16:50 og 16:55. Opkald, der slutter mellem 16:55 og 17:00, vil være i nyttelasten 17:05.

Webex Calling-poster leveres ved brug af det samme format som de eksisterende API'er for detaljerede opkaldsoptagelser. Du kan konfigurere en webhook og vælge mellem to typer feed:

  • Analyse – inkluderer alle opkaldsopkaldsregistre for alle kundeorganisationer, som partneren har et Webex Calling-forhold til. Dette omfatter organisationer, for hvilke:
    • Partneren administrerer kundeorganisationen med rollen Partner Full Administrator.
    • Kundeorganisationen har et aktivt Webex Calling-abonnement i partnerorganisationen.
  • Fakturering – omfatter kun opkaldsoptegnelser for opkald foretaget af brugere med en Webex Calling-licens, der sælges af partneren. Opkaldsposter for arbejdsområder er inkluderet i dette feed.

Opsæt en URL-adresse til webhook-tilbagekald

Konfigurer webhooken i Partner Hub. Du kan kun konfigurere én webhook pr. partnerorganisation. Du skal være administrator med fulde rettigheder for at opsætte en webhook.

1

Log ind på Partner Hub.

2

Gå til Organisationsindstillinger > Opkaldsoplysninger.

3

Indtast en URL-adresse, der skal bruges under Webhook.

4

Hvis du vil godkende dine webhook-nyttelast med et hemmeligt token, kan du tilføje et. Du kan finde flere oplysninger om Webex-webhooks og hemmelige tokens.

5

Vælg en af følgende ressourcetyp e , der skal bruges til webhook:

  • Analyse – inkluderer alle opkaldsopkaldsregistre for alle kundeorganisationer, som partneren har et Webex Calling-forhold til.
  • Fakturering – inkluderer kun opkaldsposter, som partneren solgte Webex Calling-licenser til. Dette feed indeholder opkaldsposter for arbejdsområder.
Opsætning af webhook-webhook-opsætning i Partner Hub

API-endepunkter

Vi leverer to API-slutpunkter sammen med webhook for at hjælpe med dataafstemning. Disse slutpunkter giver dig mulighed for at "indhente" eller forene dine datalagre med manglende poster, der ikke modtages af webhook-lytteren. Disse to API'er er Reconciliation API-slutpunkte t og Records-API-slutpunktet.

Poster er tilgængelige fra disse API'er i 48 timer. Vi anbefaler, at du afstemmer lageret regelmæssigt, f.eks. hver 12. eller 24. time, så alle optegnelser modtages som forventet. Et partneradgangstoken er påkrævet for at bruge denne API. Du kan få et partneradgangstoken og administrere det i overensstemmelse med standardprincipperne for administration af adgangstoken til Webex Developer.

API-slutpunkt for afstemning

Afstemning API-slutpunktet returnerer antallet af poster, der er genereret af hver kunde, og som administreres af partneren i den angivne tidsperiode. Hvis en partner administrerer mere end 200 kundeorganisationer, vil resultater fra API'en blive sideinddelt for bedre læsbarhed. Du kan bruge disse tal til at kontrollere i forhold til din lokale hukommelse, hvis der mangler poster for bestemte kunder. Du kan finde URL-adressen til afstemning API-slutpunkt her:

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

Parametre

Afstemning-API'en kan kun ringes op i en maksimal varighed på 1 time med parametrene startTime og endTime med højst 60 minutters mellemrum. API'et kan bruges til enhver periode på 1 time mellem 5 minutter og 48 timer siden, men for at administrere belastningen af tjenesten kan der kun ringes op til 1 time ad gangen.

De tilgængelige parametre er:

  • starttidspunkt (streng) – tidspunktet for den første rapport, du vil indsamle. Rapporttiden angiver tidspunktet for afslutning af opkaldet.

    Du skal formatere tiden som ÅÅÅÅ-MM-DDTHH:MM:SS.mmmZ.

  • sluttidspunkt (streng) – tidspunktet for den sidste rapport, du vil indsamle. Rapporttiden angiver tidspunktet for afslutning af opkaldet.

    Det angivne tidspunkt skal være senere end startTime , men ikke senere end 48 timer, og du skal formatere tiden som ÅÅÅÅ-MM-DDTHH:MM:SS.mmmZ.

Her er et eksempel på, hvordan et forsonings-API-slutpunkt JSON returnyttelast ser ud:

{ "cdr_counts": [{ "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy", "count": 3009 }, { "orgId": "yyyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyy", "count": 129 }, { "orgId": "xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyy", "count": 278 } ] } 

Overskrifterne i API-svaret angiver det samlede antal returnerede organisationer, og om der er ekstra sider. Kontrollér følgende parametre for at sikre, at alle sider er blevet forespørgt.

 num-sider = 2 samlede organisationer = 283 aktuel-side = 1

Ovenstående parametre viser, at den aktuelle side er den første side, at der er 2 sider i alt, og at hele svaret indeholder 283 organisationer. Få adgang til den anden side ved at tilføje parameteren side=2 til GET -anmodningen, som vist nedenfor.

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

Optager API-slutpunkt

Dette API-slutpunkt returnerer opkaldsregistre i JSON-format, identisk med formatet som beskrevet i API'et Detaljeret opkaldshistorik. Den returnerede nyttelast indeholder identiske felter med den returnerede detaljerede opkaldshistorik. Du kan finde flere oplysninger om værdierne i hvert felt, der returneres her. API-slutpunktet for poster bruges til at forespørge manglende poster for organisationer, for hvilke der mangler poster. Du kan finde URL-adressen til registreringens API-slutpunkt her:

https://analytics.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

Parametre

  • org-id – det organisations-id, du vil forespørge om poster for. Du kan åbne disse id'er fra det foregående afstemningsslutpunkt.

  • starttidspunkt (streng) – tidspunktet for den første rapport, du vil indsamle. Rapporttiden angiver tidspunktet for afslutning af opkaldet.

    Det angivne tidspunkt skal være mellem 5 minutter siden og 48 timer siden, og du skal formatere tiden som ÅÅÅÅ-MM-DDTHH:MM:SS.mmmZ.

  • sluttidspunkt (streng) – tidspunktet for den sidste rapport, du vil indsamle. Rapporttiden angiver tidspunktet for afslutning af opkaldet.

    Det angivne tidspunkt skal være senere end startTime , men ikke senere end 48 timer, og du skal formatere tiden som ÅÅÅÅ-MM-DDTHH:MM:SS.mmmZ.