通过本接口,可以查询预测式外呼通话记录信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| EnterpriseId |
integer |
是 |
呼叫中心 id |
7000002 |
| TaskId |
integer |
否 |
外呼任务 id |
31111 |
| TaskFileId |
integer |
否 |
批次 id |
133 |
| UniqueId |
string |
否 |
如果 uniqueId 值不为空,则以下其它参数无效,即仅查询电话唯一标识为 uniqueId 的记录信息 |
uniq_1-162046xxxx.12 |
| RequestUniqueId |
string |
否 |
查询请求唯一 id 对应的记录信息,默认查询当前月,如 requestUniqueId 不属于当前月,查询时请传递查询参数 查询开始时间(startTime) |
req-uniq_1-162046xxxx.12 |
| CustomerNumber |
string |
否 |
客户电话;客户号码,如:18012345678 |
18012345678 |
| Cno |
string |
否 |
座席工号,3-10 位数字 |
1111 |
| Gno |
string |
否 |
座席所属外呼组 单个外呼组号 2-20 位,支持一个或多个座席工号查询,多个座席工号以英文逗号隔开,一次最多支持 10 个。不支持模糊匹配。 |
WH13 |
| Clid |
string |
否 |
外显号码;外显的号码 |
02138276106 |
| DisplayNumber |
string |
否 |
客户侧真实外显号码,当使用 AXB 场景进行外呼时,客户侧的真实外显号码为虚拟号 |
02138276106 |
| DownGrade |
integer |
否 |
是否呼叫降级;0-否, 1-是 |
0 |
| Status |
integer |
否 |
呼叫结果;参数说明:40:预测外呼, 客户未接听; 41:预测外呼, 客户接听; 42: 预测外呼,已呼叫; 43: 预测外呼, 双方接听 |
41 |
| Province |
string |
否 |
客户电话归属省份;为空表示全部,如"四川",此参数需要 URLEncode |
北京 |
| City |
string |
否 |
客户电话归属城市;为空表示全部,如"成都",此参数需要 URLEncode |
北京 |
| AgentName |
string |
否 |
座席姓名 |
张三 |
| TimeRangeType |
string |
否 |
查询时间开始结束范围生效类型;通话记录 startTime 和 endTime 时间范围生效类型,当 startTime 和 endTime 不为空时生效;取值:1.呼叫开始时间 2.呼叫结束时间; 默认为 1 |
1 |
| StartTime |
integer |
否 |
查询开始时间;时间戳格式,精确到 s。startTime 与 endTime 不允许跨月,默认值取当前月份第一天 |
1775024775 |
| EndTime |
integer |
否 |
查询结束时间;时间戳格式,精确到 s。startTime 与 endTime 不允许跨月,默认值取当前月份最后一天 |
1775024775 |
| 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 |
| IsRealAnswer |
integer |
否 |
真人接听;取值说明:1-是、0-否 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
已失效参数,请忽略 |
无 |
| RequestId |
string |
请求 ID。 |
7BF47617-7851-48F7-A3A1-2021342A78E2 |
| Message |
string |
消息。 |
OK |
| Data |
object |
返回结果详情。 |
|
| List |
array<object> |
预测式外呼通话记录数组 |
|
|
array<object> |
|||
| RealAnswerTime |
string |
真人接听时间,时间戳,精确到 s,如 1480904471 |
1774904471 |
| NumberTrunk |
string |
中继号码 |
15322355 |
| CustomerProvince |
string |
客户号码归属省份,如 北京 |
北京 |
| TaskId |
string |
任务 id |
1234 |
| DisplayNumber |
string |
客户侧真实外显号码,当使用 AXB 场景进行外呼时,客户侧的真实外显号码为虚拟号 |
1775024 |
| EndTime |
string |
电话结束时间,时间戳,精确到 s,如 1480904471 |
1775024775 |
| Clid |
string |
外显号码 |
02138276106 |
| Cno |
string |
座席工号,如 2000 |
1111 |
| TrunkGroupKey |
string |
中继群组代号 |
30019 |
| UserField |
object |
通话记录自定义字段,json 格式 |
{} |
| CalleeDisplayNumber |
string |
第二侧真实外显号码 |
02138276106 |
| DetailRingingTime |
string |
话机后话机响铃时间,时间戳,精确到 s;无或未转接时可能为 0;如 1480904471 |
1775024775 |
| CallType |
string |
呼叫类型 |
预测外呼 |
| Gno |
string |
外呼组号:座席所属外呼组编号,如 2000 |
2000 |
| AnswerTime |
string |
系统接听时间,时间戳,精确到 s,如 1480904471 |
1775024775 |
| StatusCode |
string |
外呼结果状态码:40 客户未接听;41 客户接听;42 已呼叫;43 双方接听;详见接口文档请求参数中 status 说明 |
41 |
| RequestUniqueId |
string |
用户自定义通话标识字段 |
543252344 |
| CalleeClid |
string |
第二侧外显号码 |
15553333 |
| WaitDuration |
string |
客户等待时长秒数,单位是 s |
10 |
| EndReason |
string |
结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆 |
1000 |
| Qno |
string |
队列号,如 1000 |
1000 |
| VadOut |
string |
通话质量百分比,0–100,in/out 方向说话占用百分比 |
77 |
| 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-7538 |
18701051984 |
| VadIn |
string |
通话质量百分比,0–100,in/out 方向说话占用百分比 |
23 |
| CalleeRingingTime |
string |
客户响铃时间,时间戳,精确到 s,如 1480904471 |
1775024775 |
| AgentName |
string |
座席姓名, 如'张三 1010' |
张三1010 |
| DownGrade |
string |
是否呼叫降级, 0-否, 1-是 |
0 |
| IvrName |
string |
IVR 名称,默认自定义 |
IvrName |
| Status |
string |
外呼结果, 如客户接听 |
客户接听 |
| UniqueId |
string |
电话唯一标识 |
uniq_1-162046xxxx.12 |
| SipCause |
string |
号码状态识别编码,详见 |
200 |
| XNumber |
string |
虚拟号 |
6677333 |
| CustomerCity |
string |
客户号码归属城市,北京 |
北京 |
| CallId |
string |
通话唯一标识 |
3cdf8d08-0216-42df-bba5-0fd45c93c9b3 |
| StartTime |
string |
电话进入系统时间,时间戳,精确到 s,如 1480904471 |
1774822300 |
| SipCauseStr |
string |
呼叫结果 |
处理成功 |
| TaskFileId |
string |
任务文件 id |
111 |
| IsRealAnswer |
string |
是否真人接听:1 - 是、0 - 否、空值 |
1 |
| DownGradeCounts |
string |
降级次数 |
0 |
| CalleeNumber |
string |
座席电话 区号 +7 或 8 位的固话号码,区号与固话号码之间无'-';或 11 位长度的手机号码。0104100596 |
0104100596 |
| TotalDuration |
string |
总通话时长秒数,单位是 s |
55 |
| TaskName |
string |
任务名称 |
name2 |
| BridgeDuration |
string |
服务处理时长秒数,单位是 s |
50 |
| Id |
string |
通话记录主键标识; |
123546546 |
| BridgeTime |
string |
座席接听时间,时间戳,精确到 s,如 1480904471 |
1774822305 |
| Code |
string |
状态码。 |
OK |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "无",
"RequestId": "7BF47617-7851-48F7-A3A1-2021342A78E2",
"Message": "OK",
"Data": {
"List": [
{
"RealAnswerTime": "1774904471",
"NumberTrunk": "15322355",
"CustomerProvince": "北京",
"TaskId": "1234",
"DisplayNumber": "1775024",
"EndTime": "1775024775",
"Clid": "02138276106",
"Cno": "1111",
"TrunkGroupKey": "30019",
"UserField": {},
"CalleeDisplayNumber": "02138276106",
"DetailRingingTime": "1775024775",
"CallType": "预测外呼",
"Gno": "2000",
"AnswerTime": "1775024775",
"StatusCode": "41",
"RequestUniqueId": "543252344",
"CalleeClid": "15553333",
"WaitDuration": "10",
"EndReason": "1000",
"Qno": "1000\n\n",
"VadOut": "77",
"RecordFile": [
{
"Monitor_type": 1,
"Type": "record",
"File": "name3"
}
],
"CustomerNumber": "18701051984",
"VadIn": "23",
"CalleeRingingTime": "1775024775",
"AgentName": "张三1010",
"DownGrade": "0",
"IvrName": "IvrName",
"Status": "客户接听",
"UniqueId": "uniq_1-162046xxxx.12",
"SipCause": "200",
"XNumber": "6677333",
"CustomerCity": "北京",
"CallId": "3cdf8d08-0216-42df-bba5-0fd45c93c9b3",
"StartTime": "1774822300",
"SipCauseStr": "处理成功",
"TaskFileId": "111",
"IsRealAnswer": "1",
"DownGradeCounts": "0",
"CalleeNumber": "0104100596",
"TotalDuration": "55",
"TaskName": "name2",
"BridgeDuration": "50",
"Id": "123546546",
"BridgeTime": "1774822305"
}
]
},
"Code": "OK"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。