詳細な通話レコード Webhook を使用すると、課金からカスタムレポートまで、さまざまな目的で顧客の Webex Calling アクティビティを可視化できます。この Webhook を使用して、各顧客のレコードを 1 つずつクエリする必要なく、すべての顧客のレコードを簡単に収集できます。このWebhookを使用すると、内部ビジネス目的または付加価値サービスの顧客への提供の両方のために、カスタムレポートおよび分析アプリケーションを開発できます。Webhookとそれに付随するAPIの紹介については、このvidcastをご覧ください。

Webhook は 5 分ごとにレコードを配信します。各 Webhook ペイロードには、10 ～ 5 分前に終了した通話のレコードが含まれます。たとえば、17:00 に受信したペイロードには、16:50 ～ 16:55 の間に終了したコールが含まれます。16:55 ～ 17:00 の間に終了する通話は、17:05 ペイロードになります。

Webex Calling レコードは、既存の詳細通話レコード API と同じフォーマットで配信されます。Webhook を設定し、次の 2 種類のフィードから選択できます。

• アナリティクス—パートナーが Webex Calling と関係を持つすべての顧客組織のすべての通話レコードが含まれます。これには、以下の組織が含まれます。
  • パートナーは、パートナーのフル管理者ロールで顧客組織を管理します。
  • 顧客組織には、パートナー組織内でアクティブな Webex Calling サブスクリプションがあります。
• 請求: パートナーが販売した Webex Calling ライセンスを持つユーザーが行った通話の通話記録のみが含まれます。ワークスペースの通話レコードは、このフィードに含まれます。

Webhook とともに 2 つの API エンドポイントを提供し、データの照合を支援します。これらのエンドポイントにより、Webhook リスナーによって受信されない欠落したレコードとデータストアを「追跡」したり、照合したりできます。これらの 2 つの API は Reconciliation API エンドポイン ト と Records API エンドポイント です。

レコードはこれらの API から 48 時間利用できます。すべてのレコードが期待通りに受信できるように、12 時間または 24 時間ごとに定期的にレコードストアを照合することを推奨します。この API を使用するには、パートナー アクセス トークンが必要です。パートナーアクセストークンを取得し、標準の Webex 開発者アクセストークン管理原則 に従って管理できます。

照合 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 時間のみ呼び出すことができます。startTime と endTime のパラメータは 60 分以内でなければなりません。この API は 5 分から 48 時間前までの任意の 1 時間に使用できますが、サービスの負荷を管理するために、一度に 1 時間のみ呼び出すことができます。

使用可能なパラメータは次のとおりです。

• startTime (文字列): 収集する最初のレポートの時間。レポート時間は、コール完了時刻を指定します。

  時刻は YYYY-MM-DDTHH:MM:SS.mmmZ としてフォーマットする必要があります。

• endTime (文字列) — 収集する最後のレポートの時間。レポート時間は、コール完了時刻を指定します。

  指定された時間は startTime より後で、48 時間以内にする必要があります。YYYY-MM-DDTHH:MM:SS.mmmZ として時刻をフォーマットする必要があります。

以下は、Reconciliation API エンドポイント JSON のリターンペイロードがどのように見えるかの例です。

{ "cdr_counts": [ { "orgId": "zzzzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyy", "count": 3009 }、{ "orgId": "yyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyyyy", "count": 129 }, { "orgId": "xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyy", "count": 278 } ] } 

API 応答のヘッダーは、返された組織の総数と、追加のページがあるかどうかを示します。次のパラメータをチェックして、すべてのページがクエリされたことを確認します。

 num-pages = 2 total-orgs = 283 current-page = 1

上記のパラメータは、現在のページが最初のページであり、合計 2 ページあり、応答全体に 283 組織が含まれていることを示しています。次の図のように、パラメータ page=2 を GET リクエストに追加することで、2 番目のページにアクセスします。

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」で説明されている形式と同じです。返されるペイロードには、[詳細コール履歴（Detailed Call History）] 返されるペイロードと同じフィールドが含まれます。ここで返される各フィールドの値の詳細を確認できます。レコード 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

パラメータ

• orgID:レコードをクエリーする組織 ID。上記の照合エンドポイントからこれらの識別子を開くことができます。

• startTime (文字列): 収集する最初のレポートの時間。レポート時間は、コール完了時刻を指定します。

  指定した時間は 5 分前から 48 時間前までの間にする必要があります。また、時刻を YYYY-MM-DDTHH:MM:SS.mmmZ としてフォーマットする必要があります。

• endTime (文字列) — 収集する最後のレポートの時間。レポート時間は、コール完了時刻を指定します。

  指定された時間は startTime より後で、48 時間以内にする必要があります。YYYY-MM-DDTHH:MM:SS.mmmZ として時刻をフォーマットする必要があります。