查询指定VDN下的呼叫信息(v2)
场景描述
提供根据主叫号码、被叫号码、时间段查询指定vdn的呼叫信息。
对比v1接口,v1接口仅提供呼入通话的呼叫信息,v2接口新增isCallIn参数,可以选择查询呼入或是呼出的呼叫信息。
接口方法
POST
接口URI
https://ip:port/rest/cmsapp/v2/openapi/vdn/querycalls
其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。
非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。
请求说明
参数名称 |
是否必选 |
参数类型 |
默认值 |
说明 |
---|---|---|---|---|
Content-Type |
必选 |
String |
无 |
固定填 application/json; charset=UTF-8。 |
Authorization |
必选 |
String |
无 |
生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 |
参数名称 |
是否必选 |
参数类型 |
默认值 |
说明 |
---|---|---|---|---|
ccId |
必选 |
int |
无 |
呼叫中心编号。 取值范围:1~65535 |
vdn |
必选 |
int |
无 |
虚拟中心编号。 取值范围:1~5000 |
callerNo |
选填 |
string |
无 |
主叫号码,可以为空值,表示查询所有。 由数字组成,需要符合号码规范 |
calleeNo |
选填 |
string |
无 |
被叫号码,可以为空值,表示查询所有。 由数字组成,需要符合号码规范 |
beginDate |
必填 |
long |
无 |
查询时间段的开始时间。 值为毫秒级时间戳,时间不能早于前一天的0点0分0秒 |
endDate |
必填 |
long |
无 |
查询时间段的结束时间。 值为毫秒级时间戳,时间不能晚于今天的23点59分59秒 |
isCallIn |
必填 |
string |
无 |
值为字符串"true"时,表示查询呼入的呼叫信息,值为字符串"false"时,表示查询呼出的呼叫信息 |
limit |
选填 |
int |
无 |
查询数目限制。 最大为100。 |
offset |
选填 |
int |
无 |
offset用于确定查询的起始页。 offset取值公式为:offset=limit*(page-1),取值范围:>=0。 page为需要查询的起始页。 |
响应说明
参数名称 |
参数类型 |
说明 |
---|---|---|
resultCode |
string |
查询结果。取值如下:
|
resultDesc |
object |
查询成功后,返回结果信息的对象。 |
data |
array<callinDetial> |
返回结果信息的对象数组。该对象数组的参数说明请参见表4 |
count |
int |
可查询数据的数量 |
参数名 |
数据类型 |
说明 |
---|---|---|
logDate |
long |
数据入库时间,毫秒级时间戳 |
callerNo |
string |
主叫号码 |
calleeNo |
string |
被叫号码 |
callId |
string |
呼叫ID |
callType |
int |
呼叫类型,请参见呼叫类型说明 |
waitBegin |
long |
等待开始时间,毫秒级时间戳 |
ackBegin |
long |
应答开始时间,毫秒级时间戳 |
callBegin |
long |
呼叫开始时间,毫秒级时间戳 |
callEnd |
long |
呼叫结束时间,毫秒级时间戳 |
vdn |
int |
虚拟呼叫中心编号 |
leaveReason |
int |
呼叫离开设备原因,请参见表1 |
mediaType |
int |
媒体类型,具体请参见表1。 |
subMediaType |
int |
子媒体类型,具体请参见表3。 |
错误码
请参见错误码参考。
报文样例
- 请求头
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- 请求参数
{ "ccId":1, "vdn":170, "callerNo": "12345", "calleeNo": "23131", "beginDate": "14511111111", "endDate": "14522222222", "isCallIn":"true" "limit": 10, "offset": 0 }
- 响应头
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 02 Jul 2018 02:43:03 GMT
- 响应参数
{ "resultCode":"0100000", "resultDesc":{ "data":[ { "logDate": "1615717765000", // 统计时间 "callerNo": "1212", // 主叫号码 "calleeNo": "12121212",// 被叫号码 "callId": "167789709-33", // 呼叫标识 "callType": "1",// 呼叫类型 "waitBegin": "1615717765000",// 呼叫等待开始时间 "ackBegin": "1615717765000",// 呼叫应答时间 "callBegin": "1615717765000",// 通话开始时间 "callEnd": "1615717765000",// 通话结束时间 "vdn": 170, // vdn编号 "leaveReason": "1", // 呼叫离开设备原因 "mediaType":53, // 媒体类型 "subMediaType":1 // 子媒体类型 } ], count: 5 } }