Tässä artikkelissa
Yleiskatsaus
Määritä webhook-kutsuosoitteen URL-osoite
dropdown icon
Kumppanin API-päätepisteet
    Täsmäytys-API-päätepiste
    Tietueiden API-päätepiste
    Kumppani reports/templates API

Yksityiskohtaiset puhelutietojen webhook-työkalut Webex Callingille Partner Hubissa

list-menuTässä artikkelissa
list-menuOnko sinulla palautetta?

Webex Callingin monivuokralaiset (MT) kumppanit voivat määrittää webhookin kerätäkseen Webex Calling -tietueet kaikista asiakkaistasi. Tämä mahdollistaa tehokkaan laskutuksen täsmäytyksen, analytiikan ja raportoinnin ilman, että jokaista asiakasta tarvitsee kysellä erikseen.

Yleiskatsaus

Yksityiskohtaisten puhelutietojen webhook tarjoaa turvallisen, skaalautuvan ja vankan ratkaisun, jota ohjaavat tapahtumat pyyntöjen sijaan. Tämä webhook tarjoaa paremman näkyvyyden asiakkaidesi Webex Calling -toimintaan ja tukee käyttötapauksia laskutuksesta räätälöityyn raportointiin.

Voit käyttää tätä webhookia kerätäksesi kätevästi kaikkien Partner Hubin kautta hallinnoitujen asiakkaiden tietueita ilman, että jokaista asiakasta tarvitsee kysellä erikseen. Tämän webhookin avulla voit kehittää mukautettuja raportointi-, laskutus- ja analytiikkasovelluksia sekä sisäisiin liiketoimintatarpeisiin että lisäarvopalveluihin.

Katso tämä Videocast, niin pääset tutustumaan webhookiin ja siihen liittyviin API-rajapintoihin: Webex-puhelukumppanin yksityiskohtainen puheluhistorian API.

Mitä Partner-webhook tarjoaa

Webhook toimittaa yksityiskohtaiset puheluhistoriatiedot viiden minuutin välein. Jokainen webhook-hyötykuorma sisältää:

  • Puhelutiedot, jotka päättyivät 10–5 minuuttia ennen nykyistä aikaa.
  • Webex Calling Cloudin käsittelemät myöhästyneet tietueet.
  • Täyttää automaattisesti myöhästyneiden puheluiden tietueet seuraavissa webhook-hyötykuormissa luotettavan toimituksen varmistamiseksi.

Seuraavalla esimerkillä voidaan havainnollistaa, miten puhelutietueet sisällytetään kuhunkin hyötykuormaan:

  • Hyötykuorma vastaanotettu klo 14:05 sisältää puhelut, jotka päättyivät välillä 13:55 ja 14:00.
  • Puhelut, jotka päättyvät välille 14:00 ja 14:05 sisältyvät 14:10 hyötykuorma.
  • Aiemmin suoritetut tietueet (esimerkiksi puhelu, joka päättyi klo 14:04) mutta Webex Calling Cloud käsitteli sen myöhässä (esimerkiksi klo 14:11) sisältyvät seuraavaan ajoitettuun hyötykuormaan (esimerkiksi 14:15).

Webhookit toimittavat tietueita luotettavasti. Saatat kuitenkin saada päällekkäisiä tietueita myöhemmissä webhook-hyötykuormissa, kun järjestelmä toistaa tietueita tietyissä olosuhteissa. Olet vastuussa tietueiden kaksoiskappaleiden poistosta. Voit tunnistaa kaksoiskappaleet käyttämällä reportId -kenttää ensisijaisena avaimena ja reportTime -kenttää määrittääksesi, milloin kutsu suoritettiin tai käsiteltiin. Käytä näitä kenttiä päivittääksesi tai lisätäksesi tietueita sisäisiin tietovarastoihin.

Webhook Parter Hubissa

Tarjoamalla webhookin annat analytiikka-alustalle mahdollisuuden lähettää puhelutietueita callback-URL-osoitteeseesi aina, kun ne luodaan.

Webex-puhelutietueet toimitetaan samassa muodossa kuin olemassa olevat yksityiskohtaiset puhelutietojen API:t . Voit määrittää webhookin ja valita kahden tyyppisen syötteen välillä:

  • Analytiikka – Sisältää kaikkien niiden asiakasorganisaatioiden kaikki puhelutietueet, joiden kanssa kumppanilla on Webex Calling -suhde. Tämä koskee myös organisaatioita, joissa:
    • Kumppani hallinnoi asiakasorganisaatiota kumppanin täysivaltaisen järjestelmänvalvojan roolilla.
    • Asiakasorganisaatiolla on aktiivinen Webex Calling -tilaus kumppaniorganisaatiossa.
  • Laskutus – Sisältää puhelutiedot, jotka ovat tehneet käyttäjät, joilla on kumppanin myymä ja toimittama Webex Calling -lisenssi. Työtilojen puhelutietueet sisältyvät tähän syötteeseen.

Käyttöoikeus ja tietosuoja

Vain omistava kumppani voi käyttää puhelutietoja (CDR) laskutusta varten.

  • Puhelutietueeseen liittyvää lisenssiä hallinnoivasta kumppanista (tai alikumppanista) tulee omistava kumppani.
  • Omistajuus määräytyy seuraavien perusteella: Käyttäjätunnus > Lisenssitunnus > Tilaustunnus > Kumppanin tunnus.
  • Jokainen CDR on yhden kumppanin käytettävissä.
  • Jotkin puhelutietueet eivät liity laskutuskumppaniin, eivätkä kaikki organisaatioon liittyvät kumppanit saa yhtäläistä pääsyä kaikkiin tietueisiin, koska nämä tietueet voivat sisältää henkilötietoja.

Määritä webhook-kutsuosoitteen URL-osoite

Määritä webhook Partner Hubissa. Voit määrittää vain yhden webhookin kumppaniorganisaatiota kohden.

Varmista, että sinulla on kumppanin täysi järjestelmänvalvojan rooli ja 'Organisaation täydet järjestelmänvalvojan oikeudet' ja että Webex Calling CDR API -käyttöoikeus on valittuna Control Hubissa (kohdassa Hallinta > Käyttäjät, valitse täysi järjestelmänvalvoja tai kumppanin täysi järjestelmänvalvoja ja valitse sitten Järjestelmänvalvojan roolit > Kumppani).

Kuvakaappaus, jossa näkyvät järjestelmänvalvojan roolien asetukset, joissa on valittuna kumppanin järjestelmänvalvoja ja kumppanin täysi järjestelmänvalvoja sekä Webex Calling CDR API -käyttöoikeus -valintaruukuna toiminnallisissa asetuksissa.

1

Kirjaudu sisään Partner Hubiin.

2

Siirry kohtaan Organisaatioasetukset > Puhelutietojen tiedot.

Kuvakaappaus puhelutietojen tietueiden organisaatioasetuksista, jossa näkyvät webhookin URL-osoitteen, salaisuuden tunnuksen ja resurssityypin kentät analytiikka valittuna.
3

Syötä käytettävä URL-osoite kohdassa Webhook.

URL-osoitteen on päätyttävä /webhook (esimerkiksi, https://yourdomain.com/webhook).
4

Jos haluat todentaa webhook-hyötykuormasi salaisella tunnuksella, voit lisätä sellaisen. Lisätietoja Webex-webhookeista ja salaisista tokeneista on kohdassa Webex kehittäjille: Webhookit.

5

Valitse jokin seuraavista resurssityypeistä käytettäväksi webhookissa:

  • Analytiikka— Sisältää kaikkien niiden asiakasorganisaatioiden kaikki puhelutietueet, joiden kanssa kumppanilla on Webex Calling -suhde.
  • Laskutus— Sisältää niiden käyttäjien puhelutietueet, joille kumppani myi Webex Calling -lisenssejä. Työtilojen puhelutietueet sisältyvät tähän syötteeseen.

Kumppanin API-päätepisteet

Webhookin lisäksi Webex Calling tarjoaa API-päätepisteitä tietojen täsmäytyksen tukemiseksi. Näiden päätepisteiden avulla voit tarkistaa tai täsmäyttää tietovarastosi puuttuvien tietueiden kanssa, joita webhook-kuuntelijasi ei ehkä ole vastaanottanut. Kaksi API-päätepistettä ovat Reconciliation API ja Records API.

Näiden API-rajapintojen tietueet ovat saatavilla 30 päivän ajan. Jotta saat varmasti kaikki odotetut tiedot, suosittelemme täsmäyttämään tiedot säännöllisesti, esimerkiksi 12 tai 24 tunnin välein.

Sinun on käytettävä kumppanin käyttöoikeustunnusta käyttääksesi näitä API-rajapintoja. Hanki ja hallinnoi kumppanisi käyttöoikeustunnusta Webex-kehittäjän käyttöoikeustunnusten hallintakäytäntöjen mukaisesti.

API-ikkuna-alueet soveltuvat molempiin päätepisteisiin palvelun kuormituksen paremman käsittelyn takaamiseksi.

  • Yli 48 tunnin aikaväleillä sallittu enimmäiskesto on 12 tuntia (suositus ja valvonta).
  • 48 tunnin tai lyhyempien aikavälien kohdalla sallittu enimmäiskesto on 48 tuntia (ei suositella; tämä vaihtoehto poistuu käytöstä 30. tammikuuta 2026).
  • Kumppaniorganisaatiotunnuksen API-rajapintojen käyttönopeus on rajoitettu yhteen ensimmäiseen API-pyyntöön minuutissa token-laajuusaluetta kohden. Jos sivutusta käytetään, sallitaan jopa 10 ylimääräistä sivutettua API-pyyntöä minuutissa tokenia kohden, ja nämä voidaan tehdä heti alkuperäisen pyynnön jälkeen.

Täsmäytys-API-päätepiste

Täsmäytys-API-päätepiste palauttaa kumppanin hallinnoimien kunkin asiakkaan puhelutietueiden kokonaismäärän määritetyn ajanjakson aikana. Voit käyttää näitä kokonaismääriä paikallisen tallennustilasi tarkistamiseen ja tiettyjen asiakkaiden puuttuvien tai epäjohdonmukaisten puhelutietojen tunnistamiseen.

Jos hallinnoit yli 200 asiakasorganisaatiota, API sivuttaa tulokset luettavuuden parantamiseksi.

Täsmäytys-API:n päätepisteen URL-osoite on seuraavassa muodossa:

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ää API:a puhelutietojen hakemiseen viimeisten 30 päivän ajalta. Valitun aikaikkunan on alettava vähintään 5 minuuttia ennen nykyistä UTC-aikaa, eikä yhden API-kutsussa saa olla yli 12 tuntia alkamis- ja päättymisaikojen välillä.

API-parametrit ovat:

  • aloitusaika (pakollinen, merkkijono)—Kerättävän ensimmäisen tietueen aloituspäivämäärä ja -aika (UTC). Varmista, että:
    • Muotoilet kellonajan muotoon YYYY-MM-DDTHH:MM:SS.mmmZ. Esimerkiksi, 2025-08-15T06:00:00.000Z.
    • Aloituspäivämäärän ja -kellonajan ei saa olla yli 30 päivää vanhempi kuin nykyinen UTC-aika.
    • startTime ja endTime välinen aika ei saa olla yli 12 tuntia.
  • endTime (pakollinen, merkkijono)—Kerättyjen tietueiden päättymispäivämäärä ja -aika (UTC). Tiedot perustuvat raportointiaikaan eli puhelun päättymisaikaan. Varmista, että:
    • Muotoilet kellonajan muotoon YYYY-MM-DDTHH:MM:SS.mmmZ. Esimerkiksi, 2025-08-15T18:00:00.000Z.
    • Päättymispäivämäärän ja -kellonajan on oltava viisi minuuttia ennen nykyistä UTC-aikaa, eikä niiden saa olla yli 30 päivää vanhoja.
    • Päättymispäivämäärän ja -kellonajan on oltava suurempi kuin startTime.
    • Merkkien startTime ja endTime välinen aika ei saa olla yli 12 tuntia.

Esimerkki täsmäytys-API: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 sen, onko saatavilla lisää sivuja. Tarkista seuraavat otsikkoparametrit varmistaaksesi, että olet hakenut kaikki sivut:

  • sivujen määrä: Sivujen kokonaismäärä (esimerkiksi 2)
  • total-orgs: Vastaukseen sisältyvien organisaatioiden kokonaismäärä (esimerkiksi 283)
  • nykyinen sivu: Nykyinen sivunumero (esimerkiksi 1)

Jos otsikot esimerkiksi näkyvät num-pages=2, total-orgs=283, ja current-page=1, Katselet kaksisivuisen vastauksen ensimmäistä sivua, joka sisältää yhteensä 283 organisaatiota. Päästäksesi seuraavalle sivulle, lisää page=2 parametri GET-pyyntöösi, kuten alla on esitetty:

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

Tietueiden API-päätepiste

Records API -päätepistettä käytetään puuttuvien puhelutietueiden kyselyyn tietyissä organisaatioissa, joissa täsmäytys-API:n avulla on tunnistettu ristiriitaisuuksia tai puuttuvia tietoja.

Records-API palauttaa puhelutietueet JSON-muodossa, joka on identtinen Detailed Call History API:ssakuvatun muodon kanssa. Palautettu hyötykuorma sisältää identtiset kentät kuin palautettu yksityiskohtaisen puheluhistorian hyötykuorma. Lisätietoja kentistä ja niiden arvoista on kohdassa Webex-puheluiden yksityiskohtainen puheluhistoriaraportti.

API tarjoaa puhelutietueita, jotka päättyivät 5 minuuttia ennen nykyistä aikaa. Jotta kaikki puhelutietueet ovat varmasti saatavilla, suosittelemme tekemään kyselyn API:sta tunnin kuluttua haluamasi aikavälin jälkeen.

Records API:n päätepisteen URL-osoite on seuraavassa muodossa:

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) – Organisaation tunnus, jolle haluat hakea tietueita. Voit hankkia organisaatiotunnukset täsmäytysrajapinnasta.
  • aloitusaika (pakollinen, merkkijono)—Kerättävän ensimmäisen tietueen aloituspäivämäärä ja -aika (UTC). Varmista, että:
    • Muotoilet kellonajan muotoon YYYY-MM-DDTHH:MM:SS.mmmZ. Esimerkiksi, 2025-08-15T06:00:00.000Z.
    • Aloituspäivämäärän ja -kellonajan ei saa olla yli 30 päivää vanhempi kuin nykyinen UTC-aika.
    • Yhden API-pyynnön startTime ja endTime välinen aika ei saa ylittää 12 tuntia.
  • endTime (pakollinen, merkkijono)—Kerättävän viimeisen tietueen päättymispäivämäärä ja -aika (UTC). Tiedot perustuvat raportointiaikaan eli puhelun päättymisaikaan. Varmista, että:
    • Muotoilet kellonajan muotoon YYYY-MM-DDTHH:MM:SS.mmmZ. Esimerkiksi, 2025-08-15T18:00:00.000Z.
    • Päättymispäivämäärän ja -kellonajan on oltava vähintään 5 minuuttia ennen nykyistä UTC-aikaa ja enintään 30 päivää vanha.
    • Päättymispäivämäärän ja -kellonajan on oltava suurempi kuin startTime.
    • Yhden API-pyynnön startTime ja endTime välinen aika ei saa ylittää 12 tuntia.
  • Max (valinnainen, numero) — Rajoittaa vastauksessa olevien tietueiden enimmäismäärää sivua kohden. Varmista, että:
    • Vaihteluväli on 500–5000. Oletusarvo on 5000. Esimerkiksi, Max=1000.
    • Jos API:lla on palautettavana enemmän tietueita kuin määritetty Max-arvo, vastaus sivutetaan.
    • Jos arvoksi annetaan alle 500, se nostetaan automaattisesti arvoon 500. Jos arvoksi annetaan yli 5000, se säädetään alaspäin arvoon 5000.

Sivunumerointi

Voit tarkistaa, onko API-vastauksissa sivutus, tarkistamalla vastausten otsikoista linkkiotsikon. Jos linkkiotsikossa on next -linkki, pura se ja käytä startTimeForNextFetch -arvoa seuraavan tietuejoukon pyytämiseen. Jos seuraavaa linkkiä ei ole, kaikki valitun aikavälin raportit kerätään.

Seuraavien sivujen API-pyyntöjä voidaan tehdä välittömästi, mutta niiden määrä on rajoitettava enintään 10 sivutettuun pyyntöön minuutissa token-laajuusaluetta kohden.

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

niin vastauksen linkkiotsikko on:

; rel="next"

Muita mahdollisia linkkiarvoja ovat rel="first" ja rel="prev" ensimmäiselle ja edelliselle sivulle.

Tämän API:n sivutus noudattaa RFC5988 (Web Linking) -standardia. Lisätietoja on kohdassa REST API:n perusteet.

Kumppani reports/templates API

Voit luoda ja ladata Partner Hubissa saatavilla olevia raportteja Partner Reports -rajapintojenavulla. Lisätietoja on -kumppanin sivustolla. report/templates.

Kumppanit voivat myös käyttää ja ladata useita raportteja suoraan Partner Hubista. Lisätietoja on kohdassa Partner Hub -raportit.

Oliko tästä artikkelista apua?
Oliko tästä artikkelista apua?