通过本接口，可以根据条件查询来电通话记录。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| EnterpriseId |
integer |
是 |
呼叫中心 id |
7000002 |
| UniqueId |
string |
否 |
如果 uniqueId 值不为空，则以下其它参数无效，即仅查询电话唯一标识为 uniqueId 的记录信息 |
uniq_1-162046xxxx.12 |
| Status |
integer |
否 |
呼叫结果；参数说明： 1:座席接听 2:已呼叫座席，座席未接听 3:系统接听 4:系统未接听-IVR 配置错误 5:系统未接听-停机 6:系统未接听-欠费 7:系统未接听-黑名单 8:系统未接听-未注册 9:系统未接听-彩铃 11:系统未接听-呼叫超出营帐中设置的最大限制 12:系统未接听-客户呼入系统后在系统未应答前挂机 13:其他错误 14:未进入队列 15:队列中放弃 16:队列中超时溢出 17:队列中无座席溢出 18:无座席未进入队列 19:队列满未进入队列 |
1 |
| Province |
string |
否 |
客户电话归属省份；为空表示全部，如"四川"，此参数需要 URLEncode |
北京 |
| City |
string |
否 |
客户电话归属城市；为空表示全部，如"成都"，此参数需要 URLEncode |
北京 |
| TimeRangeType |
string |
否 |
查询时间开始结束范围生效类型；通话记录 startTime 和 endTime 时间范围生效类型，当 startTime 和 endTime 不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为 1 |
1 |
| StartTime |
integer |
否 |
查询开始时间；时间戳格式,精确到 s。startTime 与 endTime 不允许跨月，默认值取当前月份第一天 |
1775024775 |
| EndTime |
integer |
否 |
查询结束时间；时间戳格式,精确到 s。startTime 与 endTime 不允许跨月，默认值取当前月份最后一天 |
1775030413 |
| Start |
integer |
否 |
从第几条开始取；大于等于 0，默认 0 |
0 |
| Limit |
integer |
否 |
需要取出的数据条数；大于 0，最大不能超过 1000，默认 10 |
10 |
| UserFieldkey |
string |
否 |
用户自定义参数指定查询 key；传递该参数时必须传递 userFieldValue，仅查询一个字段，不支持模糊匹配， 构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要 URLEncode |
userFieldkey |
| UserFieldValue |
string |
否 |
用户自定义参数指定查询 value；传递该参数时必须传递 userFieldKey，仅查询一个字段，不支持模糊匹配， 构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要 URLEncode |
userFieldvalue |
| CustomerNumber |
string |
否 |
客户号码 |
17750247753 |
| Cno |
string |
否 |
座席工号,此字段支持传入多个座席工号，使用英文半角逗号隔开 |
1111 |
| Qno |
string |
否 |
队列号 参数说明：-1: 未进入队列 |
566 |
| LeaveQueueCode |
integer |
否 |
离开队列原因 参数说明： 2: 队列中放弃 , 3: 队列中超时溢出 , 4: 队列中无座席溢出 |
2 |
| JoinQueueCode |
integer |
否 |
未进入队列原因 参数说明： 4: 无座席未进入队列 , 3: 队列满未进入队列 |
3 |
| CalleeNumber |
string |
否 |
座席号码 |
41008502 |
| Hotline |
string |
否 |
热线号码 |
10003221 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
无 |
| RequestId |
string |
请求 ID。 |
F655A8D5-B967-440B-8683-DAD6FF8DE990 |
| Message |
string |
响应消息。 |
OK |
| Data |
object |
返回的数据内容。 |
|
| List |
array<object> |
来电通话记录数组 |
|
|
array<object> |
|||
| NumberTrunk |
string |
中继号码 |
89193631 |
| CustomerProvince |
string |
客户号码归属省份，如 北京 |
北京 |
| EndTime |
string |
电话结束时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| Cno |
string |
座席工号，如 2000 |
1111 |
| UserField |
object |
通话记录自定义字段，json 格式 |
{} |
| CallType |
string |
呼叫类型 呼入 |
呼入 |
| AnswerTime |
string |
系统接听时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| StatusCode |
string |
status 对应的状态码 |
3 |
| EndReason |
string |
结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆 |
1000 |
| Qno |
string |
队列号，如 1000 |
1000 |
| RecordFile |
array<object> |
通话记录录音数组，json 格式 |
|
|
object |
|||
| Monitor_type |
integer |
|
1 |
| Type |
string |
取值：record,voicemail 说明：record 是录音， voicemail 是留言 |
record |
| File |
string |
录音文件名 |
name3 |
| CustomerNumber |
string |
客户号码 国内固话或手机，区号 + 7 或 8 位的固话号码，区号与固话号码之间无'-'；或 11 位长度的手机号码。如 01041005968 或 18701051984 |
18701051984 |
| AgentName |
string |
座席名称 |
name1 |
| Hotline |
string |
热线号码 |
89193631 |
| IvrName |
string |
IVR 名称，默认自定义 |
ivrname |
| Status |
string |
外呼结果， 如人工接听 |
人工接听 |
| UniqueId |
string |
电话唯一标识 |
uniq_1-162046xxxx.12 |
| NumberTrunkAreaCode |
string |
中继号码区号 |
010 |
| CustomerCity |
string |
客户号码归属城市,北京 |
北京 |
| StartTime |
string |
电话进入系统时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| CustomerAreaCode |
string |
客户号码区号 |
010 |
| CalleeNumber |
string |
座席电话 区号 +7 或 8 位的固话号码，区号与固话号码之间无'-'；或 11 位长度的手机号码。0104100596 |
0104100596 |
| TotalDuration |
string |
总通话时长秒数，单位是 s |
133 |
| BridgeDuration |
string |
服务处理时长秒数，单位是 s |
10 |
| BridgeTime |
string |
座席接听时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| LeaveQueueCode |
integer |
离开队列原因 参数说明：-1:该字段没值, 1:呼转座席接听 , 2: 队列中放弃 , 3: 队列中超时溢出 , 4: 队列中无座席溢出 |
-1 |
| Code |
string |
状态码。 |
OK |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "无",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
"Message": "OK",
"Data": {
"List": [
{
"NumberTrunk": "89193631",
"CustomerProvince": "北京",
"EndTime": "1775024775",
"Cno": "1111",
"UserField": {},
"CallType": "呼入",
"AnswerTime": "1775024775",
"StatusCode": "3",
"EndReason": "1000",
"Qno": "1000",
"RecordFile": [
{
"Monitor_type": 1,
"Type": "record",
"File": "name3"
}
],
"CustomerNumber": "18701051984",
"AgentName": "name1",
"Hotline": "89193631",
"IvrName": "ivrname",
"Status": "人工接听",
"UniqueId": "uniq_1-162046xxxx.12",
"NumberTrunkAreaCode": "010",
"CustomerCity": "北京",
"StartTime": "1775024775",
"CustomerAreaCode": "010",
"CalleeNumber": "0104100596",
"TotalDuration": "133",
"BridgeDuration": "10",
"BridgeTime": "1775024775",
"LeaveQueueCode": -1
}
]
},
"Code": "OK"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。