查询通话记录列表

查询通话记录 (CDR) 列表。

请求 URL

GET {base_url}/{api_path}/cdr/list?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
注： 如果没有设置此参数，则默认返回第一页。
page_size 否 Integer 定义每页显示几项查询结果。

最大值：10000

注： 如果没有设置此参数，则默认每页返回 10000 项结果。
sort_by 否 String 定义排序字段。

取值范围：

  • id
  • uid
  • time
  • duration
  • ring_duration
  • talk_duration
  • disposition
  • src_trunk
  • dst_trunk
  • call_type
  • did_number
  • dod_number
  • src_addr
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 通话记录总数量。
data Array<CDR_Details> 通话记录详细信息。
CDR_Details
表 3.
参数 类型 说明
id Integer 通话记录的序号。
time String 接听或拨打该通通话的时间。
call_from String 主叫的号码和名称。
call_to String 被叫的号码和名称。
timestamp Integer 通话记录时间的时间戳。
uid String 通话记录 (CDR) 的唯一 ID。
src_addr String 主叫 IP 地址。
src_trunk String 来电从哪条中继呼入。
dst_trunk String 去电从哪条中继送出。
duration Integer 拨号开始到通话结束的时间。
ring_duration Integer 拨号开始到通话被应答的时间。
talk_duration Integer 通话被应答到通话结束的时间。
disposition String 通话状态。
  • ANSWERED：已接
  • NO ANSWER：未接
  • BUSY：忙
  • FAILED：失败
  • VOICEMAIL：语音留言
call_type String 通讯类型。
  • Inbound：呼入
  • Outbound：呼出
  • Internal：内部
did_number String 主叫拨打的号码。
dod_number String 被叫话机上显示的号码。
record_file String 通话录音文件名。
reason String 通话结束的原因。

示例

请求示例

GET /openapi/v1.0/cdr/list?access_token=64er0dvpIUiXhZEetXfvqaEj4XIY2rLj&sort_by=id&order_by=desc HTTP/1.1  

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 2579,
    "data": [
        {
            "id": 2714,
            "time": "06/14/2022 11:19:28",
            "call_from": "Kristin Hale<2005>",
            "call_to": "Anna Simmons<2008>",
            "timestamp": 1655176768,
            "uid": "20220614111928CC54A",
            "src_addr": "192.168.28.25",
            "duration": 48,
            "ring_duration": 2,
            "talk_duration": 46,
            "disposition": "ANSWERED",
            "call_type": "Internal",
            "record_file": "20220614111933-1655176768.0-2005-2008-Internal.wav",
            "reason": "src hangup    "
        },
        {
            "id": 2713,
            "time": "05/30/2022 14:57:00",
            "call_from": "PlayFile",
            "call_to": "Kristin Hale<2005>",
            "timestamp": 1653893820,
            "uid": "20220530145700EEC37",
            "src_addr": "192.168.28.25",
            "duration": 49,
            "ring_duration": 1,
            "talk_duration": 48,
            "disposition": "ANSWERED",
            "call_type": "Internal",
            "reason": "src hangup    "
        },
        {
            "id": 2712,
            "time": "05/30/2022 14:55:49",
            "call_from": "Kristin Hale<2005>",
            "call_to": "21000",
            "timestamp": 1653893749,
            "uid": "202205301455494E686",
            "src_addr": "192.168.28.25",
            "dst_trunk": "peer-to-41",
            "duration": 54,
            "ring_duration": 2,
            "talk_duration": 52,
            "disposition": "ANSWERED",
            "call_type": "Outbound",
            "dod_number": "2005",
            "record_file": "20220530145555-1653893749.6-2005-21000-Outbound.wav",
            "reason": "dst hangup    "
        },
        {
            "id": 2711,
            "time": "05/30/2022 14:55:00",
            "call_from": "Kristin Hale<2005>",
            "call_to": "21000",
            "timestamp": 1653893700,
            "uid": "2022053014550020730",
            "src_addr": "192.168.28.25",
            "dst_trunk": "peer-to-34",
            "disposition": "NO ANSWER",
            "call_type": "Outbound",
            "dod_number": "2005",
            "reason": "dst extension_busy_no_forward    "
        },
       ... ...
    ]
}