在此文章中
概覽
設定 Webhook 回撥 URL
dropdown icon
合作夥伴 API 端點
    調解 API 端點
    記錄 API 端點
了解 API 端點響應代碼
合作者報告/模板 API
修訂歷史記錄
合作夥伴中心中的 Webex Calling 的詳細通話記錄網絡掛鉤
list-menu在此文章中
list-menu意見回饋?

Webex Calling 多租戶 (MT) 合作夥伴可以設置網絡掛鉤,為所有客戶收集 Webex Calling 記錄。這可實現有效率的帳單調節、分析和報告,而無需個別查詢每個客戶。

概覽

詳細通話記錄 webhook 提供了由事件而不是請求驅動的安全,可擴展和強 大的解決方案。 這個 webhook 可提供更好的客戶 Webex Calling活動的可見性,並支持從帳單到定制化報告的使用案例。

您可以使用此網路掛鉤,方便地為透過合作夥伴中心管理的所有客戶收集記錄 ,而不需要個別查詢每個客戶。 此 webhook 允許您針對內部業務需求 和增值服務開發 自定義報告,計費和分析應用程序。

如需網絡掛鉤及其隨附的 API 的簡介,請觀看此 Vidcast:合作夥伴詳細呼Webex Calling叫歷史記錄 API。

合作夥伴網絡掛鉤提供的內容

Webhook 每 5 分鐘提供詳細的通話歷史記錄。 每個 webhook 有效負載包含:

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

若要顯示通話記錄如何包含在每個有效負載中,請考慮下列範例:

  • 14:05 收到的有效負載包含在 13:55 至 14:00 之間結束的呼叫。
  • 14:10 負載包括在 14:00 至 14:05 之間結束的呼叫。
  • 先前完成的記錄(例如,在 14:04 結束的呼叫)但 由Webex Calling雲端延遲處理(例如,14:11)將包含在下一個排程的有效負載中(例如,14:15 )中。

網絡鉤可靠地傳遞記錄。 但是,當系統在某些條件下重播記錄時 ,您可能會在後續 webhook 有效負載中收到重複的記錄。 您必須 負責處理重複資料刪除記錄。 若要識別重複的記錄,請使用 ReportID 欄位作為主索引鍵,並使用 ReportTime 欄位來判斷呼叫完成或處理的時間。 使用這些欄位可以更新或 將記錄插入您的內部資料存放區。

合作夥伴中心中的網絡掛鉤

通過提供 webhook,您可以讓分析平台在產生呼叫記錄時將通話記錄發送到您的回呼 URL。

Webex Calling記錄是使用與現有的詳細通話記錄 API 相同的格式傳遞。 您可以設定網路掛鉤,並在兩種類型的摘要之間進行選擇:

  • 分析-包括合作夥伴有關係的所有客戶組織的所有通話記錄。Webex Calling 這包括下列組織:
    • 合作夥伴以合作夥伴完整管理員角色來管理客戶組織。
    • 客戶組織在合作夥伴Webex Calling組織內有有效訂閱。
  • 帳單-包括使用合作夥伴出售和佈建授權的使用者所Webex Calling進行的通話記錄。 此摘要中包含工作區的呼叫記錄。

訪問和數據隱私

只有擁有的合作夥伴可以存取通話詳細資料記錄 (CDR) 以進行帳單。

  • 管理與通話記錄相關聯的授權的合作夥伴(或子合作夥伴)會 成為擁有合作夥伴。
  • 所有權由以下方式決定:使用者 ID > 授權 ID > 訂閱 ID > 合作夥 伴 ID。
  • 單一合作夥伴都可以訪問每個 CDR。
  • 某些通話記錄不會對映至帳單合作夥伴,並非所有與組 織關聯的合作夥伴都能獲得對所有記錄的平等存取權,因為這些記錄可能包 含個人識別資訊 (PII)。

設定 Webhook 回撥 URL

在合作夥伴中心中設定網路掛鉤。 每個合作夥伴組織只能設定一個網路掛鉤 。

請確定您已在 Control Hub 中勾選具有「組織完整管理層級存取權 」的合作夥伴完整管理員角色,以及 Webex CallingCDR API 存取權(在管理 > 使用者下,選取完整的管理員或合作夥伴完整管理員,然後選取管理員角色 > 合作夥伴)。

當您使用合作夥伴調解和記錄 API 時,存取要求也適用相同。

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

登入 Partner Hub。

2

移至「組織設定」 >「通話詳細記錄」。

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

在 Webhook 下輸入要使用的 URL。

網址必須以 /webhook 結尾(例如,https://yourdomain.com/webhook)。
4

如果您想使用秘密令牌驗證您的 webhook 有效負載,則可 以添加一個。 若要尋找有關 Webex 網路掛鉤和秘密令牌的詳細資訊,請參閱適用於開發人員的 Webex:Webhook。

5

選取下列其中一種資源類型以用於 網路掛鉤:

  • 分析-包括合作夥伴有關係的所有客戶組 織的所有通話Webex Calling記錄。
  • 帳單-包括合作夥伴出 售Webex Calling授權的使用者的通話記錄。 此摘要中包含工作區的呼叫記錄。

合作夥伴 API 端點

除了網絡掛鉤之外,還Webex Calling提供 API 端點以支持數據調解。 這些端點可讓您找到或調整您的資料存放區與 webhook 監聽器可能未收到的任何遺失記錄。 兩個 API 端點是調解 API 和記錄 API。

來自這些 API 的記錄可用 30 天。 為確保您收到所有預期的記錄,我們建議定期調節您的唱片庫,例如每 12 或 24 小時一次。

您必須使用合作夥伴存取令牌才能存取這些 API。 驗證使用者必須是具有組織完整管理員層級存取權的合作夥伴完整管理員,並且必須啟用 Webex CallingCDR API 存取權。 OAuth 令牌必須包含範圍。spark-admin:calling_cdr_read 唯讀管理員角色不夠用於合作夥伴調解和記錄 API。

使用客戶組織的Webex Calling資料區域analytics-calling的端點。 為調解和記錄 API 使用適用的基礎 URL:

  • 美國和加拿大:https://analytics-calling.webexapis.com
  • 歐洲:https://analytics-calling-eu.webexapis.com
  • 印度:https://analytics-calling-in.webexapis.com
  • 澳大利亞:https://analytics-calling-au.webexapis.com

API 視窗範圍適用於兩個端點,以更好地處理服務負載。

  • 對於大於 48 小時的時間範圍,允許的視窗持續時間上限為 12 小時 (強制)。
  • 對於合作夥伴組織 ID,API 的速率僅限於每分鐘一個初始 API 請求,每個令牌範圍。 如果使用分頁,每分鐘最多允許 10 個額外分頁化 API 請求,並且可以在初始請求後立即提出這些要求。

調解 API 端點

調解 API 端點會傳回指定期間內為合作夥伴管理的每個客戶產生的呼叫記錄計數總數。 您可以使用這些總計來驗證本機儲存空間,並識別特定客戶的任何遺失或不一致的通話記錄。

存取要求:驗證使用者必須是具有完整管理員層級存取權的合作夥伴管理員,並且必須啟用 Webex CallingCDR API 存取權。 存取令牌必須包含spark-admin:calling_cdr_read範圍。

如果您管理超過 200 個客戶組織,API 會將結果分頁,以提高可讀性。

調解 API 端點 URL 使用下列格式:

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

API 參數

您可以使用 API 檢索過去 30 天的呼叫記錄。 您選擇的時間視窗必須在目前 UTC 時間前至少 5 分鐘開始,在單一 API 呼叫中的開始和結束時間之間不能超過 12 小時。

API 參數如下:

  • 開始時間(必填,字串)-您要收集的第一個記錄的開始日期和時間 (UTC)。 確保:
    • 您將時間格式化為YYYY-MM-DDTHH:MM:SS.mmmZ。 例如,2025-08-15T06:00:00.000Z。
    • 開始日期和時間不得超過當前 UTC 時間起 30 天。
    • 之間的時startTime間endTime不能超過 12 小時。
  • 結束時間(必填,字串)-您要收集的記錄的結束日期和時間 (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 端點

「記錄 API」端點用於針對使用調解 API 識別差異或遺失資料的特定組織查詢遺失呼叫記錄。

建議流程:/v1/partners/cdrcountbyorg先撥打電話。 然後在您呼叫時使用確切orgIdcdr_counts[].orgId返回的輸入值/v1/partners/cdrsbyorg。

記錄 API 會以 JSON 格式傳回呼叫記錄,與詳細呼叫歷史記錄 API 中所述的格式相同。 傳回的有效負載包含與「詳細呼叫歷史記錄」傳回的有效負載相同的欄位。 如需有關欄位及其值的詳細資訊,請參閱詳細Webex Calling呼叫歷史記錄報表。

API 提供在當前時間前 5 分鐘結束的呼叫記錄。 為確保所有呼叫記錄都可用,我們建議您在偏好的時間窗口後一小時查詢 API。

記錄 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 cdr_counts[].orgId。
  • 開始時間(必填,字串)-您要收集的第一個記錄的開始日期和時間 (UTC)。 確保:
    • 您將時間格式化為YYYY-MM-DDTHH:MM:SS.mmmZ。 例如,2025-08-15T06:00:00.000Z。
    • 開始日期和時間不得超過當前 UTC 時間起 30 天。
    • 在單一 API 請求startTime中 endTime,與之間的間隔不得超過 12 小時。
  • 結束時間(必填,字串)-您要收集最後一個記錄的結束日期和時間 (UTC)。 記錄以報告時間為基礎,即通話完成時間。 確保:
    • 您將時間格式化為YYYY-MM-DDTHH:MM:SS.mmmZ。 例如,2025-08-15T18:00:00.000Z。
    • 結束日期和時間必須在當前 UTC 時間前至少 5 分鐘,且不超過 30 天。
    • 結束日期和時間必須大於startTime。
    • 在單一 API 請求startTime中 endTime,與之間的間隔不得超過 12 小時。
  • 最大(選擇性,數量)-限制回應中每頁記錄數目上限。 確保:
    • 範圍在 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"連結,表示您已擷取所選時間範圍的所有可用記錄。

此 API 的分頁符合 RFC5988 (網頁連結) 標準。 如需詳細資訊,請參閱 REST API 基礎知識。

了解 API 端點響應代碼

本節提供使用調解 API 端點和 記錄 API 端點 時可能遇到的常見回應代碼概述。 這些端點在資料 同步、驗證和報告中扮演重要角色。 了解這些回應代碼對於有效的 故障排除以及維持可靠、穩定的整合至關重要。

表一。API 端點回應代碼

回應代碼

回應代碼說明

200

OK

400

錯誤請求:請求無效或無法以其他方式提供。 隨附的錯誤訊息將進一步解釋。

401

未經授權:身份驗證憑證遺失或不正確。

403

禁止:請求已被理解,但已被拒絕或不允許訪問。

404

找不到:請求的 URI 無效,或請求的資源(例如使用者)不存在。 當請求的方法不支持請求的格式時也返回。

405

不允許的方法:使用不支援的 HTTP 請求方法向資源提出請求。

409

衝突:無法處理請求,因為它與系統的某些已建立規則衝突。 例如,一個人不可以多次加入房間。

410

消失:請求的資源不再可用。

415

不支援的媒體類型:請求是針對資源而未指定媒體類型,或使用不支援的媒體類型。

423

已鎖定:請求的資源暫時無法使用。 可能會出現 Retry-After 標頭,指定您需要等待多少秒,然後再次嘗試請求。

428

必要條件:檔案無法掃描惡意軟體,且需要強制下載。

429

請求太多:在指定的時間內傳送過多的請求,並且要求的費率受到限制。 應該出現 Retry-After 標頭,指定您需要等待多少秒才能成功提出請求。

451

依預設,要求會路analytics-calling.webexapis.com由至最接近的區域伺服器。 如果這些伺服器託管組織的資料,API 會傳回資料。 否則,API 會傳回 HTTP 451,而回應本體會識別您可以在其中擷取組織資料的端點。

500

內部伺服器錯誤:伺服器出現問題。 如果問題仍然存在,請隨時聯繫 [Webex 開發人員支持團隊](/探索/支持)。

502

錯誤閘道:伺服器在處理請求時從上游伺服器收到無效的回應。 稍後再試一次。

503

服務無法使用:伺服器超載了要求。 稍後再試一次。

504

閘道逾時:上游伺服器無法按時回應。 如果您的查詢使用 max 參數,請嘗試減少它。

修訂歷史記錄

文件修訂歷史記錄

修訂日期

我們對文章進行了以下更改

13/08/26

  • 調解 API 端點角色需求:驗證使用者必須是具有完整管理員層級存取權的合作夥伴管理員。 此外,必Webex Calling須啟用 CDR API 存取權。

  • 了解 API 端點響應代碼已更新,包括 451 錯誤代碼。

  • 新增客戶組織Webex Calling資料區域的區域端點。

2/04/2026

  • 建立一個修訂歷史記錄表,可追蹤一段時間內所做的所有變更。

  • 更新了調解 API 端點和記錄 API 端點區段,以包括表格或錯誤代碼值。

本文是否有幫助?
本文是否有幫助?