Дякуємо за відгук.

Веб-хук Детальних записів дзвінків пропонує безпечне, масштабоване та надійне рішення, кероване подіями, а не запитами. Цей веб-хук забезпечує більшу видимість Webex Calling діяльності ваших клієнтів, підтримуючи випадки використання від виставлення рахунків до індивідуальних звітів.

Ви можете використовувати цей веб-хук, щоб зручно збирати записи для всіх клієнтів, керованих через Partner Hub, не запитуючи кожного клієнта окремо. Цей веб-хук дозволяє розроб ляти спеціальні програми звітності, виставлення рахунків та аналітики як для внутрішніх бізнес-вимог, так і для послуг з доданою вартістю.

Щоб ознайомитися з веб-хуком та супутніми API, перегляньте цей Vidcast: API детальної історії дзві Webex Calling нків партнер а.

Що пропонує веб-хук партнера

Вебхук надає детальні записи історії дзвінків кожні 5 хвилин. Кожне корисне навантаження веб-хука містить:

• Записи дзвінків, які закінчилися за 10 хвилин до 5 хвилин до поточного часу.
• Будь-які пізні записи, оброблені Webex Calling хмарою.
• Автоматично заповнює записи пізніх дзвінків у наступні корисні навантаження веб-хука для забезпечення надійної доставки.

Щоб показати, як записи дзвінків включаються до кожного корисного навантаження, розглянемо наступний приклад:

• Корисне навантаження, отримане о 14:05, містить дзвінки, які закінчилися між 13:55 і 14:00.
• Дзвінки, що закінчуються між 14:00 і 14:05 включені в корисне навантаження 14:10.
• Записи, виконані раніше (наприклад, виклик, який закінчився о 14:04), але оброб лені пізно Webex Calling хмарою (наприклад, о 14:11), включаються до наступного запланованого корисного навантаження ( наприклад, 14:15).

Вебхук в партнерському центрі

Надаючи веб-хук, ви дозволяєте аналітичній платформі надсилати записи дзвінків на вашу URL-адресу зворотного дзвінка щоразу, коли вони генеруються.

Webex Callingзаписи доставляються з використанням того ж формату, що і існуючі API детальних записів викликів. Ви можете налаштувати веб-хук і вибрати один з двох типів кормів:

• Аналітика — включає всі записи дзвінків для всіх організацій-клієнтів, з якими партнер має Webex Calling стосунки. Сюди входять організації, де:
  • Партнер керує організацією клієнта з роллю повного адміністратора партнера.
  • Організація-замовник має активну Webex Calling підписку всередині організації-партнера.
• Оплата. Включає записи дзвінків для дзвінків, здійснених користувачами з Webex Calling ліцензією, проданою та наданою партнером. Записи викликів для робочих просторів включені до цього каналу.

Доступ та конфіденційність даних

Тільки власник партнера може отримати доступ до записів деталей дзвінків (CDR) для виставлення рахунків.

• Партнер (або субпартнер), який керує ліцензією, пов'язаною із записом дзвінків, стає власником партнера.
• Право власності визначається за допомогою: Ідентифікатор користувача > Ідентифікатор ліцензії > Ідентифікатор передплати > Іденти фікатор партнера
• Кожна CDR доступна одному партнеру.
• Деякі записи дзвінків не відображаються з платіжним партнером, і не всі партнери, пов'язані з організацією, отримують рівний доступ до всіх записів, оскільки ці записи можуть містити особисту ідентифікаційну інформацію (PII).

На додаток до веб-хука, Webex Calling надає кінцеві точки API для підтримки узгодження даних. Ці кінцеві точки дозволяють вам наздогнати або узгоджувати ваші сховища даних з відсутніми записами, які слухач веб-хука, можливо, не отримав. Дві кінцеві точки API — API уз годження та API записів.

Записи з цих API доступні протягом 30 днів. Щоб гарантувати, що ви отримуєте всі очікувані записи, ми рекомендуємо періодично узгоджувати свої магазини платівок, наприклад, кожні 12 або 24 години.

Для доступу до цих API потрібно використовувати маркер доступу партнера. Користувач, який здійснює автентифікацію, повинен бути повним адміністратором партнера з повним доступом до рівня адміністратора організації та мати увімк Webex Callingнений доступ до API CDR. Токен OAuth повинен включати сферу застосування. spark-admin:calling_cdr_read Ролей адміністратора лише для читання недостатньо для API узгодження партнерів та записів.

Використовуйте analytics-callingкінцеву точку для регіону Webex Calling даних організації-замовника. Використовуйте відповідну базову URL-адресу як для API звірки, так і для записів:

• США та Канада: https://analytics-calling.webexapis.com
• Європа: https://analytics-calling-eu.webexapis.com
• Індія: https://analytics-calling-in.webexapis.com
• Австралія: https://analytics-calling-au.webexapis.com

Кінцева точка API звірки

Кінцева точка API узгодження повертає загальну кількість записів дзвінків, створених для кожного клієнта, яким керує партнер, протягом зазначеного періоду часу. За допомогою цих підсумків можна перевірити локальне сховище та визначити будь-які відсутні або суперечливі записи дзвінків для певних клієнтів.

Якщо ви керуєте більш ніж 200 організаціями клієнтів, API встановлює сторінки результатів для покращення читабельності.

URL-адреса кінцевої точки API узгодження використовує наступний формат:

Параметри API

Ви можете використовувати API для отримання записів дзвінків за останні 30 днів. Вибране вікно часу має розпочатися принаймні за 5 хвилин до поточного часу UTC і не може перевищувати 12 годин між часом початку та закінчення одного виклику API.

Параметри API такі:

• StartTime (обов'язково, рядок) — дата і час початку (UTC) першого запису, який потрібно зібрати. Переконайтеся, що:
  • Ви форматуєте час як YYYY-MM-DDTHH:MM:SS.mmmZ. Наприклад, 2025-08-15T06:00:00.000Z.
  • Дата та час початку не повинні бути старшими 30 днів від поточного часу UTC.
  • Вікно між startTimeі не endTimeможе перевищувати 12 годин.
• EndTime (обов'язково, рядок) — дата і час завершення (UTC) для записів, які потрібно зібрати. Записи базуються на часі звіту, коли дзвінок виконується. Переконайтеся, що:
  • Ви форматуєте час як YYYY-MM-DDTHH:MM:SS.mmmZ. Наприклад, 2025-08-15T18:00:00.000Z.
  • Дата і час завершення повинні бути за 5 хвилин до поточного часу UTC і не старше 30 днів.
  • Дата і час закінчення повинні бути більшими за startTime.
  • Вікно між startTimeі не endTimeможе перевищувати 12 годин.

Приклад відповіді JSON кінцевої точки 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
          }
          ]
          }          
        

Заголовки відповідей API вказують загальну кількість повернутих організацій і чи доступні додаткові сторінки. Перевірте наступні параметри заголовка, щоб переконатися, що ви запитували всі сторінки:

• num-pages: Загальна кількість сторінок (наприклад, 2)
• total-orgs: Загальна кількість організацій, включених у відповідь (наприклад, 283)
• current-page: Поточний номер сторінки (наприклад, 1)

Наприклад, якщо заголовки показують num-pages=2, total-orgs=283 та current-page=1, ви переглядаєте першу сторінку двосторінкової відповіді, що містить загалом 283 організації. Для доступу до наступної сторінки додайте параметр page=2 до запиту GET, як показано нижче:

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

Записує кінцеву точку API

Кінцева точка API записів використовується для запиту відсутніх записів викликів для певних організацій, де розбіжності або відсутні дані були виявлені за допомогою API звірки.

Рекомендований потік: спочатку зателе /v1/partners/cdrcountbyorgфонуйте. Потім використовуйте точне, orgIdповернене cdr_counts[].orgIdпід час дзвінка /v1/partners/cdrsbyorg.

API записів повертає записи викликів у форматі JSON, ідентичному формату, описаному в API детальної історії викликів. Повернуте корисне навантаження містить ідентичні поля з поверненим корисним навантаженням Детальної історії викликів. Для отримання додаткової інформації про поля та їх значення див. Детальний зві Webex Calling т про історію викликів.

API надає записи викликів, які закінчилися за 5 хвилин до поточного часу. Щоб забезпечити доступність усіх записів викликів, ми рекомендуємо запитувати API через годину після бажаного часового вікна.

URL-адреса кінцевої точки API записів використовує наступний формат:

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

Параметри API

• orgId(required, string) — Ідентифікатор організації клієнта, для якого потрібно отримати записи. Назва параметра залежить від регістру регістру. Ідентифікатори організації можна отримати з поля відповіді API узгодження cdr_counts[].orgId.
• StartTime (обов'язково, рядок) — дата і час початку (UTC) першого запису, який потрібно зібрати. Переконайтеся, що:
  • Ви форматуєте час як YYYY-MM-DDTHH:MM:SS.mmmZ. Наприклад, 2025-08-15T06:00:00.000Z.
  • Дата та час початку не повинні бути старшими 30 днів від поточного часу UTC.
  • Інтервал між startTimeі не endTimeповинен перевищувати 12 годин в одному запиті API.
• EndTime (обов'язково, рядок) — дата і час завершення (UTC) останнього запису, який потрібно зібрати. Записи базуються на часі звіту, коли дзвінок виконується. Переконайтеся, що:
  • Ви форматуєте час як YYYY-MM-DDTHH:MM:SS.mmmZ. Наприклад, 2025-08-15T18:00:00.000Z.
  • Дата і час завершення повинні бути принаймні за 5 хвилин до поточного часу UTC і не старше 30 днів.
  • Дата і час закінчення повинні бути більшими за startTime.
  • Інтервал між startTimeі не endTimeповинен перевищувати 12 годин в одному запиті API.
• max (необов'язково, кількість) — Обмежує максимальну кількість записів на сторінку у відповіді. Переконайтеся, що:
  • Діапазон становить від 500 до 5000. Значення за замовчуванням - 5000. Наприклад, max=1000.
  • Якщо API має більше записів для повернення, ніж вказане максимальне значення, відповідь буде розміщена на сторінках.
  • Якщо вказано значення нижче 500, воно автоматично регулюється до 500. Якщо вказано значення вище 5000, воно регулюється до 5000.

нумерація сторінок

Щоб визначити, чи є відповіді API сторінками, перевірте заголовки відповідей на заголовок посилання. Якщо nextпосилання присутнє в заголовку посилання, витягніть його та використовуйте startTimeForNextFetchзначення для запиту наступного набору записів. Якщо немає наступного посилання, то збираються всі звіти за обраний часовий діапазон.

Запити API для наступних сторінок можуть бути зроблені негайно, але швидкість повинна бути обмежена максимум 10 сторінкованих запитів на хвилину для кожного обсягу токена.

Використовуйте бездоганну обробку та дедуплікацію під час отримання записів, у тому числі у відповідях з сторінками або повторних вікон узгодження. Використовуйте reportIdяк первинний ключ і reportTimeдля визначення останнього обробленого запису.

Наприклад, якщо початковий запит 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

тоді заголовок посилання у відповіді:

<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"

Для нумерації сторінок використовується тільки заголовок «Поси rel="next"лання». Якщо відповідь містить rel="next"посилання, використовуйте цю URL-адресу для отримання наступної сторінки записів. Якщо відповідь не містить rel="next"посилання, ви отримали всі доступні записи за вибраний часовий діапазон.

Ви можете створювати та завантажувати звіти, доступні в Partner Hub, за допомогою API звітів партнерів. Для отримання додаткової інформації див. Звіти партнера/шаблони.

Партнери також можуть отримувати доступ і завантажувати кілька звітів безпосередньо з Partner Hub. Докладніші відо мості див. у звітах Центру партнерів.