V tem članku
Pregled
Nastavite URL za povratni klicni naslov webhook
dropdown icon
Končne točke partnerskega API-ja
    Končna točka API za usklajevanje
    Končna točka zapisa API
Razumevanje kod odziva končnih točk API-ja
API za poročila/predloge partnerjev
Zgodovina revizij
Podrobna spletna povezava zapisov klicev za Webex Calling v partnerskem središču
list-menuV tem članku
list-menuPovratne informacije?

Webex Calling partnerji z več najemniki (MT) lahko vzpostavijo spletno povezavo za zbiranje Webex Calling zapisov za vse vaše stranke. To omogoča učinkovito usklajevanje računov, analitiko in poročanje, ne da bi bilo treba vsako stranko posebej poizvedeti.

Pregled

Spletni priključek Detailed Call Records ponuja varno, razširljivo in robustno rešitev, ki jo poganjajo dogodki in ne zahteve. Ta spletna povezava zagotavlja večjo prepoznavnost Webex Calling dejavnosti vaših strank in podpira primere uporabe od obračunavanja do poročanja po meri.

S tem spletnim priključkom lahko priročno zbirate zapise za vse stranke, ki jih upravlja prek Partner Hub, ne da bi pri tem povpraševali vsako stranko posebej. Ta spletna povezava vam omogoča razvoj aplikacij za poročanje, obračunavanje in analitiko po meri za notranje poslovne zahteve in storitve z dodano vrednostjo.

Za uvod v spletno povezavo in spremljajoče API-je si oglejte ta API Vidcast: Webex Calling Partner Detailed Call History.

Kaj ponuja partnerski webhook

Webhook vsakih 5 minut ponuja podrobne zapise zgodovine klicev. Vsak koristni tovor webhook vsebuje:

  • Zapisi klicev, ki so se končali med 10 minutami in 5 minutami pred trenutnim časom.
  • Vsi pozni zapisi, ki jih obdeluje Webex Calling oblak.
  • Samodejno poskrbi zapise poznih klicev v naslednjih uporabnih obremenitvah spletnega priključka, da zagotovi zanesljivo dostavo .

Če želite prikazati, kako so zapisi klicev vključeni v vsako koristno tovor, upoštevajte naslednji primer:

  • Uporabni tovor, prejet ob 14:05, vsebuje klice, ki so se končali med 13:55 in 14:00.
  • Klici, ki se končajo med 14:00 in 14:05, so vključeni v koristni tovor 14:10.
  • Zapisi, dokončani prej (na primer klic, ki se je končal ob 14:04), vendar so pozno obdelani v Webex Calling oblaku (na primer ob 14:11), so vključeni v naslednjo načrtovano koristno obremenitev (na primer 14:15).

Spletne kljuke zanesljivo zagotavljajo zapise. Vendar pa lahko prejmete podvojene zapise v naslednjih uporabnih obremenitvah spletnega priključka, ko sistem pod določenimi pogoji ponovi zapise. Odgovorni ste za ravnanje z odstranjevanjem podvajanja zapisov. Če želite prepoznati podvojene zapise, uporabite polje ReportID kot primarni ključ in polje ReportTime, da ugotovite, kdaj je bil klic zaključen ali obdelan. S temi polji posodobite ali vstavite zapise v notranje shrambe podatkov.

Webhook v partnerskem središču

Z zagotavljanjem spletnega kljuka omogočite analitični platformi, da pošilja zapise klicev na vaš URL povratnega klica, kadar koli so ustvarjeni.

Webex Callingzapisi se dostavljajo v isti obliki kot obstoječi API-ji podrobnih zapisov klicev. Nastavite lahko spletno povezavo in izbirate med dvema vrstama vira:

  • Analitika — vključuje vse zapise klicev za vse organizacije strank, s katerimi ima Webex Calling partner odnos. To vključuje organizacije, kjer:
    • Partner upravlja organizacijo strank z vlogo polnega skrbnika partnerja.
    • Organizacija strank ima aktivno Webex Calling naročnino znotraj partnerske organizacije.
  • Obračunavanje — vključuje zapise klicev za klice uporabnikov z Webex Calling licenco, ki jo je prodal in zagotovil partner. Zapisi klicev za delovne prostore so vključeni v ta vir.

Dostop in zasebnost podatkov

Za obračunavanje lahko dostopa le lastnik podatkov o klicih (CDR).

  • Partner (ali podpartner), ki upravlja licenco, povezano z zapisom klica, postane lastnik partnerja.
  • Lastništvo določajo: ID uporabnika > ID licence > ID naročnine > ID partnerja.
  • Vsak CDR je dostopen enemu partnerju.
  • Nekateri zapisi klicev se ne preslikajo na partnerja za zaračunavanje in vsi partnerji, povezani z organizacijo, nimajo enakega dostopa do vseh zapisov, saj lahko ti zapisi vsebujejo osebno prepoznavne podatke (PII).

Nastavite URL za povratni klicni naslov webhook

Konfigurirajte spletno povezavo v središču partnerjev. Na partnersko organizacijo lahko nastavite samo en spletni priključek.

Prepričajte se, da je v nadzornem središču preverjena polna skrbniška vloga partnerja z možnostjo « Dostop do celotnega skrbniškega nivoja organizacije »in dostop do vmesnika Webex Calling CDR API (v razdelku Upravljanje > Uporabniki izberite polnega skrbnika ali polnega skrbnika partnerja in nato izberite skrbniške vloge > Partner).

Pri uporabi API-jev za usklajevanje in zapise partnerjev veljajo enake zahteve glede dostopa.

Screenshot showing administrator roles settings with Partner admin and Partner full admin selected, along with Webex Calling CDR API Access checked under Functional settings.

1

Prijavite se v Partner Hub.

2

Pojdite na Nastavitve organizacije > Zapisi o podrobnostih klica.

Screenshot of Organization Settings for Call Detail Records, displaying fields for Webhook URL, Secret token, and Resource Type with Analytics selected.
3

Vnesite URL, ki ga želite uporabiti pod Webhook.

URL se mora končati z /webhook (na primer https://yourdomain.com/webhook).
4

Če želite overiti svoje uporabne obremenitve s skrivnim žetonom, ga lahko dodate. Če želite najti več informacij o Webex spletnih kljukah in skrivnih žetonih, glejte Webex za razvijalce: Webhook.

5

Izberite eno od naslednjih vrst vira, ki jo želite uporabiti za spletno povezavo:

  • Analitika — vključuje vse zapise klicev za vse organizacije strank, s katerimi ima partner Webex Calling odnos.
  • Obra čunavanje — vključuje zapise klicev za uporabnike, ki jim je partner prodal Webex Calling licence. Zapisi klicev za delovne prostore so vključeni v ta vir.

Končne točke partnerskega API-ja

Poleg spletnega priključka ponuja končne točke API Webex Calling za podporo usklajevanju podatkov. Te končne točke vam omogočajo, da dohitete ali uskladite shranjevanje podatkov z vsemi manjkajočimi zapisi, ki jih poslušalec spletnega priključka morda ni prejel. Dve končni točki API-ja sta API za usklad itev in API zapisa.

Zapisi iz teh API-jev so na voljo 30 dni. Če želite zagotoviti, da boste prejeli vse pričakovane zapise, priporočamo, da svoje zaloge plošč občasno usklajujete, na primer vsakih 12 ali 24 ur.

Za dostop do teh API-jev morate uporabiti žeton partnerskega dostopa. Uporabnik, ki potrjuje preverjanje pristnosti, mora biti polni skrbnik partnerja z dostopom do celotnega skrbniškega nivoja organizacije in mora imeti omogočen dostop do Webex Calling CDR API- ja. Žeton OAuth mora vključevati obseg. spark-admin:calling_cdr_read Skrbniške vloge samo za branje ne zadostujejo za API-je za usklajevanje partnerjev in zapise.

Uporabite kon analytics-callingčno točko za podatkovno regijo Webex Calling organizacije stranke. Uporabite ustrezen osnovni URL za API-je za usklajevanje in zapise:

  • ZDA in Kanada: https://analytics-calling.webexapis.com
  • Evropa: https://analytics-calling-eu.webexapis.com
  • Indija: https://analytics-calling-in.webexapis.com
  • Avstralija: https://analytics-calling-au.webexapis.com

Razpon oken API se uporablja za obe končni točki za boljše obvladovanje obremenitve storitev.

  • Za časovne razpone, daljše od 48 ur, je najdaljše dovoljeno trajanje okna 12 ur (prisiljeno).
  • Za ID partnerske organizacije so API-ji omejeni na eno začetno zahtevo API-ja na minuto na obseg žetona. Če uporabimo paginiranje, je dovoljenih do 10 dodatnih stranskih zahtev API na minuto na žeton, ki jih je mogoče opraviti takoj po začetni zahtevi.

Končna točka API za usklajevanje

Končna točka API za uskladitev vrne skupno število zapisov klicev, ustvarjenih za vsako stranko, ki jo upravlja partner v določenem časovnem obdobju. Te vsote lahko uporabite za preverjanje lokalnega pomnilnika in prepoznavanje manjkajočih ali nedoslednih zapisov klicev za določene stranke.

Zahteva za dostop: Uporabnik, ki potrjuje preverjanje pristnosti, mora biti skrbnik partnerja s popolnim dostopom na skrbniški ravni in mora imeti omogočen dostop do Webex Calling CDR API- ja. Žeton za dostop mora vključevati spark-admin:calling_cdr_readobseg.

Če upravljate več kot 200 organizacij strank, API strani rezultate za izboljšanje berljivosti.

URL končne točke API za uskladitev uporablja naslednjo obliko:

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

Parametri API

API lahko uporabite za pridobivanje zapisov klicev iz zadnjih 30 dni. Izbrano časovno okno se mora začeti vsaj 5 minut pred trenutnim časom UTC in ne sme presegati 12 ur med začetnim in končnim časom v enem klicu API.

Parametri API so:

  • StartTime (obvezno, niz) —začetni datum in čas (UTC) za prvi zapis, ki ga želite zbrati. Zagotovite, da:
    • Čas oblikujete kot YYYY-MM-DDTHH:MM:SS.mmmZ. Na primer, 2025-08-15T06:00:00.000Z.
    • Začetni datum in čas ne smejo biti starejši od 30 dni od trenutnega časa UTC.
    • Okno med startTimein endTimene sme presegati 12 ur.
  • EndTime (obvezno, niz) —končni datum in čas (UTC) za zapise, ki jih želite zbrati. Zapisi temeljijo na času poročanja, ki je takrat, ko je klic opravljen. Zagotovite, da:
    • Čas oblikujete kot YYYY-MM-DDTHH:MM:SS.mmmZ. Na primer, 2025-08-15T18:00:00.000Z.
    • Končni datum in čas morata biti 5 minut pred trenutnim časom UTC in ne starejši od 30 dni.
    • Končni datum in čas morata biti večji od startTime.
    • Okno med startTimein endTimene sme presegati 12 ur.

Primer odziva končne točke API-ja za usklajevanje JSON:


          {
          "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
          }
          ]
          }          
        

Odgovorne glave API-ja označujejo skupno število vrnjenih organizacij in ali so na voljo dodatne strani. Preverite naslednje parametre glave, da se prepričate, da ste vprašali vse strani:

  • num-pages: Skupno število strani (na primer 2)
  • skupni organi: Skupno število organizacij, vključenih v odgovor (na primer 283)
  • trenutna stran: trenutna številka strani (na primer 1)

Če na primer glave prikazujejo num-pages=2, total-orgs=283 in current-page=1, si ogledate prvo stran dvostranskega odziva, ki vsebuje skupaj 283 organizacij. Če želite dostopati do naslednje strani, v zahtevo GET dodajte parameter page = 2, kot je prikazano spodaj:

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

Končna točka zapisa API

Končna točka API-ja zapisi se uporablja za poizvedbo o manjkajočih zapisih klicev za določene organizacije, kjer so bile odstopanja ali manjkajoči podatki ugotovljeni z uporabo API-ja za uskladitev.

Priporočeni tok: /v1/partners/cdrcountbyorgNajprej pokličite. Nato uporabite točno orgIdvrnjeno vrednost, ko cdr_counts[].orgIdpokličete /v1/partners/cdrsbyorg.

API zapisi vrne zapise klicev v obliki JSON, ki je enaka obliki, opisani v API-ju Podrobna zgodovina klicev. Vrnjeni tovor vsebuje enaka polja vrnjenemu tovoru s podrobno zgodovino klicev. Če želite več informacij o poljih in njihovih vrednostih, glejte Webex CallingPodrobno poročilo o zgodovini klicev.

API ponuja zapise klicev, ki so se končali 5 minut pred trenutnim časom. Če želite zagotoviti, da so vsi zapisi klicev na voljo, priporočamo, da poizvedete API eno uro po želenem časovnem oknu.

URL končne točke API-ja Records uporablja naslednjo obliko:

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

Parametri API

  • orgId(obvezno, niz) —ID organizacije strank, za katerega želite pridobiti zapise. Ime parametra je občutljivo na velike in male črke. ID organizacije lahko pridobite iz polja odziva API-ja za uskladitev cdr_counts[].orgId.
  • StartTime (obvezno, niz) —začetni datum in čas (UTC) za prvi zapis, ki ga želite zbrati. Zagotovite, da:
    • Čas oblikujete kot YYYY-MM-DDTHH:MM:SS.mmmZ. Na primer, 2025-08-15T06:00:00.000Z.
    • Začetni datum in čas ne smejo biti starejši od 30 dni od trenutnega časa UTC.
    • Interval med startTimein endTimene sme presegati 12 ur v eni zahtevi za API.
  • EndTime (obvezno, niz) —končni datum in čas (UTC) za zadnji zapis, ki ga želite zbrati. Zapisi temeljijo na času poročanja, ki je takrat, ko je klic opravljen. Zagotovite, da:
    • Čas oblikujete kot YYYY-MM-DDTHH:MM:SS.mmmZ. Na primer, 2025-08-15T18:00:00.000Z.
    • Končni datum in čas morata biti vsaj 5 minut pred trenutnim časom UTC in ne starejši od 30 dni.
    • Končni datum in čas morata biti večji od startTime.
    • Interval med startTimein endTimene sme presegati 12 ur v eni zahtevi za API.
  • max (neobvezno, število) — omejuje največje število zapisov na stran v odgovoru. Zagotovite, da:
    • Razpon je od 500 do 5000. Privzeta vrednost je 5000. Na primer, max=1000.
    • Če ima API več zapisov za vrnitev od določene največje vrednosti, se odziv strani.
    • Če je določena vrednost pod 500, se samodejno prilagodi do 500. Če je določena vrednost nad 5000, se prilagodi na 5000.

Paginacija

Če želite ugotoviti, ali so odgovori API-ja stranirani, preverite glave odzivov za glavo povezave. Če je nextpovezava prisotna v glavi povezave, jo izvlecite in uporabite startTimeForNextFetchvrednost, da zahtevate naslednji niz zapisov. Če ni naslednje povezave, se zbirajo vsa poročila za izbrani časovni razpon.

Zahteve za API za naslednje strani je mogoče vložiti takoj, vendar morajo biti omejene na največ 10 stranskih zahtev na minuto na obseg žetona.

Pri pridobivanju zapisov uporabite obdelavo idempotent in odstranjevanje podvajanja, vključno s stranskimi odgovori ali ponavljajočimi se okni usklajevanja. Uporabite reportIdkot primarni ključ in za določ reportTimeitev zadnjega obdelanega zapisa.

Na primer, če je začetna zahteva za API:

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

potem je glava povezave v odgovoru:

<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"

Straniranje uporablja samo glavo rel="next"povezave. Če odgovor vključuje rel="next"povezavo, uporabite ta URL za pridobitev naslednje strani zapisov. Če odgovor ne vključuje rel="next"povezave, ste pridobili vse razpoložljive zapise za izbrani časovni razpon.

Stranizacija za ta API sledi standardu RFC5988 (spletno povezovanje). Za več informacij glejte Osnove API-ja REST.

Razumevanje kod odziva končnih točk API-ja

Ta razdelek vsebuje pregled pogostih kod odziva, ki se lahko pojavijo pri delu s končno točko API-ja za uskladitev in končno toč ko API-ja Records. Te končne točke igrajo ključno vlogo pri sinhronizaciji, potrjevanju in poročanju podatkov. Razumevanje teh kod odziva je bistvenega pomena za učinkovito odpravljanje težav in za vzdrževanje zanesljivih in stabilnih integracij.

Tabela 1. Kode odziva končnih točk API

Koda odziva

Opis kode odziva

200

OK

400

Slaba zahteva: Zah teva je bila neveljavna ali je ni mogoče drugače vročiti. Dodatno sporočilo o napaki bo pojasnjeno.

401

Nepo@@ obla ščena: Poverilnice za preverjanje pristnosti manjkajo ali so

403

Prepovedano: Zahteva je razumljena, vendar je bila zavrnjena ali dostop ni dovoljen.

404

Ni naj deno: zahtevani URI je neveljaven ali zahtevani vir, na primer uporabnik, ne obstaja. Vrne se tudi, če zahtevani format ni podprt z zahtevano metodo.

405

Metoda ni dovoljena: Zahteva je bila poslana viru z uporabo metode zahteve HTTP, ki ni podprta.

409

Konflikt: Zahteve ni bilo mogoče obdelati, ker je v nasprotju z nekaterim ustaljenim pravilom sistema. Na primer, oseba ne sme biti dodana v sobo več kot enkrat.

410

Iz ginilo: Zahtevani vir ni več na voljo.

415

Nepodprta vrsta medi ja: Zahteva je bila poslana viru brez določitve vrste medija ali je uporabljena vrsta medija, ki ni podprta.

423

Zaklen jeno: Zahtevani vir začasno ni na voljo. Morda je prisotna glava Retry-After, ki določa, koliko sekund morate počakati, preden znova poskusite zahtevo.

428

Zahtevan predpogo j: Datoteke ni mogoče pregledati za zlonamerno programsko opremo in jih je treba prisilno prenesti.

429

Preveč zahte v: V določenem času je bilo poslanih preveč zahtev in zahteva je bila omejena. Prisotna mora biti glava Retry-After, ki določa, koliko sekund morate počakati, preden je mogoče vložiti uspešno zahtevo.

451

Zahteve so privzeto usmer analytics-calling.webexapis.comjene na najbližje regionalne strežnike. Če ti strežniki gostijo podatke organizacije, API vrne podatke. V nasprotnem primeru API vrne HTTP 451, odzivno telo pa identificira končno točko, kjer lahko pridobite podatke organizacije.

500

Napaka notranjega strež nika: Nekaj je šlo narobe na strežniku. Če se težava še vedno pojavlja, se obrnite na [ekipo za podporo za razvijalce Webex] (/explore/support).

502

Slab pre hod: Strežnik je med obdelavo zahteve prejel neveljaven odgovor od zgornjega strežnika. Poskusite znova kasneje.

503

Storitev ni na voljo: strežnik je preobremenjen z zahtevami. Poskusite znova kasneje.

504

Časovni omejitev prehoda: zgornji strežnik se ni pravočasno odzval. Če vaša poizvedba uporablja parameter max, ga poskusite zmanjšati.

API za poročila/predloge partnerjev

Poročila, ki so na voljo v središču partnerjev, lahko ustvarite in prenesete z API-ji partnerskih poročil. Če želite več informacij, glejte poročilo/ predloge partnerja.

Partnerji lahko dostopajo do več poročil in prenesejo neposredno iz Partnerskega središča. Če želite več informacij, glejte poročila Partnerskega središča.

Zgodovina revizij

Zgodovina revizij dokumentov

Datum revizije

V članku smo naredili naslednje spremembe

13/08/26

  • Zahteva za vlogo končne točke API-ja za usklajevanje: Uporabnik, ki preverja pristnost, mora biti skrbnik partnerja s popolnim dostopom na ravni skrbnika. Prav tako mora biti omogočen dostop Webex Calling CDR API.

  • Kode odziva končnih točk API za razumevanje so posodobljene tako, da vključujejo 451 kodo napake.

  • Dodane so regionalne končne točke za podatkovno regijo organizacije Webex Calling strank.

2/04/2026

  • Ustvarila je tabelo zgodovine revizij, ki spremlja vse spremembe, narejene skozi čas.

  • Posodobljen je razdelek Končna točka API-ja za uskladitev in končna točka API-ja zapisi, da bi vključili vrednosti tabele ali kode napake.

Ali je bil ta članek koristen?
Ali je bil ta članek koristen?