概觀

「詳細通話記錄」Webhook 可讓您出於各種目的(從計費到自訂報告)更好地了解客戶的Webex Calling活動。您可以使用此 Webhook 為所有客戶方便地收集記錄,而不必一一查詢每個客戶的記錄。此 Webhook 可讓您開發自訂報告和分析應用程式,以用於內部業務目的或向客戶提供增值服務。如需 Webhook 及其隨附 API 的介紹,您可以觀看此視訊廣播。

Webhook 會每隔 5 分鐘傳送一次記錄。每個 Webhook 有效荷載都包含在 10 到 5 分鐘之間結束的通話的記錄。例如,在 17:00 收到的有效荷載包括在 16:50 到 16:55 之間結束的通話。在 16:55 到 17:00 之間結束的通話將包含在 17:05 的有效荷載中。

Webex Calling記錄的傳遞格式與現有的詳細通話記錄 API 。您可以"安裝;設定"Webhook 並在兩種類型的摘要之間選擇:

  • 分析- 包括與合作夥伴具有Webex Calling關係的所有客戶組織的所有通話記錄。這包括以下組織:
    • 合作夥伴以「合作夥伴完全管理員」角色管理客戶組織。
    • 客戶組織在合作夥伴組織中有使用中的Webex Calling訂閱。
  • 帳單- 僅包括使用合作夥伴銷售的Webex Calling授權的使用者所撥打電話的通話記錄。此摘要中包含工作區的通話記錄。

設定 Webhook 回撥 URL

在 Partner Hub 中設定 Webhook。每個合作夥伴組織只能"安裝;設定"一個 Webhook。您必須是完全管理員才能"安裝;設定"Webhook。

1

登入 Partner Hub

2

轉至組織設定 > 通話詳細記錄

3

輸入要在下使用的URL Webhook 。

4

如果您想要使用機密權杖驗證 Webhook 有效荷載,您可以新增一個權杖。您可以找到有關Webex Webhook 和密碼權杖的更多資訊在這裡。

5

選取以下選項之一資源類 型若要用於 Webhook:

  • 分析- 包括與合作夥伴具有Webex Calling關係的所有客戶組織的所有通話記錄。
  • 帳單- 僅包括合作夥伴將Webex Calling授權出售給的通話記錄。此摘要包括工作區的通話記錄。
Partner Hub 中的通話詳細記錄 Webhook 設定

API端點

我們提供了兩個API端點以及 Webhook 來協助進行資料核對。這些端點可讓您「趕上」或協調您的資料儲存區,其中缺少 Webhook 偵聽器未接收到的記錄。這兩個 API 是協調API端和記錄API端點。

可從這些 API 使用記錄 48 小時。我們建議您定期(譬如每隔 12 或 24 小時)核對記錄儲存區,以便按預期收到所有記錄。使用此API需要合作夥伴存取權杖。您可以獲得合作夥伴存取權杖並根據標准進行管理Webex Developer 存取權杖管理原則。

協調API端點

協調API端點會傳回由合作夥伴在指定時期管理的每個客戶產生的記錄數。如果合作夥伴管理 200 多個客戶組織,則來自API的結果將被分頁以提高可讀性。如果缺少特定客戶的任何記錄,您可以使用這些總計來核對本機儲存體。您可以在這裡找到協調API端點URL :

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

參數

最多只能調用協調API 1 小時的持續時間,其中開始時間結束時間 參數間隔不超過 60 分鐘。API可用於 5 分鐘到 48 小時前之間的任何 1 小時時段,但若要管理服務負載,一次只能調用 1 小時。

可用的參數為:

  • 開始時間(字串)- 您要收集的第一個報告的時間。報告時間會指定通話完成時間。

    您必須將時間的格式設定為YYYY-MM-DDTHH:MM:SS.mmmZ

  • 結束時間(字串)- 您最後一次收集報告的時間。報告時間會指定通話完成時間。

    指定的時間應該晚於開始時間 但不遲於 48 小時,並且您必須將時間格式設定為YYYY-MM-DDTHH:MM:SS.mmmZ

以下是核對API端點 JSON 傳回有效荷載的範例:

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

API回應的標頭會指出返回的組織總數以及是否有額外的頁面。檢查以下參數以確保已查詢所有頁面。

 頁數 = 2 組織總數 = 283 當前頁 = 1

上述參數顯示目前頁面是第一頁,總共有 2 個頁面,且整個回應包含 283 個組織。透過新增參數來存取第二個頁面第 2 頁GET 請求,如下所示。

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

記錄API端點

此API端點以 JSON 格式傳回通話記錄,該格式與第詳細通話記錄API 。返回的有效荷載包含與「詳細通話歷史記錄」返回的有效荷載相同的欄位。您可以找到關於返回的每個欄位中的值的更多詳細資料在這裡。API記錄端點用於查詢缺少記錄的組織的缺少記錄。您可以在這裡找到記錄API端點URL :

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

參數

  • 組織 ID - 您要查詢記錄的組織ID 。您可以從上述協調端點開啟這些標識符。

  • 開始時間(字串)- 您要收集的第一個報告的時間。報告時間會指定通話完成時間。

    指定的時間必須介於 5 分鐘前到 48 小時前之間,且您必須將時間的格式設定為YYYY-MM-DDTHH:MM:SS.mmmZ

  • 結束時間(字串)- 您最後一次收集報告的時間。報告時間會指定通話完成時間。

    指定的時間應該晚於開始時間 但不遲於 48 小時,並且您必須將時間格式設定為YYYY-MM-DDTHH:MM:SS.mmmZ