- Etusivu
- /
- Artikkeli
Webex Calling multi-tenant (MT) -kumppanit voivat perustaa webhookin keräämään Webex Calling -tietueita kaikille asiakkaillesi. Tämä mahdollistaa tehokkaan laskutuksen täsmäytyksen, analytiikan ja raportoinnin tarvitsematta kysyä jokaiselta asiakkaalta erikseen.
Yleiskatsaus
Yksityiskohtainen puhelutietueiden webhook tarjoaa turvallisen, skaalautuvan ja vankan ratkaisun, jota ohjaavat tapahtumat eikä pyynnöt. Tämä webhook tarjoaa paremman näkyvyyden asiakkaidesi Webex Calling toimintaan ja tukee käyttötapauksia laskutuksesta räätälöityyn raportointiin.
Tämän webhookin avulla voit kerätä tietueita kätevästi kaikille Partner Hubin kautta hallinnoiduille asiakkaille kyselemättä kutakin asiakasta erikseen. Tämän webhookin avulla voit kehittää mukautettuja raportointi-, laskutus- ja analyyttisovelluksia sekä sisäisiin liiketoiminnan vaatimuksiin että lisä arvopalveluihin.
Katso johdannon webhookiin ja siihen liittyviin sovellusliittymiin katsomalla tätä Vidcast: Webex Calling Partner Detailed Call History API -sovellusliittymää.
Mitä Partner Webhook tarjoaa
Webhook toimittaa yksityiskohtaiset puheluhistoriatiedot 5 minuutin välein. Jokainen webhook-hyötykuorma sisältää:
- Puhelutietueet, jotka päättyivät 10 minuutista 5 minuuttiin ennen nykyistä aikaa.
- Kaikki Webex Calling pilven käsittelemät myöhäiset tietueet.
- Täyttää viivästyneet puhelutietueet automaattisesti seuraaviin webhook-hyötykuormiin luotettavan toimituksen varmistamiseksi .
Jos haluat näyttää, miten puhelutietueet sisältyvät kuhunkin hyötykuormaan, tarkastele seuraavaa esimerkkiä:
- Kello 14:05 vastaanotettu hyötykuorma sisältää puhelut, jotka päättyivät klo 13.55 ja 14.00 välisenä aikana.
- Klo 14.00—14.05 päättyvät puhelut sisältyvät 14:10 hyötykuormaan.
- Aikaisemmin valmistuneet tietueet (esimerkiksi kello 14.04 päät tynyt puhelu) mutta jotka Webex Calling pilvi käsittelee myöhässä (esimerkiksi klo 14.11), sisällytetään seuraavaan ajoitettuun hyötykuormaan ( esimerkiksi 14:15).
Webhookit toimittavat tietueita luotettavasti. Voit kuitenkin saada päällekkäisiä tietueita myöhemmissä webhook-hyötykuormissa, kun järjestelmä toistaa tietueita tietyissä olosuhteissa. Olet vastuussa tietojen kopioinnin poistamisesta. Jos haluat tunnistaa päällekkäiset tietueet, käytä ReportI d-kenttää ensisijaisena avaimena ja ReportTime- kenttää määrittääksesi, milloin puhelu on suoritettu tai käsitelty. Näiden kenttien avulla voit päivittää tai lisätä tietueet sisäisiin tietovarastoihin.
Webhook Partner Hubissa
Tarjoamalla webhookin, annat analyysialustan lähettää puhelutietueita takaisinsoitto-URL-osoitteeseesi aina, kun ne luodaan.
Webex Callingtietueet toimitetaan samassa muodossa kuin olemassa olevat yksityiskohtaiset puhelutietueiden sovellusliittymät. Voit määrittää webhookin ja valita kahden tyyppisen syötteen välillä:
- Analytiikka — Sisältää kaikki puhelutietueet kaikista asiakasorganisaatioista, joihin kumppanilla on Webex Calling suhde. Tähän kuuluvat organisaatiot, joissa:
- Kumppani hallinnoi asiakasorganisaatiota Partner Full Administrator -roolilla.
- Asiakasorganisaatiolla on aktiivinen Webex Calling tilaus kumppaniorganisaatiossa.
- Laskutus — Sisältää puhelutietueet puheluista, jotka käyttäjät ovat soittaneet, joilla on kumppanin myymä ja tarjoama Webex Calling lisenssi. Työtilojen puhelutietueet sisältyvät tähän syötteeseen.
Pääsy ja tietosuoja
Vain omistava kumppani voi käyttää Call Detail Records (CDR) laskutusta varten.
- Kumppani (tai alikumppani), joka hallinnoi puhelutietueeseen liittyvää lisenssiä, tulee omistava kumppani.
- Omistajuus määräytyy seuraavasti: Käyttäjätunnus > Lisenssitunnus > Tilaustunnus > Kumppanin tunnus.
- Jokainen CDR on yhden kumppanin käytettävissä.
- Jotkin puhelutietueet eivät yhdistä laskutuskumppaniin, eivätkä kaikki organisaatioon liittyvät kumppanit saa yhtäläistä pääsyä kaikkiin tietueisiin, koska nämä tietueet voivat sisältää henkilökohtaisia tunnistetietoja (PII).
Webhookin takaisinsoitto-URL-osoitteen määrittäminen
Määritä webhook Partner Hubissa. Voit määrittää vain yhden webhookin kumppani organisaatiota kohti.
Varmista, että sinulla on Kumppanin täysi järjestelmänvalvojan rooli, jossa on ”Organisaation täysi järjestelmänvalvojan tason käyttöoikeus ” ja oikeus tarkistettuna Control Hubissa (valitse Hall inta > jät -kohdasta täydellinen järjestelmänvalvoja tai kumppanin täysi järjestelmänvalvoja ja valitse sitten Järjestel mänvalvojan roolit > Kumppani).
Samat käyttöoikeusvaatimukset koskevat kumppanin täsmäytys- ja tietueiden sovellusliittymiä.
| 1 |
Kirjaudu sisään Partner Hubiin. |
| 2 |
Valitse .
|
| 3 |
Kirjoita Webhook -kohtaan käytettävä URL-osoite. URL-osoitteen on päätettävä numeroon /webhook (esimerkiksi https://yourdomain.com/webhook).
|
| 4 |
Jos haluat todentaa webhook-hyötykuormasi salaisella tunnuksella, voit lisätä sellaisen. Lisätietoja Webex-verkkokoukuista ja salaisista tunnuksista on artikkelissa Webex kehittäjille: Webhookit. |
| 5 |
Valitse jokin seuraavista Webhookissa käytettä vistä resurssity ypeistä:
|
Kumppanirajapinnan päätepisteet
Webhookin lisäksi, Webex Calling tarjoaa API-päätepisteitä tietojen täsmäytyksen tukemiseksi. Näiden päätepisteiden avulla voit korjata tai sovittaa yhteen tietovarastosi puuttuvien tietueiden kanssa, joita webhook-kuuntelija ei ehkä ole saanut. Kaksi API-päätepistettä ovat Recon ction API ja Records API.
Näiden sovellusliittymien tietueet ovat käytettävissä 30 päivän ajan. Varmistaaksesi, että saat kaikki odotetut tietueet, suosittelemme, että täsmätät levyvarastosi säännöllisesti, esimerkiksi 12 tai 24 tunnin välein.
Näiden sovellusliittymien käyttämiseen on käytettävä kumppanin käyttöoikeustunnusta. Todentavan käyttäjän on oltava kumppanin täysimääräinen järjestelmänvalvoja, jolla on organisaation täydet järjestelmänvalvojan tason käyttöoikeudet, ja Webex CallingCDR-sovellusliittymän käytön on oltava käytössä. OAuth-tunnuksen on sisällettävä laajuus spark-admin:calling_cdr_read. Vain luku -järjestelmänvalvojan roolit eivät riitä kumppanin täsmäytys- ja tietueiden sovellusliittymiin.
Käytä asiakasorganisaation Webex Calling tietoalueen päätepistettä. analytics-calling Käytä sovellettavaa perusURL-osoitetta sekä täsmäytys- että tietueiden sovellusliittymissä:
- Yhdysvallat ja Kanada:
https://analytics-calling.webexapis.com - Eurooppa:
https://analytics-calling-eu.webexapis.com - Intia:
https://analytics-calling-in.webexapis.com - Australia:
https://analytics-calling-au.webexapis.com
API-ikkuna-alueita voidaan soveltaa molempiin päätepisteisiin palvelun kuormituksen parantamiseksi.
- Yli 48 tunnin aikaväleillä sallittu ikkunan enimmäiskesto on 12 tuntia (pakotettu).
- Kumppaniorganisaation tunnuksen osalta sovellusliittymien nopeus on rajoitettu yhteen alustavaan API-pyyntöön minuutissa tunnuksen laajuutta kohden. Jos käytetään sivunnustamista, sallitaan enintään 10 ylimääräistä sivutettua API-pyyntöä minuutissa, tunnusta kohden, ja ne voidaan tehdä heti alkuperäisen pyynnön jälkeen.
Sovittelusliittymän päätepiste
Sovittelun sovellusliittymän päätepiste palauttaa kutakin kumppanin hallinnoimaa asiakasta varten luotujen puhelutietueiden kokonaismäärän määritetyn ajanjakson aikana. Näiden kokonaissummien avulla voit vahvistaa paikallisen tallennustilan ja tunnistaa tiettyjen asiakkaiden puuttuvat tai epäjohdonmukaiset puhelutietueet.
Käyttöoikeusvaatimus: Todentavan käyttäjän on oltava kumppanin järjestelmänvalvoja, jolla on täydet järjestelmänvalvojan tason käyttöoikeudet, ja Webex CallingCDR-sovellusliittymän käyttö oikeuden on oltava käytössä. Käyttöoikeustunnuksen on sisällettävä spark-admin:calling_cdr_readlaajuus.
Jos hallitset yli 200 asiakasorganisaatiota, API sivuttaa tulokset luettavuuden parantamiseksi.
Sovitteluohjelmointirajapinnan päätepisteen URL-osoite käyttää seuraavaa muotoa:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
API-parametrit
Voit käyttää sovellusliittymää hakemaan puhelutietueita viimeisten 30 päivän ajalta. Valitsemasi aikaikkunan on alettava vähintään 5 minuuttia ennen nykyistä UTC-aikaa, eikä se saa ylittää 12 tuntia alkamis- ja päättymisajan välillä yhdessä API-kutsussa.
API-parametrit ovat:
-
Aloitusaika (pakollinen, merkkijono) — Ensimmäisen kerättävän tietueen alkamispäivä ja -aika (UTC). Varmista, että
- Muotoilet ajan nimellä
YYYY-MM-DDTHH:MM:SS.mmmZ. Esimerkiksi,2025-08-15T06:00:00.000Z.
- Aloituspäivämäärä ja -aika eivät saa olla vanhempia kuin 30 päivää nykyisestä UTC-ajasta.
- Ikkuna välillä
startTimeja eiendTimevoi ylittää 12 tuntia.
- Muotoilet ajan nimellä
-
EndTime (pakollinen, merkkijono) —Kerättävien tietueiden päättymispäivä ja -aika (UTC). Tietueet perustuvat raporttiaikaan, jolloin puhelu on tehty. Varmista, että
- Muotoilet ajan nimellä
YYYY-MM-DDTHH:MM:SS.mmmZ. Esimerkiksi,2025-08-15T18:00:00.000Z. - Päättymispäivän ja -ajan on oltava 5 minuuttia ennen nykyistä UTC-aikaa eikä vanhempia kuin 30 päivää.
- Päättymispäivän ja -ajan on oltava suurempia kuin
startTime. - Ikkuna välillä ei
endTimesaa ylittää 12 tuntia.startTime
- Muotoilet ajan nimellä
Esimerkki täsmäytys-sovellusliittymän päätepisteen JSON-vastauksesta:
{
"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-vastausotsikot osoittavat palautettujen organisaatioiden kokonaismäärän ja onko lisäsivuja saatavilla. Tarkista seuraavat otsikkoparametrit varmistaaksesi, että olet kysynyt kaikki sivut:
- num-pages: Sivujen kokonaismäärä (esim. 2)
- organisaatioita yhteensä: Vastaukseen sisältyvien organisaatioiden kokonaismäärä (esimerkiksi 283)
- nykyinen sivu: Nykyinen sivunumero (esimerkiksi 1)
Jos esimerkiksi otsikoissa näkyy num-pages=2, total-orgs=283 ja current-page=1, näet kaksisivuisen vastauksen ensimmäistä sivua, joka sisältää yhteensä 283 organisaatiota. Päästäksesi seuraavalle sivulle, lisää parametri page=2 GET-pyyntöösi alla olevan kuvan mukaisesti:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2
Tallentaa sovellusliittymän päätepiste
Tietueiden sovellusliittymän päätepistettä käytetään kyselemään puuttuvia puhelutietueita tietyille organisaatioille, joissa ristiriitoja tai puuttuvia tietoja tunnistettiin Sovittelun sovellusliittymän avulla.
Suositeltu virtaus: So /v1/partners/cdrcountbyorgita ensin. Käytä sitten tarkkaa orgIdpalautettua numeroa, cdr_counts[].orgIdkun soitat /v1/partners/cdrsbyorg.
Tietueiden sovellusliittymä palauttaa puhelutietueet JSON-muodossa, joka on identtinen yksityiskohtaisen puheluhistorian sovellusliittymässä kuvatun muodon kanssa. Palautettu hyötykuorma sisältää samat kentät kuin Detailed Call History -palautettu hyötykuorma. Lisätietoja kentistä ja niiden arvoista on kohdassa Yksityiskohtainen puhel Webex Calling uhistoriaraportti.
API tarjoaa puhelutietueet, jotka päättyivät 5 minuuttia ennen nykyistä aikaa. Varmistaaksesi, että kaikki puhelutietueet ovat käytettävissä, suosittelemme kyselemään sovellusliittymältä tunnin kuluttua haluamastasi aikaikkunasta.
Tietueiden sovellusliittymän päätepisteen URL-osoite käyttää seuraavaa muotoa:
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-parametrit
-
orgId(pakollinen, merkkijono) — Asiakasorganisaation tunnus, jonka tietueet halutaan hakea. Parametrin nimi erottuu isot ja pienet kirjaimet. Voit hankkia organisaation tunnukset Sovittelun sovellusliittymän vastauskentästäcdr_counts[].orgId. -
Aloitusaika (pakollinen, merkkijono) — Ensimmäisen kerättävän tietueen alkamispäivä ja -aika (UTC). Varmista, että
- Muotoilet ajan nimellä
YYYY-MM-DDTHH:MM:SS.mmmZ. Esimerkiksi,2025-08-15T06:00:00.000Z. - Aloituspäivämäärä ja -aika eivät saa olla vanhempia kuin 30 päivää nykyisestä UTC-ajasta.
- Väli
startTimeja eiendTimesaa ylittää 12 tuntia yhdessä API-pyynnössä.
- Muotoilet ajan nimellä
-
EndTime (pakollinen, merkkijono) — Viimeisen kerättävän tietueen päättymispäivä ja -aika (UTC). Tietueet perustuvat raporttiaikaan, jolloin puhelu on tehty. Varmista, että
- Muotoilet ajan nimellä
YYYY-MM-DDTHH:MM:SS.mmmZ. Esimerkiksi,2025-08-15T18:00:00.000Z. - Päättymispäivän ja -ajan on oltava vähintään 5 minuuttia ennen nykyistä UTC-aikaa eikä vanhempia kuin 30 päivää.
- Päättymispäivän ja -ajan on oltava suurempia kuin
startTime. - Väli
startTimeja eiendTimesaa ylittää 12 tuntia yhdessä API-pyynnössä.
- Muotoilet ajan nimellä
-
max (valinnainen, numero) — Rajoittaa vastauksen tietueiden enimmäismäärää sivua kohden. Varmista, että
- Vaihteluväli on 500-5000. Oletusarvo on 5000. Esimerkiksi,
max=1000. - Jos sovellusliittymässä on enemmän palautettavia tietueita kuin määritetty enimmäisarvo, vastaus sivutetaan.
- Jos arvo on alle 500, se säädetään automaattisesti 500 arvoon. Jos arvo on yli 5000, se säädetään 5000: een.
- Vaihteluväli on 500-5000. Oletusarvo on 5000. Esimerkiksi,
Sivunumerointi
Jos haluat selvittää, onko API-vastaukset sivutettu, tarkista linkkiotsikko vastausotsikoista. Jos nextlinkki on Linkin otsikossa, purkaa se ja käytä startTimeForNextFetcharvoa seuraavan tietuejoukon pyytämiseen. Jos seuraavaa linkkiä ei ole, kaikki valitun ajanjakson raportit kerätään.
Seuraavien sivujen API-pyynnöt voidaan tehdä välittömästi, mutta niiden määrä on rajoitettava enintään 10 sivuttuun pyyntöön minuutissa tunnuksen laajuutta kohden.
Käytä idempotenttista käsittelyä ja päällekkäisyyksien poistamista, kun haet tietueita, mukaan lukien sivuttujen vastausten tai toistuvien täsmäytysikkunoiden välillä. Käytä ensisij reportIdaisena avaimena ja määr reportTimeitä viimeisin käsitelty tietue.
Esimerkiksi, jos alkuperäinen API-pyyntö on:
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
sitten linkin otsikko vastauksessa on:
<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"
Sivunvaihto käyttää vain rel="next"Link-otsikkoa. Jos vastaus sisältää rel="next"linkin, nouda seuraava tietuesivu kyseisellä URL-osoitteella. Jos vastaus ei sisällä rel="next"linkkiä, olet hakenut kaikki käytettävissä olevat tietueet valitulle ajanjaksolle.
Tämän sovellusliittymän sivunointi noudattaa RFC5988 (Web Linking) -standardia. Lisätietoja on kohdassa REST API Basics.
Ymmärrä API-päätelaitteen vastauskoodit
Tässä osassa on yleiskatsaus yleisistä vastauskoodeista, joita voidaan kohdata työskenneltäessä täsmäytys-sovellusliittymän päätepisteen ja tiet ueiden sovellus liittymän päätepisteen kanssa. Näillä päätepisteillä on kriittinen rooli tietojen synkronoinnissa, validoinnissa ja raportoinnissa. Näiden vastauskoodien ymmärtäminen on välttämätöntä teho kkaan vianmäärityksen ja luotettavien ja vakaiden integraatioiden ylläpitämiseksi.
|
Vastauskoodi |
Vastauskoodin kuvaus |
|---|---|
|
200 |
OK |
|
400 |
Virheellinen pyyntö: Pyyntö oli virheellinen tai sitä ei voida muuten toimittaa. Mukana oleva virheilmoitus selittää tarkemmin. |
|
401 |
Luvat on: Todennustiedot puuttuivat tai olivat virheellisiä. |
|
403 |
Kielletty: Pyyntö ymmärretään, mutta se on hylätty tai pääsy ei ole sallittua. |
|
404 |
Ei löy dy: Pyydetty URI on virheellinen tai pyydettyä resurssia, kuten käyttäjää, ei ole olemassa. Palautetaan myös, kun pyydetty menetelmä ei tue pyydettyä muotoa. |
|
405 |
Menetelmä ei sall ittu: Pyyntö tehtiin resurssille HTTP-pyyntömenetelmällä, jota ei tueta. |
|
409 |
Risti riita: Pyyntöä ei voitu käsitellä, koska se on ristiriidassa järjestelmän vakiintuneen säännön kanssa. Esimerkiksi henkilöä ei saa lisätä huoneeseen useammin kuin kerran. |
|
410 |
Poissa: Pyydetty resurssi ei ole enää käytettävissä. |
|
415 |
Tietovälinetyyppi, jota ei tu eta: Pyyntö tehtiin resurssille määrittelemättä tietovälinetyyppiä tai käytettiin tietovälinetyyppiä, jota ei tueta. |
|
423 |
Lukittu: Pyydetty resurssi ei ole väliaikaisesti käytettävissä. Retry-After-otsikko voi olla läsnä, joka määrittää, kuinka monta sekuntia sinun on odotettava, ennen kuin yrität pyytää uudelleen. |
|
428 |
Edellytys: Tiedostoja ei voi tarkistaa haittaohjelmien varalta, ja ne on pakkoladattava. |
|
429 |
Liian monta pyyn töä: Liian monta pyyntöä on lähetetty tietyn ajan kuluessa ja pyyntö on rajoitettu. Retry-After-otsikon tulisi olla läsnä, joka määrittää, kuinka monta sekuntia sinun on odotettava, ennen kuin onnistunut pyyntö voidaan tehdä. |
|
451 |
Oletusarvoisesti, pyynnöt reiti |
|
500 |
Sisäinen palvelinvirhe: Jokin meni pieleen palvelimella. Jos ongelma jatkuu, ota rohkeasti yhteyttä [Webexin kehittäjien tukitiimiin] (/explore/support). |
|
502 |
Virheellinen yhdyskäytä vä: Palvelin sai virheellisen vastauksen ylävirran palvelimelta pyynnön käsittelyn aikana. Yritä myöhemmin uudelleen. |
|
503 |
Palvelu ei ole käytettävissä: Palvelin on ylikuormitettu pyynnöillä. Yritä myöhemmin uudelleen. |
|
504 |
Yhdyskäytävän aikakat kaisu: Ylävirran palvelin ei reagoinut ajoissa. Jos kyselysi käyttää maksimiparametria, yritä pienentää sitä. |
Kumppaniraporttien/mallien API
Voit luoda ja ladata Partner Hubissa saatavilla olevia raportteja käyttämällä Partner Reports -sovellusliittymiä. Lisätietoja on kumppaniraportissa/malleissa.
Kumppanit voivat myös käyttää ja ladata useita raportteja suoraan Partner Hubista. Lisätietoja on kohdassa Partner Hub -raportit.
Versiohistoria
Asiakirjan versiohistoria
|
Tarkistuspäivä |
Teimme seuraavat muutokset artikkeliin |
|---|---|
|
13/08/26 |
|
|
2/04/2026 |
|