- Kezdőlap
- /
- Cikk
A Webex Calling multi-tenant (MT) partnerek létrehozhatnak egy webhook-ot, amellyel Webex Calling rekordokat gyűjthetnek minden ügyfele számára. Ez lehetővé teszi a hatékony számlázási egyeztetést, elemzést és jelentést anélkül, hogy minden ügyfelet külön-külön kellene lekérdezni.
Áttekintés
A Detailed Call Records webhook biztonságos, skálázható és robusztus megoldást kínál, amelyet a kérések helyett események vezérlik. Ez a webhook nagyobb láthatóságot biztosít ügyfelei Webex Calling tevékenységeihez, támogatva a felhasználási eseteket a számlázástól az egyedi személyre szabott jelentésig.
Ezzel a webhook-nal kényelmesen gyűjthet nyilvántartásokat a Partner Hubon keresztül kezelt összes ügyfél számára anélkül, hogy minden ügyfelet külön-külön kérdezne. Ez a webhook lehetővé teszi egyedi jelentési, számlázási és analitikai alkalmazások fejlesztését mind a belső üzleti követelményekhez, mind a hozzáadott értéknövelő szolgáltatásokhoz.
A webhook és a hozzá tartozó API-k bemutatásához nézze meg ezt a Vidcast: Webex Calling Partner Detailed Call Hist ory API-t.
Mit nyújt a Partner webhook
A webhook 5 percenként részletes híváselőzményeket készít. Minden webhook hasznos teher tartalmazza:
- Hívásfeljegyzések, amelyek az aktuális idő előtt 10 perccel és 5 perccel fejeződtek be.
- A felhő által feldolgozott késői re Webex Calling kordok.
- Automatikusan kitölti a késői hívásnyilvántartásokat a következő webhook hasznos terhekben a megbízható szállítás biztosí tása érdekében.
Ha meg szeretné mutatni, hogy a hívásrekordok hogyan szerepelnek az egyes hasznos teherbírásokban, vegye figyelembe a következő példát:
- A 14:05 -kor beérkezett hasznos teher 13:55 és 14:00 között véget ért hívásokat tartalmaz.
- A 14:00 és 14:05 között lezáruló hívásokat a 14:10 hasznos teher tartalmazza.
- A korábban kitöltött (például 14:04 -kor véget ért hívás), de a Webex Calling felhő által későn feldolgozott rekordok (például 14:11 -kor) szerepelnek a következő ütemezett hasznos terhelésbe ( például 14:15).
A webhorgok megbízhatóan továbbítják a rekordokat. A későbbi webhook hasznos terhelésekben azonban ismétlődő rekordokat kaphat, amikor a rendszer bizonyos feltételek mellett ismétlődik a rekordokat. Ön felelős a rekordok másolásának kezeléséért. Az ismétlődő rekordok azonosításához használja a ReportID mezőt elsődleges kulcsként, a ReportTime mezőt pedig a hívás befejezésének vagy feldolgozásának időpontjának meghatározásához. Ezekkel a mezőkkel frissítheti vagy illesztheti be a rekordokat a belső adattárakba.
Webhook a Partner Hubban
A webhook biztosításával lehetővé teszi az elemző platform számára, hogy hívásrekordokat küldjön a visszahívási URL-re, amikor azok generálásra kerülnek.
Webex CallingA rekordok ugyanolyan formátumban kerülnek kiszállításra, mint a meglévő Detailed Call Records API- k. Beállíthat egy webhookot, és kétféle hírcsatorna közül választhat:
- Analitika — Tartalmazza az összes olyan ügyfélszervezet hívásnyilvántartását, amellyel a partner kapcsolatban áll. Webex Calling Ez magában foglalja azokat a szervezeteket, ahol:
- A partner az ügyfélszervezetet Partner Teljes Adminisztrátor szerepével kezeli.
- Az ügyfélszervezet aktív Webex Calling előfizetéssel rendelkezik a partnerszervezeten belül.
- Számlázás — A partner által értékesített és biztosított Webex Calling licenccel rendelkező felhasználók által végrehajtott hívások hívásnyilvántartását tartalmazza. A munkaterületek hívásrekordjai ebben a hírcsatornában szerepelnek.
Hozzáférés és adatvédelem
Csak a tulajdonos partner férhet hozzá a Call Detail Records (CDR) számlázáshoz.
- Az a partner (vagy alpartner), aki kezeli a hívásnyilvántartáshoz kapcsolódó licencet, a tulajdonos partnerré válik.
- A tulajdonjogot a következők határozzák meg: Felhasználóazonosító > Licencazonosító > Előfizetési azonosító > Partner azonosító.
- Minden CDR egyetlen partner számára elérhető.
- Egyes hívásrekordok nem illeszkednek a számlázási partnerhez, és nem minden, a szervezethez kapcsolódó partner kap egyenlő hozzáférést az összes rekordokhoz, mivel ezek a rekordok tartalmazhatnak személyazonosításra alkalmas adatokat (PII).
Webhook visszahívási URL-ének beállítása
Konfigurálja a webhookot a Partner Hubban. Partner szervezetenként csak egy webhookot állíthat be.
Ugyanezek a hozzáférési követelmények vonatkoznak a Partneregyeztetési és Rekordok API-k használatakor.
| 1 |
Jelentkezzen be a Partner Hub ba. |
| 2 |
Lépjen a elemre
|
| 3 |
Adjon meg egy URL-t, amelyet használni szeretne a Webhook alatt. Az URL-nek /webhook betűvel kell végződnie (például https://yourdomain.com/webhook).
|
| 4 |
Ha titkos tokennel szeretné hitelesíteni a webhook hasznos terheléseit, hozzáadhat egyet. A Webex webhookokról és titkos tokenekről további információkért lásd: Webex fejlesztőknek: Webhook. |
| 5 |
Válassza ki az alábbi erőforrástípusok egyik ét, amelyet a webhookhoz használhat:
|
Partner API végpontok
A webhook mellett API végpontokat is Webex Calling biztosít az adatok egyeztetésének támogatására. Ezek a végpontok lehetővé teszik, hogy felzárkózzon vagy összeegyeztethesse adattárolóit azokkal a hiányzó rekordokkal, amelyeket a webhook-hallgató esetleg nem kapott. A két API végpont az egyeztetési API és a Records API.
Ezekből az API-kból származó rekordok 30 napig állnak rendelkezésre. Annak érdekében, hogy minden várható rekord megkapja, javasoljuk, hogy rendszeresen, például 12 vagy 24 óránként egyeztesse a lemezáruházakat.
Ezen API-k eléréséhez partnerhozzáférési tokenet kell használnia. A hitelesítő felhasználónak Partner Teljes rendszergazdának kell lennie, amely teljes szervezeti szintű rendszergazdai hozzáféréssel rendelkezik, és engedélyeznie kell a Webex CallingCDR API-hozzáférést. Az OAuth tokennek tartalmaznia kell a spark-admin:calling_cdr_readhatókört. A csak olvasható rendszergazdai szerepkörök nem elegendőek a Partner-egyeztetési és Rekordok API-khoz.
Használja az ügyfélszervezet Webex Calling adatrégiójának vég analytics-callingpontját. Használja a megfelelő alap URL-t mind az egyeztetési, mind a Rekordok API-hoz:
- Egyesült Államok és Kanada:
https://analytics-calling.webexapis.com - Európa:
https://analytics-calling-eu.webexapis.com - India:
https://analytics-calling-in.webexapis.com - Ausztrália:
https://analytics-calling-au.webexapis.com
Az API ablaktartományok mindkét végpontra alkalmazhatók a szolgáltatási terhelés jobb kezelése érdekében.
- A 48 óránál nagyobb időtartományok esetén a maximális megengedett ablak időtartama 12 óra (kötelező).
- Partnerszervezet azonosítója esetén az API-k aránya egy kezdeti API-kérelemre korlátozódik percenként, token hatókörénként. Lapozás használata esetén percenként legfeljebb 10 további oldallapozott API-kérelem engedélyezett tokenonként, és ezek az első kérés után azonnal megtehetők.
Összehangolási API végpont
Az egyeztetési API végpontja a megadott időtartamon belül a partner által kezelt minden ügyfél számára létrehozott hívásrekordok számát adja vissza. Ezekkel az összegekkel ellenőrizheti a helyi tárhelyet, és azonosíthatja az egyes ügyfelek számára hiányzó vagy következetlen hívásrekordokat.
Hozzáférési követelmény: A hitelesítő felhasználónak Partnerrendszergazdának kell lennie, amely teljes rendszergazdai szintű hozzáféréssel rendelkezik, és engedélyeznie kell a Webex CallingCDR API-hozzáférést. A hozzáférési tokennek tartalmaznia kell a spark-admin:calling_cdr_readhatókört.
Ha több mint 200 ügyfélszervezetet kezel, az API az olvashatóság javítása érdekében lapozza az eredményeket.
Az egyeztetési API végpont URL-je a következő formátumot használja:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
API paraméterek
Az API segítségével lekérheti az elmúlt 30 nap hívásrekordjait. A kiválasztott időablaknak legalább 5 perccel az aktuális UTC idő előtt kell kezdődnie, és egyetlen API-hívásban nem haladhatja meg a 12 órát a kezdési és befejezési idő között.
Az API paraméterei a következők:
-
StartTime (kötelező, karakterlánc) —Az első összegyűjteni kívánt rekord kezdési dátuma és időpontja (UTC). Gondoskodjon arról, hogy:
- Az időt úgy formázza
YYYY-MM-DDTHH:MM:SS.mmmZ. Például,2025-08-15T06:00:00.000Z.
- A kezdési dátum és idő nem lehet régebbi, mint 30 nap az aktuális UTC időtől.
- Az ablak között
startTimeésendTimenem haladhatja meg a 12 órát.
- Az időt úgy formázza
-
EndTime (kötelező, karakterlánc) —Az összegyűjteni kívánt rekordok befejezési dátuma és időpontja (UTC). A rekordok a jelentési időn alapulnak, amely a hívás befejezésekor történik. Gondoskodjon arról, hogy:
- Az időt úgy formázza
YYYY-MM-DDTHH:MM:SS.mmmZ. Például,2025-08-15T18:00:00.000Z. - A befejezési dátumnak és időnek 5 perccel az aktuális UTC idő előtt kell lennie, és nem régebbi, mint 30 nap.
- A befejezési dátumnak és időnek nagyobbnak kell lennie, mint a
startTime. - Az
startTimeésendTimeközötti ablak nem haladhatja meg a 12 órát.
- Az időt úgy formázza
Példa egy egyeztetési API végponti JSON válaszára:
{
"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
}
]
}
Az API-válasz fejlécek jelzik a visszaküldött szervezetek teljes számát és azt, hogy rendelkezésre állnak-e további oldalak. Ellenőrizze a következő fejlécparamétereket, hogy megbizonyosodjon arról, hogy lekérdezte az összes oldalt:
- szám-pages: Összes oldalak száma (például 2)
- total-orgs: A válaszban szereplő szervezetek száma összesen (például 283)
- aktuális oldal: Az aktuális oldalszám (például 1)
Ha például a fejléceken num-pages=2, total-orgs=283 és current-page=1 látható, akkor egy kétoldalas válasz első oldalát tekintheti meg, amely összesen 283 szervezetet tartalmaz. A következő oldal eléréséhez adja hozzá a page=2 paramétert a GET kéréshez, az alább látható módon:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2
Az API végpontját rögzíti
A Records API végpont a hiányzó hívásrekordok lekérdezésére szolgál olyan szervezetek esetében, ahol az eltéréseket vagy hiányzó adatokat azonosították az egyeztetési API használatával.
Ajánlott áramlás: /v1/partners/cdrcountbyorgElőször hívjon. Ezután híváskor használja a orgIdpontosan vis cdr_counts[].orgIdszaküldött értéket /v1/partners/cdrsbyorg.
A Records API visszaadja a hívásrekordokat JSON formátumban, amely megegyezik a Rész letes híváselőzmények API-ban leírt formátummal. A visszaküldött hasznos teher azonos mezőket tartalmaz, mint a részletes híváselőzmények visszaküldött hasznos terhelésével. A mezőkről és azok értékeiről további információt a Rész Webex Callingletes híváselőzményjelentés című témakörben talál.
Az API olyan hívásrekordokat biztosít, amelyek az aktuális idő előtt 5 perccel véget értek. Annak érdekében, hogy minden hívásrekord elérhetővé váljon, javasoljuk, hogy a kívánt időablak után egy órával lekérdezze az API-t.
A Records API végpont URL-je a következő formátumot használja:
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 paraméterek
-
orgId(kötelező, karakterlánc) —Az ügyfélszervezet azonosítója, amelyhez rekordokat szeretne lekérni. A paraméter neve kis- és nagybetűket érzékeny. A Szervezeti azonosítók az Összeegyeztetési API válasz mezőből szerezhetők becdr_counts[].orgId. -
StartTime (kötelező, karakterlánc) —Az első összegyűjteni kívánt rekord kezdési dátuma és időpontja (UTC). Gondoskodjon arról, hogy:
- Az időt úgy formázza
YYYY-MM-DDTHH:MM:SS.mmmZ. Például,2025-08-15T06:00:00.000Z. - A kezdési dátum és idő nem lehet régebbi, mint 30 nap az aktuális UTC időtől.
- Az és közötti intervallum egyetlen API kér
startTimeés esetén nemendTimehaladhatja meg a 12 órát.
- Az időt úgy formázza
-
EndTime (kötelező, karakterlánc) —Az utolsó gyűjteni kívánt rekord befejezési dátuma és ideje (UTC). A rekordok a jelentési időn alapulnak, amely a hívás befejezésekor történik. Gondoskodjon arról, hogy:
- Az időt úgy formázza
YYYY-MM-DDTHH:MM:SS.mmmZ. Például,2025-08-15T18:00:00.000Z. - A befejezési dátumnak és időnek legalább 5 perccel az aktuális UTC idő előtt kell lennie, és nem régebbi, mint 30 nap.
- A befejezési dátumnak és időnek nagyobbnak kell lennie, mint a
startTime. - Az és közötti intervallum egyetlen API kér
startTimeés esetén nemendTimehaladhatja meg a 12 órát.
- Az időt úgy formázza
-
max (opcionális, szám) — A válasz oldalankénti rekordjainak maximális számát korlátozza. Gondoskodjon arról, hogy:
- A tartomány 500 és 5000 között van. Az alapértelmezett érték 5000. Például,
max=1000. - Ha az API-nak több rekordot kell visszatérnie, mint a megadott maximális érték, akkor a válasz oldalra kerül.
- Ha 500 alatti érték van megadva, az automatikusan 500-ra állítható be. Ha 5000 feletti értéket adunk meg, akkor azt 5000-ra kell beállítani.
- A tartomány 500 és 5000 között van. Az alapértelmezett érték 5000. Például,
Oldalapítás
Annak megállapításához, hogy az API-válaszok lapozásra kerülnek-e, ellenőrizze, hogy a válasz fejlécében vannak-e egy Link fejléc. Ha egy nexthivatkozás található a Csatolás fejlécében, bontsa ki azt, és használja az startTimeForNextFetchértéket a következő rekordkészlet kéréséhez. Ha nincs következő link, akkor a kiválasztott időtartomány összes jelentését összegyűjtjük.
A következő oldalakra vonatkozó API-kérelmek azonnal benyújthatók, de a sebességet legfeljebb 10 oldalas kérelemre kell korlátozni percenként, token hatókörénként.
A rekordok lekérésekor használjon idempotens feldolgozást és duplikálást, többek között a lapozott válaszok vagy az ismételt egyeztetési ablakok között. Használja első reportIddleges kulcsként és meghatároz reportTimeza a legfrissebb feldolgozott rekordot.
Például, ha a kezdeti API-kérés a következő:
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
akkor a válasz Link fejléce:
<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"
A lapozás csak a rel="next"Link fejlécét használja. Ha a válasz hivatkozást tartalmaz, használja ezt az URL-t a rekordok következő oldalának rel="next"lekéréséhez. Ha a válasz nem tartalmaz hivatkozást, rel="next"akkor a kiválasztott időtartományhoz tartozó összes rendelkezésre álló rekordot letöltötte.
Ennek az API-nak a lapozása az RFC5988 (Web Links) szabványt követi. További információt a REST API alapjai című témakörben talál.
Az API végpontválaszkódjainak megértése
Ez a szakasz áttekintést nyújt azokról a gyakori válaszkódokról, amelyek előfordulhatnak az egyeztetési API végpontjával és a Records API vég pontjával való munka során. Ezek a végpontok kritikus szerepet játszanak az adatok szinkronizálásában, érvényesítésében és jelentéstételében. Ezeknek a válaszkódoknak a megértése elengedhetetlen a hatékony hibaelhárításhoz és a megbízható, stabil integrációk fenntartásához.
|
Válasz kód |
Válasz kód leírása |
|---|---|
|
200 |
OK |
|
400 |
Rossz kérés: A kérelem érvénytelen volt, vagy másképp nem kézbesíthető. A kísérő hibaüzenet tovább magyarázza. |
|
401 |
Nem engedélyez ett: A hitelesítési hitelesítő adatok hiányoznak vagy helytelenek voltak |
|
403 |
Tiltott: A kérelmet megértik, de elutasították, vagy a hozzáférés nem engedélyezett. |
|
404 |
Nem található: A kért URI érvénytelen, vagy a kért erőforrás, például felhasználó, nem létezik. Akkor is visszaküldik, ha a kért formátumot a kért módszer nem támogatja. |
|
405 |
Nem engedél@@ yezett módszer: A kérelmet egy erőforráshoz küldték el egy nem támogatott HTTP-kérési módszerrel. |
|
409 |
Konfli ktus: A kérelmet nem sikerült feldolgozni, mert ellentétes a rendszer valamilyen megállapított szabályával. Például egy személyt nem lehet többször hozzáadni egy szobához. |
|
410 |
Eltű nt: A kért erőforrás már nem érhető el. |
|
415 |
Nem támogatott hordozótípus: A kérelmet adathordozótípus megadása nélkül nyújtották be egy erőforráshoz, vagy nem támogatott hordozótípust használtak. |
|
423 |
Zárt: A kért erőforrás ideiglenesen nem érhető el. Megjelenhet egy Retry-After fejléc, amely megadja, hogy hány másodpercet kell várnia, mielőtt újra megpróbálná a kérelmet. |
|
428 |
Előfeltétel szükséges: A fájlok nem vizsgálhatók rosszindulatú programok szempontjából, ezért erőszakkal le kell tölteni őket. |
|
429 |
Túl sok kér és: Túl sok kérést küldtek egy adott idő alatt, és a kérés aránykorlátozott volt. Jelen kell lennie egy Retry-After fejlécnek, amely meghatározza, hogy hány másodpercet kell várnia a sikeres kérelem benyújtása előtt. |
|
451 |
Alapértelmezés szerint a kér |
|
500 |
Belső kiszolgálóhiba: Valami rosszul ment a szerveren. Ha a probléma továbbra is fennáll, vegye fel a kapcsolatot a [Webex fejlesztői támogatási csapattal] (/explore/support). |
|
502 |
Rossz átjár ó: A kiszolgáló érvénytelen választ kapott egy felfelé irányuló kiszolgálótól a kérés feldolgozása során. Próbáld újra később. |
|
503 |
Szolgáltatás nem érhető el: A szerver túlterhelt a kérésekkel. Próbáld újra később. |
|
504 |
Átjáró időtú llépése: A felfelé irányuló kiszolgáló nem válaszolt időben. Ha a lekérdezés maximális paramétert használ, kérjük, próbálja csökkenteni azt. |
Partnerjelentések/sablonok API
A Partner Hubban elérhető jelentéseket hozhat létre és tölthet le a Partner Reports API-k segítségével. További információkért lásd a partnerjelentést/sablonokat.
A partnerek több jelentést is elérhetnek és letölthetnek közvetlenül a Partner Hubból. További információt a Partner Hub jelentései című témakörben tal ál.
Változások története
Dokumentummódosítási előzmények
|
Felülvizsgálat dátuma |
A következő változtatásokat hajtottuk végre a cikkben |
|---|---|
|
13/08/26 |
|
|
2/04/2026 |
|