搜索特定通话记录
在 CDR 列表中搜索特定的通话记录。
请求 URL
GET {base_url}/{api_path}/cdr/search?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
start_time | 否 | String | 设置开始时间以筛选通话记录。 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
end_time | 否 | String | 设置结束时间以筛选通话记录。 注: 填写的时间格式取决于 PBX 的日期和时间显示格式 (在 PBX
上的 中设置)。
示例:
|
call_from | 否 | String | 主叫号码。 |
call_to | 否 | String | 被叫号码。 |
extension_group | 否 | Integer | 分机组的唯一 ID,用于查询分机组内成员的通话。 注: 可使用 获取菜单选项 接口查询分机组
ID。 |
status | 否 | String | 通话状态。 取值范围:
|
enable_fuzzy_search | 否 | Integer | 是否模糊查询号码。 取值范围:
|
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
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 通话结束的原因。
示例
请求示例
查询分机 2005 在 05/30/2022 00:00:00-05/30/2022 23:59:59 期间拨打电话的通话记录详情
(CDR)。
GET /openapi/v1.0/cdr/search?start_time=05/30/2022 00:00:00&end_time=05/30/2022 23:59:59&access_token=s4f8lGJgh28PuXt8KNsoPJCDcfjt21Uj&call_from=2005 HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 3,
"data": [
{
"id": 2710,
"time": "05/30/2022 14:53:41",
"call_from": "Kristin Hale<2005>",
"call_to": "1000",
"timestamp": 1653893621,
"uid": "202205301453416CEAB",
"src_addr": "192.168.28.25",
"dst_trunk": "peer-to-34",
"duration": 7,
"talk_duration": 7,
"disposition": "ANSWERED",
"call_type": "Outbound",
"dod_number": "2005",
"reason": "src 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 "
},
{
"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": "to28.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 "
}
]
}