Przegląd

Szczegółowy podsłuch Webhook rekordów połączeń pozwala na większą widoczność aktywności Webex Calling klientów w różnych celach, od rozliczeń po sprawozdawczość dostosowaną do indywidualnych potrzeb. Za pomocą tego haka Webhook można wygodnie gromadzić rekordy dla wszystkich klientów bez konieczności wyszukiwania rekordów dla każdego klienta po kolei. Ten webhook umożliwia opracowanie niestandardowych aplikacji raportowania i analityki zarówno dla wewnętrznych celów biznesowych, jak i świadczenia klientom usług o wartości dodanej. Aby zapoznać się z programem Webhook i towarzyszącymi mu interfejsami API, możesz obejrzeć ten plik vidcast.

Żądanie Webhook dostarcza rekordy co 5 minut. Każdy ładunek żądania Webhook zawiera rekordy dotyczące połączeń zakończonych 10–5 minut temu. Na przykład ładunek otrzymany o godzinie 17:00 obejmuje połączenia zakończone między 16:50 a 16:55. Połączenia, które kończą się między 16:55 a 17:00, będą miały ładunek 17:05.

Rejestry połączeń Webex są dostarczane w tym samym formacie co istniejące szczegółowe interfejsy API rekordów połączeń. Można skonfigurować podsłuch Webhook i wybrać między dwoma rodzajami źródła:

  • Analiza— obejmuje wszystkie rekordy połączeń dla wszystkich organizacji klientów, z którymi partner ma relację Webex Calling. Obejmuje to organizacje, dla których:
    • Partner zarządza organizacją klienta z rolą Partner Full Administrator.
    • Organizacja klienta posiada aktywną subskrypcję usługi Webex Calling w organizacji partnerskiej.
  • Rozliczenia — obejmuje tylko rekordy połączeń wykonanych przez użytkowników z licencją Webex Calling sprzedaną przez partnera. W tym źródle znajdują się rekordy połączeń dla obszarów roboczych.

Konfigurowanie adresu URL wywołania zwrotnego elementu webhook

Skonfiguruj żądanie Webhook w Partner Hub. Można skonfigurować tylko jeden hak Webhook dla organizacji partnerskiej. Aby skonfigurować hak Webhook, musisz być administratorem z pełnymi uprawnieniami.

1

Zaloguj się do Centrum partnerów.

2

Przejdź do obszaru Ustawienia organizacji > Rekordy szczegółów połączeń.

3

Wprowadź adres URL, który ma być używany pod adresem Webhook.

4

Jeśli chcesz uwierzytelnić pobrania żądania Webhook za pomocą tajnego tokena, możesz dodać jeden. Więcej informacji na temat webhoksów Webex i tajnych tokenów można znaleźć tutaj.

5

Wybierz jeden z następujących typów zasobó w do użycia dla haka Webhook:

  • Analiza— obejmuje wszystkie rekordy połączeń dla wszystkich organizacji klientów, z którymi partner ma relację Webex Calling.
  • Rozliczenie — zawiera tylko rekordy połączeń, do których partner sprzedał licencje Webex Calling. To źródło zawiera rekordy połączeń dla obszarów roboczych.
Konfiguracja żądania Webhook szczegółów połączeń w Partner Hub

Punkty końcowe API

Zapewniamy dwa punkty końcowe API wraz z hakiem Webhook, aby pomóc w uzgadnianiu danych. Te punkty końcowe pozwalają „nadrobić zaległości” lub pogodzić magazyny danych z brakującymi rekordami, które nie są odbierane przez słuchacza żądania Webhook. Te dwa interfejsy API są punktem końcowym Reconciliation AP I i punktem końcowym Records API.

Zapisy są dostępne z tych interfejsów API przez 48 godzin. Zalecamy okresowe uzgadnianie magazynów rekordów, np. co 12 lub 24 godziny, aby wszystkie rekordy były odbierane zgodnie z oczekiwaniami. Do korzystania z tego interfejsu API wymagany jest token dostępu partnera. Możesz uzyskać token dostępu partnera i zarządzać nim zgodnie ze standardowymi zasadami zarządzania tokenem dostępu Webex Developer.

Punkt końcowy interfejsu API pojednania

Punkt końcowy API uzgodnienia zwraca liczbę rekordów wygenerowanych przez każdego klienta, który jest zarządzany przez partnera w danym przedziale czasu. Jeśli partner zarządza ponad 200 organizacjami klientów, wyniki z interfejsu API zostaną wyświetlone w celu zapewnienia lepszej czytelności. Te sumy można wykorzystać do sprawdzenia lokalnego miejsca do przechowywania, jeśli brakuje jakichkolwiek rekordów dla określonych klientów. Tutaj można znaleźć adres URL punktu końcowego interfejsu API pojednania:

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

Parametry

Interfejs API pojednania może być wywoływany tylko przez maksymalny czas trwania 1 godziny, a parametry startTime i endTime nie mogą być dłuższe niż 60 minut. Interfejs API może być używany przez dowolny okres 1 godziny między 5 minutami a 48 godzinami temu, ale aby zarządzać obciążeniem usługi, można jednorazowo wywołać tylko 1 godzinę.

Dostępne są następujące parametry:

  • startTime (ciąg) — czas pierwszego raportu, który chcesz zebrać. Godzina raportu określa godzinę zakończenia połączenia.

    Godzinę należy sformatować jako RRRR-MM-DDTHH:MM:SS.mmmZ.

  • endTime (ciąg) — czas ostatniego raportu, który chcesz zebrać. Godzina raportu określa godzinę zakończenia połączenia.

    Podana godzina powinna być późniejsza niż startTime , ale nie późniejsza niż 48 godzin i należy ją sformatować w formacie RRRR-MM-DDTHH:MM:SS.mmmZ.

Oto przykład tego, jak wygląda payload zwracający punkt końcowy JSON interfejsu API uzgodnienia:

{ "cdr_counts": [{ "orgId": "zzzzzzzz-yyyyy-zzzz-xxxx-yyyyyyyyyyyyy", "count": 3009 }, { "orgId": "rrrr-rrrr-zzzz-xxxx-rrrr-rrrr-rrrr", "liczba": 129 }, { "orgId": "xxxxxxxx-rrrr-zzzz-xxxx-rrrr-rrrr", "liczba": 278 } ] } 

Nagłówki odpowiedzi interfejsu API wskazują całkowitą liczbę zwróconych organizacji oraz to, czy są dodatkowe strony. Sprawdź następujące parametry, aby upewnić się, że wszystkie strony zostały odebrane.

 num-stron = 2 total-orgs = 283 bieżąca strona = 1

Powyższe parametry pokazują, że bieżąca strona jest pierwszą stroną, że są łącznie 2 strony, a cała odpowiedź zawiera 283 organizacje. Aby uzyskać dostęp do drugiej strony, dodaj parametr page=2 do żądania GET , jak pokazano poniżej.

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

Punkt końcowy interfejsu API rekordów

Ten punkt końcowy interfejsu API zwraca rekordy połączeń w formacie JSON, identycznym z formatem opisanym w interfejsie API Szczegółowa historia połączeń. Zwrócona ładowność zawiera identyczne pola ze szczegółową historią połączeń zwracaną ładownością. Więcej szczegółów na temat wartości w każdym z pól można znaleźć tutaj. Punkt końcowy API rekordów służy do wyszukiwania brakujących rekordów dla organizacji, dla których brakuje rekordów. Adres URL punktu końcowego API rekordów można znaleźć tutaj:

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

Parametry

  • orgID — identyfikator organizacji, dla którego chcesz wyszukiwać rekordy. Identyfikatory te można otworzyć z poprzedniego punktu końcowego uzgodniania.

  • startTime (ciąg) — czas pierwszego raportu, który chcesz zebrać. Godzina raportu określa godzinę zakończenia połączenia.

    Określona godzina musi mieścić się w zakresie od 5 minut do 48 godzin temu i musi być sformatowana jako RRRR-MM-DDTHH:MM:SS.mmmZ.

  • endTime (ciąg) — czas ostatniego raportu, który chcesz zebrać. Godzina raportu określa godzinę zakończenia połączenia.

    Podana godzina powinna być późniejsza niż startTime , ale nie późniejsza niż 48 godzin i należy ją sformatować w formacie RRRR-MM-DDTHH:MM:SS.mmmZ.