- Hjem
- /
- Artikkel
Detaljerte samtaleoppføringer webhook for Webex Calling i Partner Hub
Du kan konfigurere en webhook for å samle inn Webex Calling-oppføringer for alle kundene dine for faktureringsformål, analyse eller rapportering.
Oversikt
Med webhook for detaljerte anropsoppføringer får du større synlighet i kundenes Webex Calling-aktivitet for ulike formål, fra fakturering til tilpasset rapportering. Du kan bruke denne webhooken til å samle inn oppføringer praktisk for alle kundene dine uten å måtte spørre etter oppføringer for hver kunde en etter en. Denne webhooken lar deg utvikle tilpassede rapporterings- og analytiske applikasjoner for både interne forretningsformål eller levering av verdiskapende tjenester til kunder. For en introduksjon til webhook og tilhørende API-er, kan du se denne vidcast.
Webhooken leverer oppføringer hvert 5. minutt. Hver webhook-nyttelast inneholder oppføringer for samtaler som ble avsluttet mellom 10 og 5 minutter siden. En nyttelast som mottas kl. 17.00 inkluderer for eksempel anrop som ble avsluttet mellom 16.50 og 16.55. Anrop som slutter mellom 16:55 og 17:00 vil være i nyttelasten 17:05.
Webex Calling-oppføringer leveres i samme format som de eksisterende API-ene for detaljerte anropsoppføringer. Du kan konfigurere en webhook og velge mellom to typer feed:
- Analyse – Inkluderer alle anropsoppføringer for alle kundeorganisasjoner som partneren har et Webex Calling-forhold med. Dette inkluderer organisasjoner som:
- Partneren administrerer kundeorganisasjonen med en rolle som fullstendig partneradministrator.
- Kundeorganisasjonen har et aktivt Webex Calling-abonnement i partnerorganisasjonen.
- Fakturering – Inkluderer bare anropsoppføringer for samtaler utført av brukere med en Webex Calling-lisens solgt av partneren. Anropsoppføringer for arbeidsområder er inkludert i denne feeden.
Konfigurer en webhook tilbakeringings-URL
Konfigurer webhooken i Partner Hub. Du kan bare konfigurere én webhook per partnerorganisasjon. Du må være fullverdig administrator for å sette opp en webhook.
| 1 | |
| 2 |
Gå til . |
| 3 |
Skriv inn en URL som skal brukes under Webhook. |
| 4 |
Hvis du vil godkjenne webhook-nyttelaster med et hemmelig token, kan du legge til et. Du finner mer informasjon om Webex-webhooks og hemmelige tokener her. |
| 5 |
Velg én av følgende Ressurstype som skal brukes for webhooken:
|
API-endepunkter
Vi tilbyr to API-endepunkter sammen med webhook for å hjelpe deg med dataavstemming. Disse endepunktene lar deg "fange opp" eller avstemme datalagrene dine med manglende oppføringer som ikke mottas av webhook-lytteren. Disse to API-ene er endepunktet Reconciliation API og Records API-endepunktet.
Oppføringer er tilgjengelige fra disse API-ene i 48 timer. Vi anbefaler at du avstemmer oppføringer med jevne mellomrom, for eksempel hver 12. eller 24. time, slik at alle oppføringer mottas som forventet. Det kreves et partnertilgangstoken for å bruke denne API-en. Du kan skaffe deg et partnertilgangstoken og administrere det i henhold til standardprinsippene for administrasjon av Webex Developer-tilgangstoken.
API-endepunkt for avstemming
Avstemnings-API-endepunktet returnerer antall oppføringer generert av hver kunde som administreres av partneren i den angitte tidsperioden. Hvis en partner administrerer mer enn 200 kundeorganisasjoner, vil resultatene fra API-en pagineres for bedre lesbarhet. Du kan bruke disse totalene til å sjekke mot den lokale lagringen hvis det mangler oppføringer for bestemte kunder. Du finner URL-adressen til avstemnings-API-endepunktet her:
https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
Parametre
Avstemnings-API kan bare kalles for en maksimal varighet på 1 time, med parameterne startTime og endTime ikke mer enn 60 minutter fra hverandre. API-en kan brukes for en hvilken som helst periode på 1 time mellom 5 minutter og 48 timer siden, men for å administrere servicebelastningen kan bare én time ringes om gangen.
Tilgjengelige parametre er:
- startTime (streng) – Tidspunktet for den første rapporten du vil samle inn. Rapporteringstiden angir tidspunktet for fullføring av samtalen.
Du må formatere tiden som
ÅÅÅÅ-MM-DDTHH:MM:SS.mmmZ. - endTime (streng) – Tidspunktet for den siste rapporten du vil samle inn. Rapporteringstiden angir tidspunktet for fullføring av samtalen.
Det angitte tidspunktet må være senere enn
startTime, men ikke senere enn 48 timer, og du må formatere tiden somÅÅÅÅ-MM-DDTHH:MM:SS.mmmZ.
Her er et eksempel på hvordan et Reconciliation API-endepunkt JSON returnyttelast ser ut:
{ "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": 278 } ] } Topptekstene i API-svaret angir totalt antall organisasjoner som er returnert, og om det er ekstra sider. Kontroller følgende parametere for å sikre at alle sidene har blitt spurt.
antall sider = 2 totalt antall organisasjoner = 283 gjeldende side = 1 Parameterne ovenfor viser at den gjeldende siden er den første siden, at det er 2 sider totalt, og at hele svaret inneholder 283 organisasjoner. Gå til den andre siden ved å legge til parameteren page=2 i GET -forespørselen, 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
Records API-endepunkt
Dette API-endepunktet returnerer samtaleoppføringer i JSON-format, identisk med formatet som beskrevet i API for detaljert samtalehistorikk. Den returnerte nyttelasten inneholder de samme feltene som den returnerte nyttelasten i detaljert anropslogg. Du finner mer informasjon om verdiene i hvert felt som returneres her. API-endepunktet for oppføringer brukes til å spørre etter manglende oppføringer for organisasjoner der oppføringer mangler. Du finner URL-adressen for postens API-endepunkt 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
-
orgID – Organisasjons-ID-en du vil spørre etter oppføringer for. Du kan åpne disse identifikatorene fra det foregående avstemningsendepunktet.
-
startTime (streng) – Tidspunktet for den første rapporten du vil samle inn. Rapporteringstiden angir tidspunktet for fullføring av samtalen.
Det angitte tidspunktet må være mellom 5 minutter siden og 48 timer siden, og du må formatere tiden som
ÅÅÅÅ-MM-DDTHH:MM:SS.mmmZ. -
endTime (streng) – Tidspunktet for den siste rapporten du vil samle inn. Rapporteringstiden angir tidspunktet for fullføring av samtalen.
Det angitte tidspunktet må være senere enn
startTime, men ikke senere enn 48 timer, og du må formatere tiden somÅÅÅÅ-MM-DDTHH:MM:SS.mmmZ.