V tomto článku
Prehľad
Nastavenie adresy URL spätného volania webhook
dropdown icon
Koncové body partnerského API
    Koncový bod API pre zosúladenie
    Koncový bod API zaznamenáva
Pochopenie kódov odozvy koncových bodov API
Správy partnerov/šablóny API
História revízií
Podrobný webhook záznamov hovorov pre Webex Calling v Partner Hub
list-menuV tomto článku
list-menuSpätná väzba?

Webex Calling partneri s viacerými nájomcami (MT) môžu nastaviť webhook na zhromažďovanie Webex Calling záznamov pre všetkých vašich zákazníkov. To umožňuje efektívne zosúladenie fakturácie, analýzu a vykazovanie bez toho, aby ste museli dopytovať každého zákazníka individuálne.

Prehľad

Webhook Detailed Call Records ponúka bezpečné, škálovateľné a robustné riešenie riadené skôr udalos ťami ako požiadavkami. Tento webový háčik poskytuje väčší prehľad o aktivitách vašich zákazníkov a Webex Calling podporuje prípady použitia od fakturácie až po vykazovanie prispôsobené na mieru.

Tento webový háčik môžete použiť na pohodlné zhromažďovanie záznamov pre všetkých zákazníkov spravovaných prostredníctvom Partner Hub bez toho, aby ste sa dotazovali každého zákazníka individuálne. Tento webhook vám umožňuje vytvárať vlastné aplikácie pre vý kazníctvo, fakturáciu a analytické aplikácie pre interné obchodné požiadavky aj služby s pridanou hodnotou.

Úvod do webhook a jeho sprievodných rozhraní API nájdete v tomto rozhraní Vidcast: Webex Calling Partner Detailed Call History API.

Čo prináša partnerský webhook

Webhook poskytuje podrobné záznamy histórie hovorov každých 5 minút. Každá užitočná záťaž webhook obsahuje:

  • Záznamy hovorov, ktoré skončili medzi 10 a 5 minútami pred aktuálnym časom.
  • Akékoľvek neskoré záznamy spracované Webex Calling cloudom.
  • Automaticky zaisťuje záznamy o neskorých hovoroch v nasledujúcich užitočných nákladoch webhook, aby sa zabezpeč ilo spoľahlivé doručenie.

Ak chcete ukázať, ako sú záznamy hovorov zahrnuté do každého užitočného zaťaženia, zvážte nasledujúci príklad:

  • Užitočné zaťaženie prijaté o 14:05 obsahuje hovory, ktoré skončili medzi 13:55 a 14:00.
  • Hovory končiace medzi 14:00 a 14:05 sú zahrnuté v užitočnom zaťažení 14:10.
  • Záznamy dokončené skôr (napríklad hovor, ktorý skončil o 14:04), ale neskoro sprac ované Webex Calling cloudom (napríklad o 14:11), sú zahrnuté do ďalšieho naplánovaného užitočného zaťaženia ( napríklad 14:15).

Webháky spoľahlivo dodávajú záznamy. Duplicitné záznamy však môžete dostať v nasledujúcich užitočných zaťaženiach webhook, keď systém opakuje záznamy za určitých podmienok. Ste zodpovedný za spracovanie deduplikácie záznamov. Ak chcete identifikovať duplicitné záznamy, použite pole Re portID ako primárny kľúč a pole Re portTime na určenie, kedy bol hovor dokončený alebo spracovaný. Tieto polia použite na aktualizáciu alebo vloženie záznamov do interných úložísk údajov.

Webhook v partnerskom centre

Poskytnutím webhooku umožníte analytickej platforme odosielať záznamy hovorov na vašu adresu URL spätného volania vždy, keď sú generované.

Webex Callingzáznamy sa dodávajú v rovnakom formáte ako existujúce rozhrania API detailných záznamov hovorov. Môžete nastaviť webhook a vybrať si z dvoch typov informačných kanálov:

  • Analytika — Zahŕňa všetky záznamy hovorov pre všetky zákaznícke organizácie, s ktorými má partner vzťah. Webex Calling Patria sem organizácie, v ktorých:
    • Partner riadi organizáciu zákazníkov s úlohou Partner Full Administrator.
    • Zákaznícka organizácia má aktívne Webex Calling predplatné v rámci partnerskej organizácie.
  • Fakturácia — Zahŕňa záznamy hovorov pre hovory uskutočnené používateľmi s Webex Calling licenciou predávanou a poskytnutou partnerom. Záznamy hovorov pre pracovné priestory sú zahrnuté v tomto informačnom kanáli.

Prístup a súkromie údajov

Pre fakturáciu má prístup k záznamom o podrobnostiach hovorov (CDR) iba vlastnícky partner.

  • Partner (alebo subpartner), ktorý spravuje licenciu spojenú so záznamom hovoru, sa stáva vlastníkom.
  • Vlastníctvo určuje: ID používateľa > ID licencie > ID predplatného > ID partnera.
  • Každý CDR je prístupný jedinému partnerovi.
  • Niektoré záznamy hovorov sa nezobrazujú na fakturačného partnera a nie všetci partneri spojení s organizáciou majú rovnaký prístup ku všetkým záznamom, pretože tieto záznamy môžu obsahovať osobne identifikovateľné informácie (PII).

Nastavenie adresy URL spätného volania webhook

Nakonfigurujte webový hák v centre Partner Hub. Na partnerskú organizáciu môžete nastaviť iba jeden webhook.

Uistite sa, že máte v Control Hub začiarknutú úlohu plného správcu partnera s „Prístu pom na plnej úrovni správcu organizácie“ a prístup k rozhraniu Webex Calling CDR API (v časti S práva > Použí vatelia vyberte úplného správcu alebo úplného správcu partnera a potom vyberte položku Role správ cu > Partner).

Rovnaké požiadavky na prístup platia aj pri používaní rozhrania rozhrania rozhrania partnerov a záznamov.

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

Prihláste sa do Partner Hub.

2

Prejdite do časti Nastavenia organizácie > Zá znamy o podrobnostiach hovorov.

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

Zadajte adresu URL, ktorú chcete použiť v časti Webhook.

Adresa URL musí končiť na /webhook (napríklad https://yourdomain.com/webhook).
4

Ak chcete overiť svoje užitočné zaťaženie webhook pomocou tajného tokenu, môžete ho pridať. Ďalšie informácie o webových hákoch a tajných tokenoch Webex nájdete v časti Webex pre vývojárov: Webhook.

5

Vyberte jeden z nasledujúcich ty pov zdroja, ktorý chcete použiť pre webhook:

  • Analytics — Zahŕňa všetky záznamy hovorov pre všetky zákazníc ke organizácie, s ktorými má partner Webex Calling vzťah.
  • Faktur ácia — Zahŕňa záznamy hovorov pre používateľov, ktorým partner predal Webex Calling licencie. Záznamy hovorov pre pracovné priestory sú zahrnuté v tomto informačnom kanáli.

Koncové body partnerského API

Okrem webhook Webex Calling poskytuje koncové body API na podporu zosúladenia údajov. Tieto koncové body vám umožňujú dohnať alebo zosúladiť vaše dátové úložiská s akýmikoľvek chýbajúcimi záznamami, ktoré váš poslucháč webhook možno nedostal. Dva koncové body rozhrania API sú Rec onpliation API a Records API.

Záznamy z týchto rozhraní API sú k dispozícii 30 dní. Aby ste zabezpečili, že dostanete všetky očakávané záznamy, odporúčame pravidelne zosúlaďovať svoje záznamy, napríklad každých 12 alebo 24 hodín.

Na prístup k týmto rozhraním API musíte použiť token prístupu pre partnerov. Autentifikujúci používateľ musí byť úplným správcom partnera s prístupom na úrovni správcu organizácie a musí mať povolený prístup k roz Webex Callinghraniu CDR API. Token OAuth musí obsahovať rozsah. spark-admin:calling_cdr_read Úlohy správcu iba na čítanie nie sú dostatočné pre rozhrania API pre zosúladenie partnerov a záznamy.

Použite kon analytics-callingcový bod pre dátovú oblasť zákazníckej organiz Webex Calling ácie. Použite príslušnú základnú adresu URL pre rozhranie API zosúladenia a záznamov:

  • USA a Kanada: https://analytics-calling.webexapis.com
  • Európa: https://analytics-calling-eu.webexapis.com
  • India: https://analytics-calling-in.webexapis.com
  • Austrália: https://analytics-calling-au.webexapis.com

Rozsahy okien API sú použiteľné pre oba koncové body na lepšie zvládnutie zaťaženia služieb.

  • Pre časové rozsahy dlhšie ako 48 hodín je maximálna povolená dĺžka trvania okna 12 hodín (vynútené).
  • V prípade ID partnerskej organizácie sú rozhrania API obmedzené na jednu počiatočnú požiadavku API za minútu na rozsah tokenu. Ak sa použije paginácia, je povolených až 10 ďalších stránkovaných požiadaviek API za minútu na jeden token, ktoré je možné vykonať ihneď po počiatočnej žiadosti.

Koncový bod API pre zosúladenie

Koncový bod rozhrania rozhrania rozhrania vráti celkový počet záznamov hovorov generovaných pre každého zákazníka spravovaného partnerom v stanovenom časovom období. Tieto súčty môžete použiť na overenie miestneho úložiska a identifikáciu chýbajúcich alebo nekonzistentných záznamov hovorov pre konkrétnych zákazníkov.

Požiadavka na prístup: Autentifikujúci používateľ musí byť partnerským správcom s úplným prístupom na úrovni správcu a musí mať povolený prístup k Webex Callingrozhraniu CDR API. Prístupový token musí obsahovať spark-admin:calling_cdr_readrozsah.

Ak spravujete viac ako 200 zákazníckych organizácií, API zobrazuje výsledky na stránkach, aby sa zlepšila čitateľnosť.

Koncová adresa URL koncového bodu rozhrania rozhrania API používa nasledujúci formát:

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

Parametre API

Rozhranie API môžete použiť na načítanie záznamov hovorov z posledných 30 dní. Zvolené časové okno sa musí začať najmenej 5 minút pred aktuálnym časom UTC a nesmie prekročiť 12 hodín medzi začiatočným a koncovým časom v jednom volaní API.

Parametre API sú:

  • StartTime (povinný, reťazec) —dátum a čas začiatku (UTC) pre prvý záznam, ktorý chcete zhromaždiť. Uistite sa, že:
    • Čas formátujete ako YYYY-MM-DDTHH:MM:SS.mmmZ. Napríklad, 2025-08-15T06:00:00.000Z.
    • Dátum a čas začiatku nesmú byť staršie ako 30 dní od aktuálneho času UTC.
    • Okno medzi startTimea endTimenesmie presiahnuť 12 hodín.
  • EndTime (povinný, reťazec) — dátum a čas ukončenia (UTC) pre záznamy, ktoré chcete zhromaždiť. Záznamy sú založené na čase hlásenia, ktorý je v čase hovoru ukončený. Uistite sa, že:
    • Čas formátujete ako YYYY-MM-DDTHH:MM:SS.mmmZ. Napríklad, 2025-08-15T18:00:00.000Z.
    • Dátum a čas ukončenia musia byť 5 minút pred aktuálnym časom UTC a nie staršie ako 30 dní.
    • Dátum a čas ukončenia musia byť väčšie ako startTime.
    • Okno medzi startTimea nes endTimemie presiahnuť 12 hodín.

Príklad odpovede JSON koncového bodu rozhrania 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
          }
          ]
          }          
        

Hlavičky odpovedí API označujú celkový počet vrátených organizácií a to, či sú k dispozícii ďalšie stránky. Skontrolujte nasledujúce parametre hlavičky, aby ste sa uistili, že ste vyhľadali všetky stránky:

  • počet stránok: Celkový počet strán (napr. 2)
  • celkové organizácie: Celkový počet organizácií zahrnutých do odpovede (napríklad 283)
  • aktuálna stránka: Aktuálne číslo stránky (napríklad 1)

Ak sa napríklad v hlavičkách zobrazuje num-pages=2, total-orgs=283 a current-page=1, zobrazuje sa prvá stránka dvojstranovej odpovede obsahujúcej celkovo 283 organizácií. Ak chcete prejsť na ďalšiu stránku, pridajte parameter page=2 do svojej žiadosti GET, ako je znázornené nižšie:

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 zaznamenáva

Koncový bod rozhrania Records API sa používa na vyhľadávanie chýbajúcich záznamov hovorov pre konkrétne organizácie, v ktorých boli zistené nezrovnalosti alebo chýbajúce údaje pomocou rozhrania rozhrania Reconpliation API.

Odporúčaný tok: Naj /v1/partners/cdrcountbyorgprv zavolajte. Potom cdr_counts[].orgIdpri zavolaní použite presné orgIdvrátené číslo /v1/partners/cdrsbyorg.

Rozhranie Records API vracia záznamy hovorov vo formáte JSON, identickom s formátom opísaným v rozhraní API Detailná história hovor ov. Vrátené užitočné zaťaženie obsahuje rovnaké polia s vráteným užitočným zaťažením podrobnej histórie hovorov. Ďalšie informácie o poliach a ich hodnotách nájdete v časti Webex CallingPodrobná správa histórie hovorov.

Rozhranie API poskytuje záznamy hovorov, ktoré skončili 5 minút pred aktuálnym časom. Aby sme sa uistili, že všetky záznamy hovorov sú k dispozícii, odporúčame vám zadať dotaz do rozhrania API hodinu po preferovanom časovom okne.

URL koncového bodu rozhrania Records API používa nasledujúci 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

Parametre API

  • orgId(povinné, reťazec) — ID organizácie zákazníka, pre ktoré chcete načítať záznamy. Názov parametra rozlišuje veľké a veľké písmená. Identifikácie organizácie môžete získať z poľa odpovede rozhrania Reconpliation API cdr_counts[].orgId.
  • StartTime (povinný, reťazec) —dátum a čas začiatku (UTC) pre prvý záznam, ktorý chcete zhromaždiť. Uistite sa, že:
    • Čas formátujete ako YYYY-MM-DDTHH:MM:SS.mmmZ. Napríklad, 2025-08-15T06:00:00.000Z.
    • Dátum a čas začiatku nesmú byť staršie ako 30 dní od aktuálneho času UTC.
    • Interval medzi startTimea nes endTimemie presiahnuť 12 hodín v jednej požiadavke API.
  • EndTime (povinný, reťazec) —dátum a čas ukončenia (UTC) posledného záznamu, ktorý chcete zhromaždiť. Záznamy sú založené na čase hlásenia, ktorý je v čase hovoru ukončený. Uistite sa, že:
    • Čas formátujete ako YYYY-MM-DDTHH:MM:SS.mmmZ. Napríklad, 2025-08-15T18:00:00.000Z.
    • Dátum a čas ukončenia musia byť najmenej 5 minút pred aktuálnym časom UTC a nie staršie ako 30 dní.
    • Dátum a čas ukončenia musia byť väčšie ako startTime.
    • Interval medzi startTimea nes endTimemie presiahnuť 12 hodín v jednej požiadavke API.
  • max (voliteľné, číslo) —Obmedzuje maximálny počet záznamov na stranu v odpovedi. Uistite sa, že:
    • Rozsah je od 500 do 5000. Predvolená hodnota je 5000. Napríklad, max=1000.
    • Ak má rozhranie API viac záznamov, ktoré treba vrátiť ako zadaná maximálna hodnota, odpoveď sa zobrazí na stránkach.
    • Ak je zadaná hodnota nižšia ako 500, automaticky sa nastaví na 500. Ak je zadaná hodnota vyššia ako 5000, upraví sa na 5000.

Stránkovanie

Ak chcete zistiť, či sú odpovede API stránkované, skontrolujte hlavičky odpovedí pre hlavičku prepojenia. Ak je pre nextpojenie prítomné v hlavičke prepojenia, extrahujte ho a použite startTimeForNextFetchhodnotu na vyžiadanie ďalšej sady záznamov. Ak neexistuje ďalší odkaz, zhromaždia sa všetky správy pre zvolený časový rozsah.

Požiadavky API pre nasledujúce stránky je možné zadať okamžite, ale musia byť rýchlosťou obmedzená na maximálne 10 stránkovaných požiadaviek za minútu na rozsah tokenu.

Pri načítaní záznamov použite spracovanie idempotentné a deduplikáciu, a to aj naprieč stranovými odpoveďami alebo oknami opakovaného zosúladenia. Použite reportIdako primárny kľúč a reportTimena určenie najnovšieho spracovaného záznamu.

Napríklad, ak je počiatočná požiadavka 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

potom hlavička odkazu v odpovedi 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ánkovanie používa iba hlavičku pre rel="next"pojenia. Ak odpoveď obsahuje od rel="next"kaz, použite túto adresu URL na načítanie ďalšej stránky záznamov. Ak odpoveď neobsahuje od rel="next"kaz, načítali ste všetky dostupné záznamy pre vybraný časový rozsah.

Stránkovanie tohto rozhrania API sa riadi štandardom RFC5988 (Web Linking). Ďalšie informácie nájdete v téme Zá klady rozhrania REST API.

Pochopenie kódov odozvy koncových bodov API

Táto časť poskytuje prehľad bežných kódov odpovedí, ktoré sa môžu vyskytnúť pri práci s koncovým bodom rozhrania Recon pliation API a koncovým bo dom rozhran ia Records API. Tieto koncové body zohrávajú rozhodujúcu úlohu pri synchronizácii údajov, validácii a vykazovaní. Pochopenie týchto kódov odozvy je nevyhnutné pre efektívne riešenie problémov a na udržanie spoľahlivých a stabilných integrácií.

Tabuľka 1. Kódy odozvy koncových bodov API

Kód odpovede

Popis kódu odpovede

200

OK

400

Zlá požiadavka: Žiadosť bola neplatná alebo ju nemožno doručiť inak. Sprievodné chybové hlásenie bude vysvetlené ďalej.

401

Neopráv nené: autentifikačné poverenia chýbali alebo boli nesprávne.

403

Zakázané: Žiadosť je pochopená, ale bola zamietnutá alebo prístup nie je povolený.

404

Nenáj dené: Požadované URI je neplatné alebo požadovaný zdroj, napríklad používateľ, neexistuje. Vráti sa aj vtedy, keď požadovaný formát nie je podporovaný požadovanou metódou.

405

Metóda nie je povol ená: Žiadosť bola zadaná na zdroj pomocou metódy žiadosti HTTP, ktorá nie je podporovaná.

409

Konflikt: Žiadosť sa nedala spracovať, pretože je v rozpore s niektorým zavedeným pravidlom systému. Napríklad osoba nesmie byť pridaná do miestnosti viac ako raz.

410

Pre č: Požadovaný zdroj už nie je k dispozícii.

415

Nepodporovaný typ média: Žiadosť bola predložená na zdroj bez špecifikácie typu média alebo použil typ média, ktorý nie je podporovaný.

423

Zamknuté: Požadovaný zdroj je dočasne nedostupný. Môže byť prítomná hlavička Retry-After, ktorá určuje, koľko sekúnd musíte počkať pred opätovným pokusom o žiadosť.

428

Požadovaná predpoklad: Súbory nie je možné skenovať na prítomnosť škodlivého softvéru a je potrebné ich nútene stiahnuť.

429

Príliš veľa žiadostí: V danom čase bolo odoslaných príliš veľa žiadostí a žiadosť bola obmedzená. Mala by byť prítomná hlavička Retry-After, ktorá určuje, koľko sekúnd musíte počkať, kým bude možné vykonať úspešnú žiadosť.

451

V predvolenom nastavení analytics-calling.webexapis.comsú požiadavky smerované na najbližšie regionálne servery. Ak tieto servery hostia údaje organizácie, rozhranie API vráti údaje. V opačnom prípade API vráti HTTP 451 a telo odpovede identifikuje koncový bod, kde môžete načítať údaje organizácie.

500

Interná chyba servera: Na serveri sa niečo pokazilo. Ak problém pretrváva, neváhajte kontaktovať [tím podpory pre vývojárov Webex] (/explore/support).

502

Zlá br ána: Server dostal počas spracovania žiadosti neplatnú odpoveď od upstream servera. Skúste to znova neskôr.

503

Služba nedostup ná: Server je preťažený požiadavkami. Skúste to znova neskôr.

504

Časový limit brány: Upstream server nereagoval včas. Ak váš dotaz používa parameter max, skúste ho znížiť.

Správy partnerov/šablóny API

Prehľady dostupné v centre partnerov môžete generovať a sťahovať pomocou rozhrania API prehľadov partnerov. Ďalšie informácie nájdete v správe/šab lónach partnera.

Partneri môžu tiež pristupovať a sťahovať viaceré správy priamo z centra Partner Hub. Ďalšie informácie nájdete v prehľ ade Partner Hub.

História revízií

História revízií dokumentu

Dátum revízie

V článku sme urobili nasledujúce zmeny

13/08/26

  • Požiadavka na rolu koncového bodu rozhrania API: Autentifikujúci používateľ musí byť správcom partnera s úplným prístupom na úrovni správcu. Tiež musí byť povolený prístup Webex Calling CDR API.

  • Kódy odozvy koncových bodov rozhrania API sú aktualizované tak, aby obsahovali kód chyby 451.

  • Pridané regionálne koncové body pre dátový región zákazníckej organiz Webex Calling ácie.

2/04/2026

  • Vytvorila tabuľku histórie revízií, ktorá sleduje všetky zmeny vykonané v priebehu času.

  • Aktualizovali sekcie koncového bodu rozhrania rozhrania rozhrania a koncového bodu rozhrania záznamy, aby zahŕňali hodnoty tabuľky alebo chybového kódu.

Bol tento článok užitočný?
Bol tento článok užitočný?