- Domů
- /
- Článek
Webex Calling partneři s více tenenty (MT) mohou nastavit webhook pro shromažďování záznamů Webex Calling pro všechny vaše zákazníky. To umožňuje efektivní odsouhlasení fakturace, analýzu a vykazování bez nutnosti dotazovat každého zákazníka individuálně.
Přehled
Webhook Detailní záznamy hovorů nabízí bezpečné, škálovatelné a robustní řešení řízené spíše událostmi než požadavky. Tento webhook poskytuje lepší přehled o Webex Calling aktivitách vašich zákazníků a podporuje případy použití od fakturace až po sestavování na míru.
Pomocí tohoto webhooku můžete pohodlně shromažďovat záznamy pro všechny zákazníky spravované prostřednictvím Partnerského centra, aniž byste se na každého zákazníka dotazovali jednotlivě. Tento webhook vám umožňuje vyvíjet vlastní reportování, fakturace, a analytické aplikace jak pro interní obchodní požadavky, tak pro služby s přid anou hodnotou.
Pro úvod do webhooku a jeho doprovodných API, podívejte se na toto Vidcast: Webex Calling Partner Detailed Call History API.
Co přináší partnerský webhook
Webhook poskytuje podrobné záznamy historie hovorů každých 5 minut. Každé užitečné zatížení webhooku obsahuje:
- Záznamy hovorů, které skončily mezi 10 minutami a 5 minutami před aktuálním časem.
- Jakékoli pozdní záznamy zpracované Webex Calling cloudem.
- Automaticky zasypává záznamy o pozdních hovorech v následných užitečných zatíženích webhooku, aby bylo zajištěno spolehlivé doručení.
Chcete-li ukázat, jak jsou záznamy hovorů zahrnuty do každého užitečného zatížení, zvažte následující příklad:
- Užitečné zatížení přijaté ve 14:05 obsahuje hovory, které skončily mezi 13:55 a 14:00.
- Hovory končící mezi 14:00 a 14:05 jsou zahrnuty v užitečném zatížení 14:10.
- Záznamy dokončené dříve (například volání, které skončilo ve 14:04), ale zprac ované pozdě Webex Calling cloudem (například ve 14:11), jsou zahrnuty do dalšího plánovaného užitečného zatížení ( například 14:15).
Webhooky spolehlivě dodávají záznamy. nicméně, můžete obdržet duplicitní záznamy v následujících užitečných zatíženích webhooku, když systém za určitých podmínek přehraje záznamy. Jste zodpovědní za zpracování deduplikace záznamů. Chcete-li identifikovat duplicitní záznamy, použijte pole reportID jako primární klíč a pole ReportTime k určení, kdy byl hovor dokončen nebo zpracován. Tato pole slouží k aktualizaci nebo vložení záznamů do interních úložišť dat.
Webhook v partnerském centru
Poskytnutím webhooku umožníte analytické platformě odesílat záznamy hovorů na vaši adresu URL zpětného volání, kdykoli jsou vygenerovány.
Webex Callingzáznamy jsou dodávány ve stejném formátu jako stávající rozhraní API pro podrobné záznamy hovorů. Můžete nastavit webhook a vybrat si mezi dvěma typy zdrojů:
- Analytika — Zahrnuje všechny záznamy hovorů pro všechny zákaznické organizace, se kterými má partner vztahWebex Calling. To zahrnuje organizace, kde:
- Partner spravuje organizaci zákazníků s rolí Partner Full Administrator.
- Zákaznická organizace má aktivní Webex Calling předplatné v rámci partnerské organizace.
- Fakturace — Zahrnuje záznamy hovorů pro hovory uskutečněné uživateli s Webex Calling licencí prodanou a poskytnutou partnerem. V tomto kanálu jsou zahrnuty záznamy hovorů pro pracovní prostory.
Přístup a ochrana osobních údajů
Pouze vlastnící partner má přístup k záznamům detailů volání (CDR) pro fakturaci.
- Partner (nebo dílčí partner), který spravuje licenci spojenou se záznamem hovoru, se stane vlastníkem.
- Vlastnictví je určeno podle: ID uživatele > ID licence > ID předplatného > ID partnera.
- Každá CDR je přístupná jednomu partnerovi.
- Některé záznamy hovorů se nemapují na fakturačního partnera a ne všichni partneři přidružení k organizaci mají stejný přístup ke všem záznamům, protože tyto záznamy mohou obsahovat osobní identifikační údaje (PII).
Nastavte adresu URL zpětného volání webhooku
Nakonfigurujte webhook v partnerském centru. Pro každou partnerskou organizaci můžete nastavit pouze jeden webhook.
Ujistěte se, že máte v Řídicím centru zaškrtnutou roli úplného správce partnera s úplným přístupem na úrovni správce organizace a (v části S práva > atelé vyberte úplného správce nebo úplného správce partnera a poté vyberte Role správce > Partner).
Stejné požadavky na přístup platí i při použití rozhraní API pro odsouhlasení partnerů a záznamy.
| 1 |
Přihlaste se do Partnerského centra. |
| 2 |
Přejděte do .
|
| 3 |
Zadejte adresu URL, kterou chcete použít v části Webhook. Adresa URL musí končit na /webhook (například https://yourdomain.com/webhook).
|
| 4 |
Pokud chcete ověřit své užitečné zatížení webhooku tajným tokenem, můžete jeden přidat. Další informace o Webex webhookech a tajných tokenech najdete v tématu Webex pro vývoj áře: Webhooky. |
| 5 |
Vyberte jeden z následujících typů prostředků, které chcete použít pro webhook:
|
Koncové body partnerského rozhraní API
Kromě webhooku, Webex Calling poskytuje koncové body API pro podporu sladění dat. Tyto koncové body vám umožňují dohnat nebo sladit úložiště dat s chybějícími záznamy, které váš posluchač webhooku možná neobdržel. Dva koncové body rozhraní API jsou API pro vyrov nání a API záznamů.
Záznamy z těchto rozhraní API jsou k dispozici po dobu 30 dnů. Abyste zajistili, že obdržíte všechny očekávané záznamy, doporučujeme pravidelně sladit vaše úložiště záznamů, například každých 12 nebo 24 hodin.
Pro přístup k těmto rozhraním API musíte použít token přístupu partnera. Ověřující uživatel musí být úplným správcem partnera s úplným přístupem na úrovni správce organizace a musí mít povolený přístup k rozhraní Webex Calling CDR API. Token OAuth musí obsahovat rozsah. spark-admin:calling_cdr_read Role správce pouze pro čtení nestačí pro rozhraní API Odsouhlasení partnerů a Záznamy.
Použijte kon analytics-callingcový bod pro Webex Calling datovou oblast organizace zákazníka. Použijte příslušnou základní adresu URL pro rozhraní API Sesouhlasení a Záznamy:
- USA a Kanada:
https://analytics-calling.webexapis.com - Evropa:
https://analytics-calling-eu.webexapis.com - Indie:
https://analytics-calling-in.webexapis.com - Austrálie:
https://analytics-calling-au.webexapis.com
Rozsahy oken API jsou použitelné pro oba koncové body pro lepší zpracování zatížení služby.
- Pro časové rozsahy delší než 48 hodin je maximální povolená doba trvání okna 12 hodin (vynuceno).
- U ID partnerské organizace jsou rozhraní API omezena na jeden počáteční požadavek API za minutu a na rozsah tokenu. Pokud je použito stránkování, je povoleno až 10 dalších stránkovaných požadavků API za minutu a na token, které lze provést ihned po počátečním požadavku.
Koncový bod API pro odsouhlasení
Koncový bod rozhraní API pro odsouhlasení vrací celkový počet záznamů hovorů vygenerovaných pro každého zákazníka spravovaného partnerem v určeném časovém období. Tyto součty můžete použít k ověření místního úložiště a k identifikaci chybějících nebo nekonzistentních záznamů hovorů u konkrétních zákazníků.
Požadavek na přístup: Ověřující uživatel musí být administrátorem partnera s úplným přístupem na úrovni správce a musí mít povolený přístup k rozhraní Webex Calling CDR API. Přístupový token musí obsahovat spark-admin:calling_cdr_readrozsah.
Pokud spravujete více než 200 zákaznických organizací, rozhraní API výsledky stránkuje, aby se zlepšila čitelnost.
Adresa URL koncového bodu API pro sladění používá následující formát:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
Parametry API
API můžete použít k načtení záznamů hovorů za posledních 30 dní. Zvolené časové okno musí začínat nejméně 5 minut před aktuálním časem UTC a nesmí překročit 12 hodin mezi počátečním a koncovým časem v jediném volání API.
Parametry API jsou:
-
StartTime (vyžadováno, řetězec) — počáteční datum a čas (UTC) prvního záznamu, který chcete shromáždit. Zajistěte, aby:
- Čas formátujete jako
YYYY-MM-DDTHH:MM:SS.mmmZ. Například,2025-08-15T06:00:00.000Z.
- Počáteční datum a čas nesmí být starší než 30 dní od aktuálního času UTC.
- Okno mezi
startTimeaendTimenesmí přesáhnout 12 hodin.
- Čas formátujete jako
-
EndTime (vyžadováno, řetězec) —Datum a čas ukončení (UTC) záznamů, které chcete shromáždit. Záznamy jsou založeny na čase hlášení, což je okamžik, kdy je hovor hovor dokončen. Zajistěte, aby:
- Čas formátujete jako
YYYY-MM-DDTHH:MM:SS.mmmZ. Například,2025-08-15T18:00:00.000Z. - Datum a čas ukončení musí být 5 minut před aktuálním časem UTC a nesmí být starší než 30 dní.
- Datum a čas ukončení musí být větší než
startTime. - Okno mezi
startTimeaendTimenesmí přesáhnout 12 hodin.
- Čas formátujete jako
Příklad odpovědi JSON koncového bodu API pro odsouhlasení:
{
"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
}
]
}
Záhlaví odpovědí API udávají celkový počet vrácených organizací a zda jsou k dispozici další stránky. Zkontrolujte následující parametry záhlaví, abyste se ujistili, že jste dotazovali všechny stránky:
- num-pages: Celkový počet stran (například 2)
- total-orgs: Celkový počet organizací zahrnutých do odpovědi (například 283)
- current-page: Aktuální číslo stránky (například 1)
Pokud například záhlaví zobrazují číslo-pages=2, total-orgs=283 a current-page=1, zobrazujete první stránku dvoustránkové odpovědi obsahující celkem 283 organizací. Pro přístup na další stránku přidejte parametr page=2 do požadavku GET, jak je znázorněno níže:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2
Zaznamenává koncový bod API
Koncový bod API záznamů se používá k dotazování chybějících záznamů hovorů pro konkrétní organizace, kde byly rozpory nebo chybějící data identifikovány pomocí rozhraní API pro odsouhlasení.
Doporučený tok: Zavol /v1/partners/cdrcountbyorgejte nejprve. Poté použijte přesnou orgIdhodnotu vrá cdr_counts[].orgIdcenou při volání /v1/partners/cdrsbyorg.
Rozhraní API záznamů vrací záznamy volání ve formátu JSON, shodném s formátem popsaným v Rozhraní API pro podrobnou historii volání. Vrácené užitečné zatížení obsahuje stejná pole jako vrácené užitečné zatížení Detailní historie hovorů. Další informace o polích a jejich hodnotách naleznete v části Webex CallingPodrobná zpráva historie hovorů.
API poskytuje záznamy hovorů, které skončily 5 minut před aktuálním časem. Aby bylo zajištěno, že všechny záznamy hovorů budou k dispozici, doporučujeme dotazovat se na API jednu hodinu po preferovaném časovém okně.
Adresa URL koncového bodu API záznamů používá následující formát:
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
Parametry API
-
orgId(povinné, řetězec) — ID organizace zákazníka, pro kterou chcete načíst záznamy. Název parametru rozlišuje velká a malá písmena. ID organizace můžete získat z pole Odpovědi rozhraní API pro sladěnícdr_counts[].orgId. -
StartTime (vyžadováno, řetězec) — počáteční datum a čas (UTC) prvního záznamu, který chcete shromáždit. Zajistěte, aby:
- Čas formátujete jako
YYYY-MM-DDTHH:MM:SS.mmmZ. Například,2025-08-15T06:00:00.000Z. - Počáteční datum a čas nesmí být starší než 30 dní od aktuálního času UTC.
- Interval mezi
startTimeaendTimenesmí překročit 12 hodin v jednom požadavku API.
- Čas formátujete jako
-
EndTime (vyžadováno, řetězec) — datum a čas ukončení (UTC) posledního záznamu, který chcete shromáždit. Záznamy jsou založeny na čase hlášení, což je okamžik, kdy je hovor hovor dokončen. Zajistěte, aby:
- Čas formátujete jako
YYYY-MM-DDTHH:MM:SS.mmmZ. Například,2025-08-15T18:00:00.000Z. - Datum a čas ukončení musí být alespoň 5 minut před aktuálním časem UTC a nesmí být starší než 30 dní.
- Datum a čas ukončení musí být větší než
startTime. - Interval mezi
startTimeaendTimenesmí překročit 12 hodin v jednom požadavku API.
- Čas formátujete jako
-
max (nepovinné, počet) — Omezuje maximální počet záznamů na stránku v odpovědi. Zajistěte, aby:
- Rozsah je od 500 do 5000. Výchozí hodnota je 5000. Například,
max=1000. - Pokud má API více záznamů k návratu, než je zadaná maximální hodnota, pak je odpověď stránkována.
- Pokud je zadána hodnota pod 500, automaticky se nastaví až na 500. Pokud je zadána hodnota nad 5000, nastaví se na 5000.
- Rozsah je od 500 do 5000. Výchozí hodnota je 5000. Například,
Stránkování
Chcete-li zjistit, zda jsou odpovědi API stránkovány, zkontrolujte záhlaví odpovědí pro záhlaví odkazu. Pokud je nextodkaz přítomen v záhlaví Odkaz, extrahujte jej a použijte startTimeForNextFetchhodnotu k vyžádání další sady záznamů. Pokud neexistuje žádný další odkaz, jsou shromážděny všechny zprávy pro vybrané časové období.
Požadavky na API pro následující stránky lze podat okamžitě, ale musí být omezena na maximálně 10 stránkovaných požadavků za minutu, na rozsah tokenu.
Při načítání záznamů používejte idempotentní zpracování a deduplikaci, a to i napříč stránkovými odpověďmi nebo opakovanými okny odsouhlasení. Použijte reportIdjako primární klíč reportTimea určete poslední zpracovaný záznam.
Pokud je například počáteční požadavek 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
pak hlavička Odkazu v odpovědi je:
<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"
Stránkování používá pouze hlavičku rel="next"Odkaz. Pokud odpověď obsahuje rel="next"odkaz, použijte tuto adresu URL k načtení další stránky záznamů. Pokud odpověď neobsahuje rel="next"odkaz, načtli jste všechny dostupné záznamy pro vybrané časové období.
Stránkování pro toto rozhraní API se řídí standardem RFC5988 (Web Linking). Další informace naleznete v tématu Základy rozhraní REST API.
Pochopení kódů odezvy koncových bodů API
Tato část poskytuje přehled běžných kódů odpovědí, se kterými se můžete setkat při práci s koncovým bodem rozhraní API pro vyrovnání a kon covým bodem API záznamů. Tyto koncové body hrají klíčovou roli při synchronizaci, validaci a vytváření sestav dat. Pochopení těchto kódů odezvy je zásadní pro efektivní řešení problémů a pro udržení spolehlivých a stabilních integrací.
|
Kód odpovědi |
Popis kódu odpovědi |
|---|---|
|
200 |
OK |
|
400 |
Špatný požadavek: Žádost byla neplatná nebo nemůže být doručena jinak. Doprovodná chybová zpráva vysvětlí dále. |
|
401 |
Neopráv něné: Chyběly nebo byly nesprávné přihlašovací údaje. |
|
403 |
Zak ázáno: Žádost je pochopena, ale byla zamítnuta nebo přístup není povolen. |
|
404 |
Nenal ezeno: Požadovaný URI je neplatný nebo požadovaný zdroj, například uživatel, neexistuje. Vrátí se také, pokud požadovaný formát není podporován požadovanou metodou. |
|
405 |
Metoda není povolena: Požadavek byl odeslán na prostředek pomocí metody požadavku HTTP, která není podporována. |
|
409 |
Konflikt: Žádost nelze zpracovat, protože je v rozporu s nějakým zavedeným pravidlem systému. Například osoba nesmí být přidána do místnosti více než jednou. |
|
410 |
P ryč: Požadovaný zdroj již není k dispozici. |
|
415 |
Nepodporovaný typ média: Požadavek byl odeslán na zdroj bez zadání typu média nebo byl použit typ média, který není podporován. |
|
423 |
Zamč eno: Požadovaný zdroj je dočasně nedostupný. Může být přítomna hlavička Retry-After, která určuje, kolik sekund musíte počkat, než se pokusíte o požadavek znovu. |
|
428 |
Požadovaná podmín ka: Soubor (y) nelze zkontrolovat na přítomnost malwaru a je třeba je vynutit stažení. |
|
429 |
Příliš mnoho žádo stí: V daném čase bylo odesláno příliš mnoho žádostí a požadavek byl omezen sazbou. Měla by být přítomna hlavička Retry-After, která určuje, kolik sekund musíte počkat, než bude možné podat úspěšný požadavek. |
|
451 |
Ve výchozím nastavení |
|
500 |
Interní chyba serveru: Na serveru se něco pokazilo. Pokud problém přetrvává, obraťte se na [tým podpory vývojářů Webex] (/explore/support). |
|
502 |
Chybná brána: Server obdržel při zpracování požadavku neplatnou odpověď od předcházejícího serveru. Zkuste to znovu později. |
|
503 |
Služba nedostup ná: Server je přetížen požadavky. Zkuste to znovu později. |
|
504 |
Časový limit brány: Upstream server neodpověděl včas. Pokud váš dotaz používá parametr max, zkuste jej snížit. |
API partnerských zprávy/šablon
Pomocí rozhraní API partnerských sestav můžete generovat a stahovat přehledy dostupné v Partner Hub. Další informace naleznete v partnerské zprávě/šablonách.
Partneři mohou také přistupovat k více přehledům a stáhnout je přímo z centra Partner Hub. Další informace naleznete v přehle dech Partnerského centra.
Historie revizí
Historie revizí dokumentu
|
Datum revize |
V článku jsme provedli následující změny |
|---|---|
|
13/08/26 |
|
|
2/04/2026 |
|