SparkTG

CDR レポート (v2)ドキュメント

CDR レポート (v2)

v2

CDR レポート (v2)

指定期間の通話詳細レコード

API v2v21件のエンドポイント

概要

課金対象: この API は返されたレコード数に応じて課金されます。料金の詳細はアカウントマネージャーにお問い合わせください。サービスと期間に該当する通話詳細レコードを返します。JSON ボディ (Content-Type: application/json) を送信してください。start_time と end_time は、すべての reports エンドポイントと同様に必須で、指定がない場合は 400 を返します。svc_id は任意で、デフォルトはトークンのサービスです。指定する場合、トークンのユーザーがそのサービスに対する権限を持っている必要があり、持っていない場合は 403 を返します。mode フィールドでは normal (デフォルト。合計付きの標準的な CDR 一覧) または extended (同じレコードに IVR とキューの時間、待機時間を加えたもの) を選択します。リクエストボディはどちらのモードでも同一です。limit の上限は 5000 で、それを超える値を指定すると 5000 に引き下げられるため、大きな結果セットは offset でページングしてください。未知のパラメータは無視されます。

利用可能なエンドポイント

POST/api/v2/reports/cdr

主なパラメーター

mode(String)

normal (デフォルト) または extended。

svc_id(Integer)

レポート対象のサービス。デフォルトはトークンのサービス。

start_time(Integer (epoch ms))

期間の開始。

end_time(Integer (epoch ms))

期間の終了 (通話の開始時刻に対しては含まない)。

offset(Integer)

ページネーションのオフセット (両モード共通)。デフォルトは 0。

limit(Integer)

ページサイズ。デフォルトは 30。最大 5000。それより大きい値は 5000 に制限されます。

利用シナリオ

normal モード

デフォルト。ring_start_time、start_time、end_time は IST の yyyy-MM-ddTHH:mm:ss 形式の文字列で返されます。

0件のパラメーターサンプルに掲載

extended モード

mode を extended に設定します。エンベロープと normal モードのすべてのフィールドは変わらず、各レコードに agent_answered、ivr_in_time、ivr_out_time、ivr_duration、queue_in_time、queue_out_time、queue_duration、total_wait_duration も含まれます。

0件のパラメーターサンプルに掲載

簡単なサンプル

簡単なcURLコマンドでこのAPIを試す

基本的なAPI呼び出し
curl -X POST 'https://telephonycloud.co.in/api/v2/reports/cdr' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"svc_id": 3, "start_time": 1775759400000, "end_time": 1776364200000, "offset": 0, "limit": 30, "call_type": "OUTBOUND", "disposition": "ANSWER"}'
💡 <YOUR_TOKEN> をお使いの API トークンに置き換えてください

レスポンスのプレビュー

このAPIのサンプルレスポンス

サンプルレスポンス
{"count":268,"data":[{"call_transaction_id":"d341e47a-767a-44fb-8d79-9bf38f4caa28","svc_id":3,"call_type":"OUTBOUND","customer_number":"9634780846","agent_number":"10101","disposition":"Answer","durat...
レスポンス全体の形式はレスポンスセクションをご覧ください