通过本接口,可以查询webCall通话记录信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| EnterpriseId |
integer |
是 |
呼叫中心 id |
7000002 |
| UniqueId |
string |
否 |
如果 uniqueId 值不为空,则以下其它参数无效,即仅查询电话唯一标识为 uniqueId 的记录信息 |
uniq_1-162046xxxx.12 |
| RequestUniqueId |
string |
否 |
查询请求唯一 id 对应的记录信息,默认查询当前月,如 requestUniqueId 不属于当前月,查询时请传递查询参数 查询开始时间(startTime) |
uniq_1-162046xxxx.12 |
| Status |
integer |
否 |
呼叫结果;参数说明: 20 webcall, TTS 合成失败; 21 webcall, 客户未接 ; 22:webcall, 客户接听; 23: webcall; 已呼叫; 24: webcall, 双方接听; |
24 |
| 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 不允许跨月,默认值取当前月份最后一天 |
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 |
| CustomerNumber |
string |
否 |
客户号码 |
01042003255 |
| Cno |
string |
否 |
座席工号 |
1111 |
| Gno |
string |
否 |
座席所属外呼组 单个外呼组号 2-20 位,支持一个或多个座席工号查询,多个座席工号以英文逗号隔开,一次最多支持 10 个。不支持模糊匹配。 |
233 |
| CalleeNumber |
string |
否 |
座席号码 |
01041009283 |
| DisplayNumber |
string |
否 |
真实外显号码,当使用 AXB 场景进行外呼时,真实外显号码为虚拟号 |
02138276106 |
| CalleeDisplayNumber |
string |
否 |
第二侧真实外显号码 |
02138276106 |
| Clid |
string |
否 |
外显号码 |
02138276106 |
| CalleeClid |
string |
否 |
第二侧外显号码 |
02138276106 |
| ReturnCount |
integer |
否 |
是否返回总条数;取值说明:0: 不返回,1:返回,不传默认为 1 |
1 |
| IsRealAnswer |
integer |
否 |
真人接听;取值说明:1-是、0-否 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
无 |
| RequestId |
string |
请求 ID。 |
90E63D28-E31D-1EB2-8939-A9486641**** |
| Message |
string |
信息 |
OK |
| Data |
object |
返回的数据内容。 |
|
| List |
array<object> |
webcall 通话记录数组 |
|
|
array<object> |
|||
| RealAnswerTime |
string |
真人接听时间,时间戳,精确到 s,如 1480904471 |
1775024775 |
| NumberTrunk |
string |
中继号码 |
42003255 |
| CustomerProvince |
string |
客户号码归属省份,如 北京 |
北京 |
| TaskId |
string |
任务 id |
13354 |
| DisplayNumber |
string |
真实外显号码,当使用 AXB 场景进行外呼时,真实外显号码为虚拟号 |
02138276106 |
| EndTime |
string |
电话结束时间,时间戳,精确到 s,如 1480904471 |
1774822312 |
| Clid |
string |
外显号码 |
02138276106 |
| Cno |
string |
座席工号,如 2000 |
2000 |
| TrunkGroupKey |
string |
中继组标识 |
30019 |
| CalleeDisplayNumber |
string |
第二侧真实外显号码 |
02138276106 |
| DetailRingingTime |
string |
转话机后,话机响铃时间 |
1774822303 |
| CallType |
string |
呼叫类型 webcall |
webcall |
| Gno |
string |
座席外呼组号 |
WH333 |
| AnswerTime |
string |
系统接听时间,时间戳,精确到 s,如 1480904471 |
1774822302 |
| StatusCode |
string |
status 对应的状态码 |
24 |
| RequestUniqueId |
string |
用户自定义通话标识字段 |
214b76605a43d02f4aab4e61cfa63128 |
| CalleeClid |
string |
第二侧外显号码 |
02138276106 |
| WaitDuration |
string |
等待时长 |
6 |
| EndReason |
string |
结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆 |
1000 |
| Qno |
string |
队列号,如 1000 |
1000 |
| RecordFile |
array<object> |
通话记录录音数组 |
|
|
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 |
| CalleeRingingTime |
string |
客户响铃时间,时间戳,精确到 s,如 1480904471 |
1774822302 |
| AgentName |
string |
座席名称 |
张三 |
| DownGrade |
string |
是否呼叫降级,0-否,1-是 |
0 |
| IvrName |
string |
IVR 名称,默认自定义 |
webcall |
| Status |
string |
外呼结果, 如客户接听 |
客户接听 |
| UniqueId |
string |
电话唯一标识 |
uniq_1-162046xxxx.12 |
| SipCause |
string |
号码状态识别编码,详见 |
200 |
| CustomerCity |
string |
客户号码归属城市,北京 |
北京 |
| CallId |
string |
通话唯一标识 |
4e18e73a-af6a-4a77-92ea-628a6effd64b |
| StartTime |
string |
电话进入系统时间,时间戳,精确到 s,如 1480904471 |
1774822302 |
| SipCauseStr |
string |
呼叫结果 |
处理成功 |
| TaskFileId |
string |
任务文件 id |
12144 |
| IsRealAnswer |
string |
是否真人接听:1 - 是、0 - 否、空值 |
1 |
| DownGradeCounts |
string |
呼叫降级次数 |
0 |
| CalleeNumber |
string |
座席电话 区号 +7 或 8 位的固话号码,区号与固话号码之间无'-';或 11 位长度的手机号码。0104100596 |
0104100596 |
| TotalDuration |
string |
总通话时长秒数,单位是 s |
10 |
| BridgeDuration |
string |
服务处理时长秒数,单位是 s |
4 |
| Id |
string |
Id |
14454 |
| BridgeTime |
string |
座席接听时间,时间戳,精确到 s,如 1480904471 |
1774822308 |
| Code |
string |
状态码。 |
OK |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "无",
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Message": "OK",
"Data": {
"List": [
{
"RealAnswerTime": "1775024775",
"NumberTrunk": "42003255",
"CustomerProvince": "北京",
"TaskId": "13354",
"DisplayNumber": "02138276106",
"EndTime": "1774822312",
"Clid": "02138276106",
"Cno": "2000",
"TrunkGroupKey": "30019",
"CalleeDisplayNumber": "02138276106",
"DetailRingingTime": "1774822303",
"CallType": "webcall",
"Gno": "WH333",
"AnswerTime": "1774822302",
"StatusCode": "24",
"RequestUniqueId": "214b76605a43d02f4aab4e61cfa63128",
"CalleeClid": "02138276106",
"WaitDuration": "6",
"EndReason": "1000",
"Qno": "1000",
"RecordFile": [
{
"Monitor_type": 1,
"Type": "record",
"File": " name3"
}
],
"CustomerNumber": "18701051984",
"CalleeRingingTime": "1774822302",
"AgentName": "张三",
"DownGrade": "0",
"IvrName": "webcall",
"Status": "客户接听",
"UniqueId": "uniq_1-162046xxxx.12",
"SipCause": "200",
"CustomerCity": "北京",
"CallId": "4e18e73a-af6a-4a77-92ea-628a6effd64b",
"StartTime": "1774822302",
"SipCauseStr": "处理成功",
"TaskFileId": "12144",
"IsRealAnswer": "1",
"DownGradeCounts": "0",
"CalleeNumber": "0104100596",
"TotalDuration": "10",
"BridgeDuration": "4",
"Id": "14454",
"BridgeTime": "1774822308"
}
]
},
"Code": "OK"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。