根据条件查询座席外呼通话记录。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| EnterpriseId |
integer |
是 |
呼叫中心 id |
7000002 |
| UniqueId |
string |
否 |
如果 uniqueId 值不为空，则以下其它参数无效，即仅查询电话唯一标识为 uniqueId 的记录信息 |
uniq_1-162046xxxx.12 |
| RequestUniqueId |
string |
否 |
查询请求唯一 id 对应的记录信息，默认查询当前月，如 requestUniqueId 不属于当前月，查询时请传递查询参数 查询开始时间(startTime) |
req_uniq_1-162046xxxx.12 |
| CallType |
integer |
否 |
呼叫类型；为空表示全部，可选值为：4:预览外呼 6:主叫外呼 9:内部呼叫 |
4 |
| Status |
integer |
否 |
呼叫结果；参数说明：30 座席未接听; 31 座席接听,未呼叫客户; 32 座席接听,客户未接听; 33 双方接听; 50 主叫外呼接听; 51 主叫外呼,客户未接听; 52 主叫外呼,双方接听。 |
33 |
| 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"} |
| UserFieldValue |
string |
否 |
用户自定义参数指定查询 value；传递该参数时必须传递 userFieldKey，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要 URLEncode |
{"userFieldkey":"userFieldvalue"} |
| CustomerNumber |
string |
否 |
客户号码，支持一个或多个客户号码查询，多个客户号码以英文逗号隔开，一次最多支持 100 个。不支持模糊匹配。 |
13322223333 |
| Cno |
string |
否 |
座席工号，单个座席工号 3-10 位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持 100 个。不支持模糊匹配。 |
1111 |
| Gno |
string |
否 |
座席所属外呼组 单个外呼组号 2-20 位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持 10 个。不支持模糊匹配。 |
455 |
| AgentNumber |
string |
否 |
座席号码 |
41008502 |
| AgentName |
string |
否 |
座席姓名 |
name3 |
| Clid |
string |
否 |
客户侧外显号码过滤条件 |
4100 |
| LeftDisplayNumber |
string |
否 |
客户侧真实外显号码过滤条件，当使用虚拟号进行 AXB 外呼且开关打开时，实际过滤的客户侧真实外显号码是虚拟号 |
2000 |
| Order |
integer |
否 |
排序方式；取值说明：0: 按照记录产生的时序顺序排序，1：按照记录产生的时序逆序排序，2: 按照结束时间的时序顺序排序，3：按照结束时间的时序逆序排序 |
0 |
| ReturnCount |
integer |
否 |
是否返回总条数；取值说明：0: 不返回，1：返回，不传默认为 1 |
1 |
| DownGrade |
integer |
否 |
是否呼叫降级；0-否, 1-是 |
0 |
| IsRealAnswer |
integer |
否 |
真人接听；取值说明：1-是、0-否 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
请求失败详情。 |
无 |
| RequestId |
string |
请求 ID。 |
6086693B-2250-17CE-A41F-06259AB6DB1B |
| Message |
string |
返回信息。 |
OK |
| Data |
object |
返回数据。 |
|
| List |
array<object> |
座席外呼通话记录数组 |
|
|
array<object> |
|||
| RealAnswerTime |
string |
真人接听时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| CustomerProvince |
string |
客户号码归属省份，如 北京 |
北京 |
| DisplayNumber |
string |
座席侧真实外显号码，当使用 AXB 场景进行外呼时，座席侧真实外显号码为虚拟号 |
41008502 |
| TaskId |
string |
座席自动外呼任务 id |
333 |
| EndTime |
string |
电话结束时间，时间戳，精确到 s，如 1480904471 |
1775024875 |
| Clid |
string |
客户侧外显号码，当使用虚拟号进行 AXB 外呼且开关打开时，实际返回的客户侧外显号码是虚拟号 |
41008502 |
| Cno |
string |
座席工号，如 2000 |
2000 |
| TrunkGroupKey |
string |
中继群组代号 |
30020 |
| TsiFileFormat |
string |
彩铃文件类型 |
mp3 |
| UserField |
object |
通话记录自定义字段，json 格式 |
{} |
| CallType |
string |
呼叫类型：4、预览外呼; 6、主叫外呼 |
4 |
| Gno |
string |
座席外呼组号 |
133 |
| AnswerTime |
string |
座席接听时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| RequestUniqueId |
string |
请求唯一 id |
uniq_1-162046xxxx.12 |
| StatusCode |
string |
呼叫结果码 |
33 |
| WaitDuration |
string |
客户等待时长秒数，单位是 s |
5 |
| AgentClid |
string |
座席侧外显号码 |
02138276106 |
| HangupReason |
string |
挂断原因 |
0 |
| EndReason |
string |
结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆 |
1000 |
| VadOut |
string |
通话质量百分比,数据是 0-100 之间，out 方向说话占用的百分比 |
70 |
| RecordFile |
array<object> |
通话记录录音数组 |
|
|
object |
|||
| Monitor_type |
integer |
|
1 |
| Type |
string |
取值：record,voicemail 说明：record 是录音， voicemail 是留言 |
record |
| File |
string |
录音文件名 |
record_file_name. |
| CustomerNumber |
string |
客户号码 国内固话或手机，区号 + 7 或 8 位的固话号码，区号与固话号码之间无'-'；或 11 位长度的手机号码。如 01041005968 或 18701051984 或虚拟号-分机号场景格式，如 18701051984-7538 |
01041005968 |
| RtcTotalDuration |
string |
RTC 总通话时长秒数，单位是 s，在呼叫类型为主叫外呼(RTC)时有效，计算规则：endTime-startTime |
133 |
| VadIn |
string |
通话质量百分比,数据是 0-100 之间，in 方向说话占用的百分比 |
30 |
| CalleeRingingTime |
string |
客户侧响铃时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| AgentName |
string |
座席名称 |
name3 |
| DownGrade |
string |
是否呼叫降级, 0-否, 1-是 |
1 |
| Status |
string |
外呼结果：30 座席未接听; 31 座席接听,未呼叫客户; 32 座席接听,客户未接听; 33 双方接听; 50 主叫外呼接听; 51 主叫外呼,客户未接听; 52 主叫外呼,双方接听。 |
33 |
| UniqueId |
string |
电话唯一标识 |
uniq_1-162046xxxx.12 |
| AgentNumber |
string |
座席电话 区号 +7 或 8 位的固话号码，区号与固话号码之间无'-'；或 11 位长度的手机号码。0104100596 |
0104100596 |
| SipCause |
string |
SIP 响应码：200 ~ 699 详见 注：主叫外呼 RTC 座席侧没有 SIP 协商的概念，并未发起呼叫，因此该值默认为 0 |
200 |
| XNumber |
string |
虚拟号码 |
13322444 |
| CustomerCity |
string |
客户号码归属城市,北京 |
北京 |
| StatusReason |
string |
通话状态原因（主叫外呼）描述：1 - 企业黑名单; 2 - 风控系统拦截; 20001 - 呼叫限制；20002 - 黑名单或非白名单；20003 - 禁拨时间段； 3 - 无效的外显号码; 4 - 错误的语音导航; 5 - 企业停机; 6 - 无权限外呼; 7 - 超出呼叫次数限制; 8 - 错误号码; 9 - 其他错误； |
9 |
| CallId |
string |
通话唯一标识 |
uniq_1-162046xxxx.12 |
| StartTime |
string |
座席开始外呼时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| CustomerAreaCode |
string |
客户号码区号 |
028 |
| IsRealAnswer |
string |
是否真人接听：1 - 是、0 - 否、空值 |
1 |
| LeftDisplayNumber |
string |
客户侧真实外显号码，当使用 AXB 场景进行外呼时，客户侧真实外显号码为虚拟号 |
13322225555 |
| DownGradeCounts |
string |
降级次数 |
1 |
| TotalDuration |
string |
总通话时长秒数，单位是 s |
30 |
| MainRingingTime |
string |
分机外呼，话机响铃时间 |
1775024775 |
| TsiFile |
string |
彩铃文件名称 |
name2 |
| BridgeDuration |
string |
服务处理时长秒数，单位是 s |
10 |
| BridgeTime |
string |
双方接听时间，时间戳，精确到 s，如 1480904471 |
1775024775 |
| Id |
string |
Id |
9075217226 |
| Code |
string |
响应码 |
OK |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "无",
"RequestId": "6086693B-2250-17CE-A41F-06259AB6DB1B",
"Message": "OK",
"Data": {
"List": [
{
"RealAnswerTime": "1775024775",
"CustomerProvince": "北京",
"DisplayNumber": "41008502",
"TaskId": "333",
"EndTime": "1775024875",
"Clid": "41008502",
"Cno": "2000\n",
"TrunkGroupKey": "30020",
"TsiFileFormat": "mp3",
"UserField": {},
"CallType": "4",
"Gno": "133",
"AnswerTime": "1775024775",
"RequestUniqueId": "uniq_1-162046xxxx.12",
"StatusCode": "33",
"WaitDuration": "5",
"AgentClid": "02138276106",
"HangupReason": "0",
"EndReason": "1000",
"VadOut": "70",
"RecordFile": [
{
"Monitor_type": 1,
"Type": "record",
"File": "record_file_name."
}
],
"CustomerNumber": "01041005968",
"RtcTotalDuration": "133",
"VadIn": "30",
"CalleeRingingTime": "1775024775",
"AgentName": "name3",
"DownGrade": "1",
"Status": "33",
"UniqueId": "uniq_1-162046xxxx.12",
"AgentNumber": "0104100596",
"SipCause": "200",
"XNumber": "13322444",
"CustomerCity": "北京",
"StatusReason": "9",
"CallId": "uniq_1-162046xxxx.12",
"StartTime": "1775024775",
"CustomerAreaCode": "028",
"IsRealAnswer": "1",
"LeftDisplayNumber": "13322225555",
"DownGradeCounts": "1",
"TotalDuration": "30",
"MainRingingTime": "1775024775",
"TsiFile": "name2",
"BridgeDuration": "10",
"BridgeTime": "1775024775",
"Id": "9075217226"
}
]
},
"Code": "OK"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。