詳細通話記錄 webhook 提供了一個安全、可擴展且強大的解決方案，該方案由事件驅動，而不是由請求驅動。此網路鉤子可讓您更清楚地了解客戶的 Webex Calling 活動，支援從計費到客製化報告的各種用例。

您可以使用此 webhook 方便地收集透過 Partner Hub 管理的所有客戶的記錄，而無需單獨查詢每個客戶。此網路鉤子可讓您為內部業務需求和增值服務開發自訂報告、計費和分析應用程式。

如欲了解 webhook 及其相關 API 的介紹，請觀看此 影片：Webex Calling Partner 詳細通話記錄 API。

合作夥伴 Webhook 提供的功能

這個網路鉤子每 5 分鐘提供一次詳細的通話記錄。每個 webhook 有效負載包含：

• 通話記錄顯示，通話結束時間在目前時間前 5 分鐘至 10 分鐘之間。
• Webex Calling 雲端處理的任何延遲記錄。
• 自動將延遲的通話記錄填入後續的 webhook 有效負載中，以確保可靠交付。

為了展示通話記錄是如何包含在每個有效載荷中的，請參考以下範例：

• 接收到的有效載荷 14:05 包含在以下時段結束的通話： 13:55 和 14:00.
• 通話結束於 14:00 和 14:05 包含在內 14:10 有效載荷。
• 先前完成的記錄（例如，結束於 14:04) 但 Webex Calling 雲端平台處理延遲（例如，在 14:11) 包含在下一個計劃的有效載荷中（例如， 14:15).

合作夥伴中心的 Webhook

透過提供 webhook，您可以讓分析平台能夠在產生通話記錄時將其傳送到您的回呼 URL。

Webex 通話記錄採用與現有 詳細通話記錄 API相同的格式提供。您可以設定一個 webhook，並在兩種類型的資訊流之間進行選擇：

• 分析－包括合作夥伴與其建立 Webex Calling 關係的所有客戶組織的全部通話記錄。這包括以下類型的組織：
  • 合作夥伴以合作夥伴完全管理員角色管理客戶組織。
  • 客戶組織在合作夥伴組織內擁有有效的 Webex Calling 訂閱。
• 計費—包括使用合作夥伴銷售和提供的 Webex Calling 授權的使用者撥打的電話的通話記錄。此資訊流中包含工作區的通話記錄。

存取和資料隱私

只有擁有該設備的合作夥伴才能存取通話詳細記錄 (CDR) 以進行計費。

• 管理與通話記錄相關的許可證的合夥人（或子合夥人）成為所有權合夥人。
• 所有權由以下因素決定：使用者身分 > 許可證 ID > 訂閱 ID > 合作夥伴 ID。
• 每個 CDR 僅供單一合作夥伴存取。
• 有些通話記錄無法與計費合作夥伴關聯，而且與組織關聯的合作夥伴並非都能平等地存取所有記錄，因為這些記錄可能包含個人識別資訊 (PII)。

除了 webhook 之外，Webex Calling 還提供 API 端點以支援資料協調。這些端點可讓您將資料儲存與 webhook 監聽器可能未收到的任何缺失記錄進行核對或調整。這兩個 API 端點分別是 協調 API 和 記錄 API。

這些 API 的記錄可保留 30 天。為確保您收到所有預期記錄，我們建議您定期核對您的記錄存儲，例如每 12 或 24 小時核對一次。

您必須使用合作夥伴存取權杖才能存取這些 API。根據標準的 Webex Developer 存取權杖管理實務取得和管理您的合作夥伴存取權杖。

對帳 API 端點

對帳 API 端點傳回由合作夥伴在指定時間內管理的每個客戶所產生的呼叫記錄總數。您可以利用這些總數來驗證本地存儲，並識別特定客戶的任何缺失或不一致的通話記錄。

如果您管理超過 200 個客戶組織，API 將對結果進行分頁顯示，以提高可讀性。

對帳 API 端點 URL 使用以下格式：

API 參數

您可以使用 API 擷取最近 30 天的通話記錄。您選擇的時間視窗必須至少在目前 UTC 時間前 5 分鐘開始，並且在單次 API 呼叫中，開始時間和結束時間之間的時長不能超過 12 小時。

API參數如下：

• startTime (必需，字串)—要收集的第一筆記錄的開始日期和時間（UTC）。確保：
  • 時間格式為 YYYY-MM-DDTHH:MM:SS.mmmZ。例如， 2025-08-15T06:00:00.000Z。
  • 開始日期和時間不得早於目前 UTC 時間 30 天。
  • startTime 和 endTime 之間的時間窗口不能超過 12 小時。
• endTime (必需，字串)—要收集的記錄的結束日期和時間（UTC）。記錄以報告時間為準，即通話結束的時間。確保：
  • 時間格式為 YYYY-MM-DDTHH:MM:SS.mmmZ。例如， 2025-08-15T18:00:00.000Z。
  • 結束日期和時間必須比目前 UTC 時間早 5 分鐘，且不得早於 30 天。
  • 結束日期和時間必須大於 startTime。
  • startTime 和 endTime 之間的時間窗口不能超過 12 小時。

對帳 API 端點 JSON 回應範例：

          {
          "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 回應標頭指示傳回的組織總數以及是否有其他頁面可用。請檢查以下標頭參數，確保已查詢所有頁面：

• 頁數：總頁數（例如，2）
• 組織總數：參與調查的機構總數（例如，283 個）
• 當前頁碼：當前頁碼（例如，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 端點

Records API 端點用於查詢特定組織中缺少的呼叫記錄，這些組織在使用 Reconciliation API 識別出差異或缺失資料。

Records API 以 JSON 格式傳回通話記錄，與 詳細通話記錄 API中所述的格式相同。傳回的有效載荷包含與詳細通話記錄返回的有效載荷相同的欄位。有關欄位及其值的更多信息，請參閱 Webex Calling 詳細通話歷史記錄報告。

API 提供目前時間前 5 分鐘結束的通話記錄。為確保所有通話記錄均可獲取，我們建議您在首選時間窗口後一小時查詢 API。

Records API 端點 URL 使用以下格式：

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 （必需，字串）—要檢索記錄的組織 ID。您可以從對帳 API 取得組織 ID。
• startTime (必需，字串)—要收集的第一筆記錄的開始日期和時間（UTC）。確保：
  • 時間格式為 YYYY-MM-DDTHH:MM:SS.mmmZ。例如， 2025-08-15T06:00:00.000Z。
  • 開始日期和時間不得早於目前 UTC 時間 30 天。
  • 在單一 API 請求中，方括號 startTime 和 endTime 方括號 之間的間隔不得超過 12 小時。
• endTime (必需，字串)—要收集的最後一筆記錄的結束日期和時間（UTC）。記錄以報告時間為準，即通話結束的時間。確保：
  • 時間格式為 YYYY-MM-DDTHH:MM:SS.mmmZ。例如， 2025-08-15T18:00:00.000Z。
  • 結束日期和時間必須至少比目前 UTC 時間早 5 分鐘，且不得早於 30 天。
  • 結束日期和時間必須大於 startTime。
  • 在單一 API 請求中，方括號 startTime 和 endTime 方括號 之間的間隔不得超過 12 小時。
• Max （可選，數字）—限制回應中每頁的最大記錄數。確保：
  • 範圍從 500 到 5000。預設值為 5000。例如， Max=1000。
  • 如果 API 傳回的記錄數超過指定的最大值，則回應將分頁顯示。
  • 如果指定的值小於 500，則會自動調整到 500。如果指定的值大於 5000，則將其向下調整至 5000。

分頁

若要確定 API 回應是否分頁，請檢查回應標頭中的 Link 標頭。如果 Link 標頭中存在 next 鏈接，則提取該鏈接並使用 startTimeForNextFetch 值請求下一組記錄。如果沒有下一個鏈接，則會收集所選時間範圍內的所有報告。

可以立即發出後續頁面的 API 請求，但必須限制速率，每個令牌範圍每分鐘最多只能發出 10 個分頁請求。

例如，如果初始 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

那麼響應中的 Link 標頭就是：

; rel="next"

其他可能的連結值包括 rel="first" 和 rel="prev" ，分別表示第一頁和上一頁。

夥伴 reports/templates API

您可以使用 合作夥伴報告 API產生和下載合作夥伴中心中提供的報告。更多信息，請參閱 合作夥伴 report/templates。

合作夥伴還可以直接從合作夥伴中心存取和下載多份報告。有關更多信息，請參閱 合作夥伴中心報告。