V tomto článku
Přehled
Nastavení adresy URL pro zpětné volání webhooku
dropdown icon
Koncové body partnerského API
    Koncový bod API pro odsouhlasení
    Koncový bod API pro záznamy
    Partner reports/templates API

Webhook s podrobnými záznamy hovorů pro Webex Calling v centru pro partnery

list-menuV tomto článku
list-menuZpětná vazba?

Multitenantní (MT) partneři Webex Calling mohou nastavit webhook pro shromažďování záznamů Webex Calling pro všechny vaše zákazníky. To umožňuje efektivní odsouhlasování fakturace, analýzy a reporting bez nutnosti dotazovat se každého zákazníka zvlášť.

Přehled

Webhook s podrobnými záznamy hovorů nabízí bezpečné, škálovatelné a robustní řešení řízené událostmi, nikoli požadavky. Tento webhook poskytuje lepší přehled o aktivitách vašich zákazníků v oblasti volání Webex a podporuje případy užití od fakturace až po reporting na míru.

Tento webhook můžete použít k pohodlnému shromažďování záznamů pro všechny zákazníky spravované prostřednictvím Centra pro partnery, aniž byste se museli dotazovat každého zákazníka jednotlivě. Tento webhook vám umožňuje vyvíjet vlastní aplikace pro reporting, fakturaci a analýzu jak pro interní obchodní požadavky, tak pro služby s přidanou hodnotou.

Úvod k webhooku a jeho doprovodným API naleznete v tomto videu: API pro podrobnou historii volání partnera Webex Calling.

Co nabízí webhook pro partnery

Webhook poskytuje podrobné záznamy historie hovorů každých 5 minut. Každý datový soubor webhooku obsahuje:

  • Záznamy hovorů, které skončily 10 až 5 minut před aktuálním časem.
  • Veškeré opožděné záznamy zpracované cloudem Webex Calling.
  • Automaticky doplňuje záznamy o pozdních hovorech v následných datových částech webhooku, aby bylo zajištěno spolehlivé doručení.

Pro znázornění, jak jsou záznamy o hovorech zahrnuty do jednotlivých datových částí, zvažte následující příklad:

  • Užitečné zatížení přijaté v 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 14:10 užitečné zatížení.
  • Záznamy dokončené dříve (například hovor, který skončil v 14:04) ale zpracováno opožděně cloudem Webex Calling (například v 14:11) jsou zahrnuty v dalším plánovaném datovém zatížení (například 14:15).

Webhooky spolehlivě doručují záznamy. V následných datových částech webhooku se však mohou zobrazit duplicitní záznamy, když systém za určitých podmínek přehrává záznamy. Jste zodpovědní za odstranění duplicitních záznamů. Pro identifikaci duplicitních záznamů použijte pole reportId jako primární klíč a pole reportTime k určení, kdy bylo volání dokončeno nebo zpracováno. Tato pole použijte k aktualizaci nebo vložení záznamů do interních úložišť dat.

Webhook v Parter Hubu

Poskytnutím webhooku povolíte analytické platformě odesílat záznamy hovorů na vaši adresu URL pro zpětné volání, kdykoli jsou vygenerovány.

Záznamy volání Webex jsou doručovány ve stejném formátu jako stávající podrobná rozhraní API pro záznamy volání. Můžete si nastavit webhook a vybrat si mezi dvěma typy feedů:

  • Analytika – Zahrnuje všechny záznamy o hovorech pro všechny zákaznické organizace, se kterými má partner vztah Webex Calling. To zahrnuje organizace, kde:
    • Partner spravuje organizaci zákazníka s rolí správce partnera s plným oprávněním.
    • Zákaznická organizace má aktivní předplatné služby Webex Calling v rámci partnerské organizace.
  • Fakturace – Zahrnuje záznamy o hovorech uskutečněných uživateli s licencí Webex Calling prodanou a zřízenou partnerem. Záznamy hovorů pro pracovní prostory jsou zahrnuty v tomto kanálu.

Přístup a ochrana osobních údajů

Přístup k záznamům o hovorech (CDR) pro účely fakturace má pouze vlastnící partner.

  • Partner (nebo subpartner), který spravuje licenci spojenou se záznamem hovoru, se stává vlastnícím partnerem.
  • Vlastnictví je určeno: ID uživatele > ID licence > ID předplatného > ID partnera.
  • Každý CDR je přístupný pouze jednomu partnerovi.
  • Některé záznamy o hovorech se nemapují k fakturačnímu partnerovi 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).

Nastavení adresy URL pro zpětné volání webhooku

Nakonfigurujte webhook v Centru pro partnery. Na partnerskou organizaci můžete nastavit pouze jeden webhook.

Ujistěte se, že máte roli partnera s plnou úrovní přístupu „Úplný administrátor organizace“ a že máte v Control Hubu (v části Správa ) zaškrtnuté políčko Přístup k rozhraní Webex Calling CDR API > Uživatelé, vyberte správce s plnými oprávněními nebo správce partnera s plnými oprávněními a poté vyberte Role správce > Partner).

Snímek obrazovky zobrazující nastavení rolí správce s vybranými možnostmi Správce partnera a Úplná správa partnera a zaškrtnutou možností Přístup k Webex Calling CDR API v části Funkční nastavení.

1

Přihlas se do partnerského centra.

2

Přejděte do Nastavení organizace > Záznamy podrobností o hovorech.

Snímek obrazovky nastavení organizace pro záznamy podrobností o volání, zobrazující pole pro URL webhooku, tajný token a typ zdroje s vybranou možností Analýza.
3

Zadejte URL adresu, kterou chcete použít, do pole Webhook.

URL adresa musí končit na /webhook (například, https://yourdomain.com/webhook).
4

Pokud chcete ověřit datové části webhooku pomocí tajného tokenu, můžete jej přidat. Chcete-li najít další informace o webhoocích a tajných tokenech Webex, podívejte se na Webex pro vývojáře: Webhooky.

5

Vyberte jeden z následujících typů prostředku, které chcete použít pro webhook:

  • Analytika– Zahrnuje všechny záznamy o hovorech pro všechny zákaznické organizace, se kterými má partner vztah Webex Calling.
  • Fakturace– Zahrnuje záznamy o hovorech uživatelů, kterým partner prodal licence Webex Calling. Záznamy hovorů pro pracovní prostory jsou zahrnuty v tomto kanálu.

Koncové body partnerského API

Kromě webhooku poskytuje Webex Calling 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 nemusel obdržet. Dva koncové body API jsou Reconciliation API a Records API.

Záznamy z těchto API jsou k dispozici po dobu 30 dnů. Abyste obdrželi všechny očekávané záznamy, doporučujeme pravidelně odsouhlasovat úložiště záznamů, například každých 12 nebo 24 hodin.

Pro přístup k těmto API musíte použít partnerský přístupový token. Získejte a spravujte svůj partnerský přístupový token v souladu se standardními postupy správy přístupových tokenů pro vývojáře Webex.

Rozsahy oken API jsou použitelné pro oba koncové body, aby se lépe zvládala zátěž služeb.

  • Pro časové rozsahy delší než 48 hodin je maximální povolená doba trvání okna 12 hodin (doporučeno a vynuceno).
  • Pro časové rozsahy 48 hodin nebo méně je maximální povolená délka okna 48 hodin (nedoporučuje se; tato možnost bude od 30. ledna 2026 zastaralá).
  • Pro ID partnerské organizace jsou API omezena rychlostí na jeden počáteční požadavek API za minutu na rozsah tokenu. Pokud se používá stránkování, je povoleno až 10 dalších stránkovaných požadavků API za minutu na token a tyto požadavky lze provést ihned po počátečním požadavku.

Koncový bod API pro odsouhlasení

Koncový bod rozhraní Reconciliation API vrací celkový počet záznamů o hovorech vygenerovaných pro každého zákazníka spravovaného partnerem v zadaném časovém období. Tyto součty můžete použít k ověření lokálního úložiště a k identifikaci chybějících nebo nekonzistentních záznamů o hovorech pro konkrétní zákazníky.

Pokud spravujete více než 200 zákaznických organizací, rozhraní API stránkyje výsledky pro lepší čitelnost.

URL koncového bodu rozhraní Reconciliation API 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

Pomocí API můžete načíst záznamy hovorů za posledních 30 dní. Vybrané časové okno musí začínat alespoň 5 minut před aktuálním časem UTC a nesmí překročit 12 hodin mezi časem zahájení a ukončení v jednom volání API.

Parametry API jsou:

  • startTime (povinné, řetězec) – Datum a čas zahájení (UTC) pro první záznam, 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.
    • Datum a čas zahájení nesmí být starší než 30 dní od aktuálního času UTC.
    • Okno mezi startTime a endTime nesmí překročit 12 hodin.
  • endTime (povinné, řetězec) – Datum a čas ukončení (UTC) pro záznamy, které chcete shromažďovat. Záznamy jsou založeny na čase hlášení, což je čas ukončení hovoru. 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 ne starší než 30 dní.
    • Datum a čas ukončení musí být větší než startTime.
    • Okno mezi startTime a endTime nesmí překročit 12 hodin.

Příklad odpovědi JSON koncového bodu Reconciliation API:


          {
          "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ědi API uvádí 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:

  • počet stránek: Celkový počet stránek (například 2)
  • total-orgs: Celkový počet organizací zahrnutých v odpovědi (například 283)
  • aktuální stránka: Číslo aktuální stránky (například 1)

Například pokud se v záhlavích zobrazuje num-pages=2, total-orgs=283, a current-page=1, Prohlížíte si první stránku dvoustránkové odpovědi obsahující celkem 283 organizací. Pro přístup k další stránce přidejte page=2 parametr do vašeho GET požadavku, 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

Koncový bod API pro záznamy

Koncový bod rozhraní Records API se používá k dotazování na chybějící záznamy hovorů pro konkrétní organizace, u kterých byly pomocí rozhraní Reconciliation API zjištěny nesrovnalosti nebo chybějící data.

Rozhraní Records API vrací záznamy hovorů ve formátu JSON, který je identický s formátem popsaným v podrobném rozhraní API pro historii hovorů. Vrácená datová část obsahuje identická pole jako vrácená datová část Podrobná historie volání. Další informace o polích a jejich hodnotách naleznete v článku Podrobná historie volání služby Webex.

API poskytuje záznamy o hovorech, které skončily 5 minut před aktuálním časem. Abyste zajistili dostupnost všech záznamů o hovorech, doporučujeme provést dotaz do API hodinu po uplynutí preferovaného časového okna.

URL koncového bodu rozhraní Records API 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, pro kterou chcete načíst záznamy. ID organizací můžete získat z rozhraní Reconciliation API.
  • startTime (povinné, řetězec) – Datum a čas zahájení (UTC) pro první záznam, 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.
    • Datum a čas zahájení nesmí být starší než 30 dní od aktuálního času UTC.
    • Interval mezi startTime a endTime nesmí v jednom požadavku API překročit 12 hodin.
  • endTime (povinné, řetězec) – Datum a čas ukončení (UTC) pro poslední záznam, který chcete shromáždit. Záznamy jsou založeny na čase hlášení, což je čas ukončení hovoru. 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 ne starší než 30 dní.
    • Datum a čas ukončení musí být větší než startTime.
    • Interval mezi startTime a endTime nesmí v jednom požadavku API překročit 12 hodin.
  • Max (volitelné, číslo) – 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 k vrácení více záznamů, než je zadaná maximální hodnota, pak se odpověď stránkuje.
    • Pokud je zadána hodnota nižší než 500, automaticky se upraví až na 500. Pokud je zadána hodnota vyšší než 5000, upraví se dolů na 5000.

Stránkování

Chcete-li zjistit, zda jsou odpovědi API stránkované, zkontrolujte v záhlavích odpovědí záhlaví odkazu. Pokud je v záhlaví odkazu přítomen odkaz next, extrahujte jej a použijte hodnotu startTimeForNextFetch k vyžádání další sady záznamů. Pokud neexistuje další odkaz, shromáždí se všechny přehledy pro vybrané časové období.

Požadavky API pro následné stránky lze provádět okamžitě, ale jejich rychlost musí být omezena na maximálně 10 stránkovaných požadavků za minutu na rozsah tokenu.

Například pokud je 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 je hlavička odkazu v odpovědi:

; rel="next"

Mezi další možné hodnoty odkazu patří rel="first" a rel="prev" pro první a předchozí stránku.

Stránkování pro toto API se řídí standardem RFC5988 (Web Linking). Více informací naleznete v článku Základy REST API.

Partner reports/templates API

Zprávy dostupné v Partner Hubu můžete generovat a stahovat pomocí rozhraní API pro partnerské zprávy. Více informací naleznete u partnera report/templates.

Partneři mohou také přistupovat k více reportům a stahovat je přímo z Centra pro partnery. Více informací naleznete v přehledech Centra partnerů.

Byl tento článek užitečný?
Byl tento článek užitečný?