Prehľad

Webhook Detailed Call Records vám umožní lepšie zviditeľniť aktivitu vašich zákazníkov Webex Calling na rôzne účely, od fakturácie až po hlásenie šité na mieru. Tento webhook môžete použiť na pohodlné zhromažďovanie záznamov pre všetkých vašich zákazníkov bez toho, aby ste museli vyhľadávať záznamy pre každého zákazníka jeden po druhom. Tento webhook vám umožňuje vyvíjať vlastné reportovacie a analytické aplikácie na interné obchodné účely alebo na poskytovanie služieb s pridanou hodnotou zákazníkom. Úvod do webhooku a jeho sprievodných rozhraní API si môžete pozrieť v tomto vidcaste.

Webhook dodáva záznamy každých 5 minút. Každá užitočná časť webhooku obsahuje záznamy o hovoroch, ktoré sa skončili pred 10 až 5 minútami. Napríklad užitočné zaťaženie prijaté o 17:00 zahŕňa hovory, ktoré sa skončili medzi 16:50 a 16:55. Hovory končiace medzi 16:55 a 17:00 budú v užitočnom zaťažení o 17:05.

Záznamy volaní Webex sa doručujú v rovnakom formáte ako existujúce rozhrania API na podrobné záznamy hovorov. Môžete si nastaviť webhook a vybrať si z dvoch typov informačných kanálov:

  • Analytics – zahŕňa všetky záznamy hovorov pre všetky zákaznícke organizácie, s ktorými má partner vzťah Webex Calling. To zahŕňa organizácie, pre ktoré:
    • Partner riadi organizáciu zákazníka s rolou úplného správcu partnera.
    • Zákaznícka organizácia má aktívne predplatné Webex Calling v rámci partnerskej organizácie.
  • Fakturácia – zahŕňa iba záznamy hovorov uskutočnených používateľmi s licenciou na volania Webex, ktorú predáva partner. Záznamy hovorov pre Workspaces sú zahrnuté v tomto informačnom kanáli.

Nastavte webovú adresu spätného volania webhooku

Nakonfigurujte webhook v partnerskom centre. Pre každú partnerskú organizáciu môžete nastaviť iba jeden webhook. Ak chcete nastaviť webhook, musíte byť úplným správcom.

1

Prihláste sa do Partnerského centra.

2

Prejdite do časti Nastavenia organizácie > Záznamy podrobností o hovoroch.

3

V časti Webhook zadajte adresu URL, ktorú chcete použiť.

4

Ak by ste chceli overiť svoje užitočné zaťaženia webhooku pomocou tajného tokenu, môžete ho pridať. Viac informácií o webhookoch a tajných tokenoch Webex nájdete tu.

5

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

  • Analytics – zahŕňa všetky záznamy hovorov pre všetky zákaznícke organizácie, s ktorými má partner vzťah Webex Calling.
  • Fakturácia – zahŕňa iba záznamy hovorov, ktorým partner predal licencie Webex Calling. Tento informačný kanál obsahuje záznamy hovorov pre pracovné priestory.
Zavolajte na nastavenie webhooku s podrobnými záznamami v partnerskom centre

Koncové body API

Spolu s webhookom poskytujeme dva koncové body API, ktoré vám pomôžu pri zosúlaďovaní údajov. Tieto koncové body vám umožňujú „dohnať“ alebo zosúladiť vaše dátové úložiská s chýbajúcimi záznamami, ktoré neprijíma webhookový poslucháč. Tieto dve rozhrania API sú koncový bod rozhrania Reconciliation API a koncový bod rozhrania Records API.

Záznamy sú dostupné z týchto rozhraní API 48 hodín. Odporúčame pravidelne zosúlaďovať sklady záznamov, napríklad každých 12 alebo 24 hodín, aby sa všetky záznamy prijímali podľa očakávania. Na používanie tohto rozhrania API sa vyžaduje prístupový token partnera. Môžete získať prístupový token partnera a spravovať ho podľa štandardných princípov správy prístupových tokenov Webex Developer.

Koncový bod rozhrania API odsúhlasenia

Koncový bod rozhrania API zosúlaďovania vráti počet záznamov vygenerovaných každým zákazníkom, ktoré spravuje partner v zadanom časovom období. Ak partner spravuje viac ako 200 zákazníckych organizácií, výsledky z API budú pre lepšiu čitateľnosť stránkované. Tieto súčty môžete použiť na kontrolu v porovnaní s lokálnym ukladacím priestorom, ak chýbajú nejaké záznamy pre konkrétnych zákazníkov. Webovú adresu koncového bodu rozhrania API pre zosúlaďovanie nájdete tu:

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

Parametre

Rozhranie API pre vyrovnanie je možné volať len po dobu maximálne 1 hodiny, pričom medzi parametrami startTime a endTime nie je viac ako 60 minút. Rozhranie API je možné použiť na ľubovoľné 1-hodinové obdobie medzi 5 minútami a 48 hodinami, ale na riadenie zaťaženia služby je možné volať naraz iba 1 hodinu.

Dostupné parametre sú:

  • startTime (reťazec) – čas prvého prehľadu, ktorý chcete zhromaždiť. Čas správy určuje čas dokončenia hovoru.

    Čas musíte naformátovať ako RRRR-MM-DDTHH:MM:SS.mmmZ.

  • endTime (reťazec) – čas posledného prehľadu, ktorý chcete zhromaždiť. Čas správy určuje čas dokončenia hovoru.

    Zadaný čas by mal byť neskorší ako startTime , ale nie neskôr ako 48 hodín a čas musíte naformátovať ako RRRR-MM-DDTHH:MM:SS.mmmZ.

Tu je príklad toho, ako vyzerá užitočné zaťaženie JSON koncového bodu rozhrania Reconciliation API:

{ "cdr_counts": [ { "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyy", "count": 3009 }, { "orgId": "yyyyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyyyy", "count": 129 }, { "orgId": "xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyyy", "count": 278 } ] } 

Hlavičky odpovede API označujú celkový počet vrátených organizácií a či existujú ďalšie stránky. Skontrolujte nasledujúce parametre, aby ste sa uistili, že boli dopytované všetky stránky.

 počet stránok = 2 celkom organizácie = 283 aktuálnych stránok = 1

Vyššie uvedené parametre ukazujú, že aktuálna stránka je prvá stránka, že celkovo existujú 2 stránky a že celá odpoveď obsahuje 283 organizácií. Prístup k druhej stránke získate pridaním parametra page=2 do požiadavky GET , ako je uvedené nižšie.

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

Koncový bod Records API

Tento koncový bod rozhrania API vracia záznamy hovorov vo formáte JSON, ktorý je identický s formátom opísaným v rozhraní API pre podrobnú históriu hovorov. Vrátená užitočná časť obsahuje identické polia ako vrátená užitočná časť podrobnej histórie hovorov. Ďalšie podrobnosti o hodnotách v každom vrátenom poli nájdete tu. Koncový bod API záznamov sa používa na vyhľadávanie chýbajúcich záznamov pre organizácie, pre ktoré chýbajú záznamy. Adresu URL koncového bodu API záznamov nájdete tu:

https://analytics.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

  • orgID – ID organizácie, pre ktorú chcete vyhľadávať záznamy. Tieto identifikátory môžete otvoriť z predchádzajúceho koncového bodu vyrovnania.

  • startTime (reťazec) – čas prvého prehľadu, ktorý chcete zhromaždiť. Čas správy určuje čas dokončenia hovoru.

    Zadaný čas musí byť medzi 5 minútami a 48 hodinami a čas musíte naformátovať ako RRRR-MM-DDTHH:MM:SS.mmmZ.

  • endTime (reťazec) – čas posledného prehľadu, ktorý chcete zhromaždiť. Čas správy určuje čas dokončenia hovoru.

    Zadaný čas by mal byť neskorší ako startTime , ale nie neskôr ako 48 hodín a čas musíte naformátovať ako RRRR-MM-DDTHH:MM:SS.mmmZ.