- Početak
- /
- Članak
Webex Calling partneri s više stanara (MT) mogu postaviti webhook za prikupljanje Webex Calling zapisa za sve vaše klijente. To omogućuje učinkovito usklađivanje naplate, analitiku i izvještavanje bez potrebe za upitom svakog kupca pojedinačno.
Pregled
Webhook Detailed Call Records nudi sigurno, skalabilno i robusno rješenje vođeno događajima, a ne zahtjevima. Ovaj webhook pruža veću vidljivost Webex Calling aktivnosti vaših kupaca, podržavajući slučajeve upotrebe od naplate do prilagođenog izvješćivanja.
Pomoću ovog webhook-a možete prikupljati zapise prikladno za sve kupce kojima upravlja putem Partner Huba bez upita svakog kupca pojedinačno. Ovaj webhook omogućuje vam razvoj prilagođenih aplikacija za izvješćivanje, naplatu i analitičke aplikacije za interne poslovne zahtjeve i usluge s dodanom vrijedno šću.
Za uvod u webhook i njegove prateće API-je pogledajte ovaj Vidcast: Webex Calling Partner Detailed Call History API.
Što pruža Partner webhook
Webhook isporučuje detaljne zapise povijesti poziva svakih 5 minuta. Svaki korisni teret webhook sadrži:
- Zapisi poziva koji su završili između 10 minuta i 5 minuta prije trenutnog vremena.
- Svi kasni zapisi obrađeni u Webex Calling oblaku.
- Automatski popunjava zapise o kasnim pozivima u sljedećim korisnim opterećenjima webhook-a kako bi se osigurala pouzdana isporuka .
Da biste prikazali kako su zapisi poziva uključeni u svaki korisni teret, razmotrite sljedeći primjer:
- Korisni teret primljen u 14:05 sadrži pozive koji su završili između 13:55 i 14:00.
- Pozivi koji završavaju između 14:00 i 14:05 uključeni su u korisni teret 14:10.
- Zapisi dovršeni ranije (na primjer, poziv koji je završio u 14:04), ali kasno obra đeni Webex Calling oblakom (na primjer, u 14:11) uključeni su u sljedeći zakazani korisni teret (na primjer, 14:15).
Webhokovi pouzdano isporučuju zapise. Međutim, možete primiti duplikate zapisa u sljedećim korisnim opterećenjima webhook kada sustav reproducira zapise pod određenim uvjetima. Vi ste odgovor ni za rukovanje dedupliciranjem zapisa. Da biste identificirali duplikate zapisa, upotrije bite polje Re portID kao primarni ključ i polje ReportTime kako biste utvrdili kada je poziv završen ili obrađen. Koristite ta polja za ažuriranje ili umetanje zapisa u interne pohrane podataka.
Webhook u partnerskom čvorištu
Pružanjem webhook-a omogućavate analitičkoj platformi da šalje zapise poziva na vaš URL povratnog poziva kad god se generiraju.
Webex Callingzapisi se isporučuju u istom formatu kao i postojeći API-ji detaljnih zapisa poziva. Možete postaviti webhook i birati između dvije vrste feeda:
- Analitika — uključuje sve evidencije poziva za sve organizacije kupaca s kojima partner ima Webex Calling odnos. To uključuje organizacije u kojima:
- Partner upravlja organizacijom kupaca s ulogom punog administratora partnera.
- Organizacija kupaca ima aktivnu Webex Calling pretplatu unutar partnerske organizacije.
- Obračunavanje — uključuje evidenciju poziva za pozive korisnika s Webex Calling licencom koju je prodao i osigurao partner. Zapisi poziva za radne prostore uključeni su u ovaj feed.
Pristup i privatnost podataka
Samo partner vlasnik može pristupiti evidenciji detalja poziva (CDR) za naplatu.
- Partner (ili podpartner) koji upravlja licencom povezanom s zapisom poziva postaje vlasnik partnera.
- Vlasništvo se određuje pomoću: Korisnički ID > ID licence > ID pretplate > ID partnera.
- Svaki CDR dostupan je jednom partneru.
- Neki se zapisi poziva ne preslikavaju na partnera za naplatu, a svi partneri povezani s organizacijom nemaju jednak pristup svim zapisima jer ti zapisi mogu sadržavati osobne podatke (PII).
Postavljanje URL-a za povratni poziv na webhook
Konfigurirajte webhook u Partnerskom čvorištu. Možete postaviti samo jedan webhook po partnerskoj organizaciji.
Provjerite imate li punu administratorsku ulogu partnera s "Pristup punoj razini administratora u organizaciji " i ju označen u Control Hubu (u odjeljku U pravl janje > nici odaberite potpunog administratora ili punog administratora partnera, a zatim odaberite Ulo ge administratora > Partner).
Isti zahtjevi za pristup primjenjuju se i kada koristite API-je za usklađivanje partnera i zapise.
| 1 |
Prijavite se u Partner Hub. |
| 2 |
Idite na .
|
| 3 |
Unesite URL koji ćete koristiti pod Webhook. URL mora završiti s /webhook (na primjer, https://yourdomain.com/webhook).
|
| 4 |
Ako želite autentifikirati svoje korisne terete webhook pomoću tajnog tokena, možete ga dodati. Da biste pronašli više informacija o Webex webkukovima i tajnim tokenima, pogledajte Webex za programere: Webhook. |
| 5 |
Odaberite jednu od sljedećih vrsta resursa koju ćete koristiti za webhook:
|
Krajnje točke partnerskog API-ja
Osim webhook-a, Webex Calling pruža API krajnje točke za podršku usklađivanju podataka. Ove krajnje točke omogućuju vam da nadoknadite ili uskladite svoje pohrane podataka sa svim nedostajućim zapisima koje vaš slušatelj webhook-a možda nije primio. Dvije krajnje točke API-ja su API za usklađivanje i API zapisa.
Zapisi iz ovih API-ja dostupni su 30 dana. Kako biste osigurali da ćete primiti sve očekivane zapise, preporučujemo da povremeno usklađujete svoje zalihe ploča, primjerice svakih 12 ili 24 sata.
Za pristup tim API-jima morate koristiti token pristupa partneru. Korisnik koji potvrđuje provjeru autentičnosti mora biti potpuni administrator partnera s pristupom punoj administratorskoj razini organizacije i mora imati omogućen pristup Webex CallingCDR API-ju. OAuth token mora uključivati opseg. spark-admin:calling_cdr_read Uloge administratora samo za čitanje nisu dovoljne za API-je za usklađivanje partnera i zapise.
Koristite kraj analytics-callingnju točku za regiju Webex Calling podataka korisničke organizacije. Koristite primjenjivi osnovni URL i za API-je za usklađivanje i zapise:
- SAD i Kanada:
https://analytics-calling.webexapis.com - Europa:
https://analytics-calling-eu.webexapis.com - Indija:
https://analytics-calling-in.webexapis.com - Australija:
https://analytics-calling-au.webexapis.com
Rasponi prozora API primjenjivi su na obje krajnje točke radi boljeg rješavanja opterećenja usluge.
- Za vremenske raspone veće od 48 sati, maksimalno dopušteno trajanje prozora je 12 sati (prisiljeno).
- Za ID partnerske organizacije API-ji su ograničeni na jedan početni zahtjev API-ja u minuti, po opsegu tokena. Ako se koristi paginacija, dopušteno je do 10 dodatnih paginiranih API zahtjeva u minuti, po tokenu, a oni se mogu izvršiti odmah nakon početnog zahtjeva.
Krajnja točka API-ja usklađivanja
Krajnja točka API-ja za usklađivanje vraća ukupan broj zapisa poziva generiranih za svakog kupca kojim upravlja partner u određenom vremenskom razdoblju. Pomoću tih ukupnih iznosa možete provjeriti lokalnu pohranu i identificirati sve nedostajuće ili nedosljedne zapise poziva za određene korisnike.
Zahtjev za pristup: Korisnik koji potvrđuje provjeru autentičnosti mora biti partner administrator s punim pristupom administratorskoj razini i mora imati omogućen pristup Webex CallingCDR API-ju. Pristupni token mora sadržavati op spark-admin:calling_cdr_readseg.
Ako upravljate više od 200 organizacija kupaca, API prikazuje rezultate kako bi poboljšao čitljivost.
URL krajnje točke API-ja za usklađivanje koristi sljedeći format:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
API parametri
Pomoću API-ja možete dohvatiti zapise poziva iz posljednjih 30 dana. Odabrani vremenski prozor mora započeti najmanje 5 minuta prije trenutnog UTC vremena i ne smije prelaziti 12 sati između vremena početka i završetka u jednom API pozivu.
API parametri su:
-
StartTime (obavezno, niz) —Datum i vrijeme početka (UTC) za prvi zapis koji želite prikupiti. Osigurajte da:
- Vrijeme formatirate kao
YYYY-MM-DDTHH:MM:SS.mmmZ. Na primjer,2025-08-15T06:00:00.000Z.
- Datum i vrijeme početka ne smiju biti stariji od 30 dana od trenutnog UTC vremena.
- Prozor između
startTimei neendTimemože biti duži od 12 sati.
- Vrijeme formatirate kao
-
EndTime (obavezno, niz) —Datum i vrijeme završetka (UTC) za zapise koje želite prikupiti. Zapisi se temelje na vremenu izvješća, a to je kada je poziv obavljen. Osigurajte da:
- Vrijeme formatirate kao
YYYY-MM-DDTHH:MM:SS.mmmZ. Na primjer,2025-08-15T18:00:00.000Z. - Datum i vrijeme završetka moraju biti 5 minuta prije trenutnog UTC vremena i ne stariji od 30 dana.
- Datum i vrijeme završetka moraju biti veći od
startTime. - Prozor između
startTimei neendTimemože biti duži od 12 sati.
- Vrijeme formatirate kao
Primjer JSON odgovora krajnje točke API-ja za usklađivanje:
{
"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
}
]
}
Zaglavlja odgovora API-ja označavaju ukupan broj vraćenih organizacija i jesu li dostupne dodatne stranice. Provjerite sljedeće parametre zaglavlja kako biste bili sigurni da ste upitali sve stranice:
- broj stranica: Ukupan broj stranica (na primjer, 2)
- ukupni organi: Ukupan broj organizacija uključenih u odgovor (na primjer, 283)
- trenutna stranica: trenutni broj stranice (na primjer, 1)
Na primjer, ako zaglavlja prikazuju num-pages=2, total-orgs=283 i current-page=1, pregledavate prvu stranicu odgovora na dvije stranice koja sadrži ukupno 283 organizacije. Da biste pristupili sljedećoj stranici, dodajte parametar page = 2 svom GET zahtjevu, kao što je prikazano u nastavku:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2
Snimanje API-ja krajnje točke
Krajnja točka API-ja zapisa koristi se za ispitivanje zapisa poziva koji nedostaju za određene organizacije u kojima su odstupanja ili nedostajući podaci identificirani pomoću API-ja za usklađivanje.
Preporučeni protok: /v1/partners/cdrcountbyorgPrvo nazovite. Zatim upotrijebite točno orgIdvraćeno cdr_counts[].orgIdkad nazovete /v1/partners/cdrsbyorg.
API zapisa vraća zapise poziva u JSON formatu, identičnom formatu opisanom u API-ju Detaljna povijest poziva. Vraćeni korisni teret sadrži identična polja kao vraćeni korisni teret Detaljna povijest poziva. Dodatne informacije o poljima i njihovim vrijednostima potražite u odjel Webex Callingjku Detaljno izvješće o povijesti poziva.
API pruža zapise poziva koji su završili 5 minuta prije trenutnog vremena. Da biste osigurali da su svi zapisi poziva dostupni, preporučujemo upit API-ja sat vremena nakon željenog vremenskog prozora.
URL krajnje točke API-ja zapisa koristi sljedeći format:
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 parametri
-
orgId(obavezno, niz) —ID organizacije korisnika za koji želite dohvatiti zapise. Naziv parametra je osjetljiv na velika i mala slova. ID-ove organizacije možete dobiti iz polja za odgovor API-ja za usklađivanjecdr_counts[].orgId. -
StartTime (obavezno, niz) —Datum i vrijeme početka (UTC) za prvi zapis koji želite prikupiti. Osigurajte da:
- Vrijeme formatirate kao
YYYY-MM-DDTHH:MM:SS.mmmZ. Na primjer,2025-08-15T06:00:00.000Z. - Datum i vrijeme početka ne smiju biti stariji od 30 dana od trenutnog UTC vremena.
- Interval između
startTimei neendTimesmije biti duži od 12 sati u jednom API zahtjevu.
- Vrijeme formatirate kao
-
EndTime (obavezno, niz) —Datum i vrijeme završetka (UTC) za posljednji zapis koji želite prikupiti. Zapisi se temelje na vremenu izvješća, a to je kada je poziv obavljen. Osigurajte da:
- Vrijeme formatirate kao
YYYY-MM-DDTHH:MM:SS.mmmZ. Na primjer,2025-08-15T18:00:00.000Z. - Datum i vrijeme završetka moraju biti najmanje 5 minuta prije trenutnog UTC vremena i ne stariji od 30 dana.
- Datum i vrijeme završetka moraju biti veći od
startTime. - Interval između
startTimei neendTimesmije biti duži od 12 sati u jednom API zahtjevu.
- Vrijeme formatirate kao
-
max (izborno, broj) —Ograničava maksimalni broj zapisa po stranici u odgovoru. Osigurajte da:
- Raspon je od 500 do 5000. Zadana vrijednost je 5000. Na primjer,
max=1000. - Ako API ima više zapisa za povratak od navedene maksimalne vrijednosti, odgovor se paginira.
- Ako je navedena vrijednost ispod 500, ona se automatski podešava do 500. Ako je navedena vrijednost iznad 5000, ona se podešava na 5000.
- Raspon je od 500 do 5000. Zadana vrijednost je 5000. Na primjer,
Paginacija
Da biste utvrdili jesu li odgovori API-ja označeni na stranicama, provjerite zaglavlja odgovora za zaglavlje veze. Ako je nextveza prisutna u zaglavlju veze, izdvojite je i upotrijebite startTimeForNextFetchvrijednost da biste zatražili sljedeći skup zapisa. Ako nema sljedeće veze, prikupljaju se sva izvješća za odabrani vremenski raspon.
API zahtjevi za sljedeće stranice mogu se izvršiti odmah, ali moraju biti ograničeni na najviše 10 paginiranih zahtjeva u minuti, po opsegu tokena.
Upotrijebite idempotentnu obradu i dedupliciranje kada preuzimate zapise, uključujući kroz stranice označene odgovore ili prozore ponovljenog usklađivanja. Koristite reportIdkao primarni ključ i za određ reportTimeivanje najnovijeg obrađenog zapisa.
Na primjer, ako je početni API zahtjev:
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
tada je zaglavlje veze u 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"
Paginacija koristi samo zaglavlje rel="next"veze. Ako odgovor uključuje rel="next"vezu, upotrijebite taj URL da biste preuzeli sljedeću stranicu zapisa. Ako odgovor ne uključuje rel="next"vezu, preuzeli ste sve dostupne zapise za odabrani vremenski raspon.
Paginacija za ovaj API slijedi standard RFC5988 (Web Links). Za više informacija pogledajte Osnove REST API-ja.
Razumijevanje kodova odgovora na krajnje točke API-ja
Ovaj odjeljak pruža pregled uobičajenih kodova odgovora na koje se mogu susresti pri radu s krajnjom točkom API-ja za usklađivanje i krajnjom toč kom API-ja zapisa. Ove krajnje točke igraju ključnu ulogu u sinkronizaciji podataka, validaciji i izvještavanju. Razumijevanje ovih kodova odgovora ključno je za učinkovito rješavanje problema i za održavanje pouzdanih, stabilnih integracija.
|
Kôd odgovora |
Opis koda odgovora |
|---|---|
|
200 |
OK |
|
400 |
Loš zahtjev: Zahtjev je bio nevažeći ili se ne može drugačije dostaviti. Prateća poruka o pogrešci objašnjavat će dalje. |
|
401 |
Neovlašten o: vjerodajnice za provjeru autentičnosti nedostaju ili nisu bile |
|
403 |
Zabranjeno: Zahtjev se razumije, ali je odbijen ili pristup nije dopušten. |
|
404 |
Nije pronađ en: Traženi URI je nevažeći ili traženi resurs, kao što je korisnik, ne postoji. Također se vraća kada traženi format nije podržan traženom metodom. |
|
405 |
Metoda nije dopušten a: Zahtjev je upućen resursu pomoću metode HTTP zahtjeva koja nije podržana. |
|
409 |
Sukob: Zahtjev se nije mogao obraditi jer je u suprotnosti s nekim utvrđenim pravilom sustava. Na primjer, osoba se ne smije dodati u sobu više od jednom. |
|
410 |
N estao: Traženi resurs više nije dostupan. |
|
415 |
Nepodržana vrsta medija: Zahtjev je upućen resursu bez navođenja vrste medija ili je korišten tip medija koji nije podržan. |
|
423 |
Zaključ ano: traženi resurs privremeno nije dostupan. Može biti prisutno zaglavlje Retry-After koje određuje koliko sekundi trebate pričekati prije ponovnog pokušaja zahtjeva. |
|
428 |
Potreban preduvjet: Datoteke se ne mogu skenirati na zlonamjerni softver i treba ih prisilno preuzeti. |
|
429 |
Previše zaht jeva: Previše zahtjeva poslano je u određenom vremenu i zahtjev je ograničen. Trebalo bi biti prisutno zaglavlje Retry-After koje određuje koliko sekundi trebate pričekati prije uspješnog zahtjeva. |
|
451 |
Zahtjevi se prema zadanim postavkama |
|
500 |
Interna pogreška poslužitelja: Nešto je pošlo po zlu na poslužitelju. Ako se problem nastavi, slobodno kontaktirajte [Webex tim za podršku za programere] (/explore/support). |
|
502 |
Loš pristupnik: Poslužitelj je primio nevažeći odgovor od uzvodnog poslužitelja tijekom obrade zahtjeva. Pokušajte ponovo kasnije. |
|
503 |
Usluga nedostup na: Poslužitelj je preopterećen zahtjevima. Pokušajte ponovo kasnije. |
|
504 |
Vrijeme isteka pristup nika: uzvodni poslužitelj nije reagirao na vrijeme. Ako vaš upit koristi parametar max, pokušajte ga smanjiti. |
API partnerskih izvješća/predložaka
Izvješća dostupna u Partner Hubu možete generirati i preuzeti pomoću API-ja Partner Reports. Dodatne informacije potražite u izvješću/pred lošcima partnera.
Partneri također mogu pristupiti i preuzeti više izvješća izravno s Partner Huba. Dodatne informacije potražite u odjeljku Izvješća Centra partnera.
Povijest izmjena
Povijest revizije dokumenta
|
Datum revizije |
U članku smo napravili sljedeće izmjene |
|---|---|
|
13/08/26 |
|
|
2/04/2026 |
|