文档首页/ 云客服/ API参考/ 质检/监控/统计类/ 监控/统计/ 实时数据查询类接口/ VDN维度实时接口/ 查询指定VDN下的呼叫信息
更新时间：2024-08-02 GMT+08:00
查看PDF
分享

查询指定VDN下的呼叫信息

场景描述

提供根据主叫号码、被叫号码、时间段查询指定vdn的呼叫信息。

该接口只能查询指定VDN下的呼入通话的呼叫信息。

接口方法

设置成“POST”。该接口仅支持POST方法，不支持PUT、GET和DELETE等方法。

请求URL

https://ip:port/rest/cmsapp/v1/openapi/vdn/querycalls

其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。

非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。
表2 请求消息体参数说明

参数名

数据类型

是否必选

说明

ccId

int

True

呼叫中心编号。

取值范围：1～65535

vdn

int

True

虚拟呼叫中心编号。

取值范围：1～5000

callerNo

string

False

主叫号码，可以为空值，表示查询所有。

由数字组成，需要符合号码规范

calleeNo

string

False

被叫号码，可以为空值，表示查询所有。

由数字组成，需要符合号码规范

beginDate

long

True

查询时间段的开始时间。

值为毫秒级时间戳，时间不能早于前一天的0点0分0秒。

数据源为0时区，查询时需要按照具体时区做转换：如东八区需要+8小时

endDate

long

True

查询时间段的结束时间。

值为毫秒级时间戳，时间不能晚于今天的23点59分59秒。

数据源为0时区，查询时需要按照具体时区做转换：如东八区需要+8小时

limit

int

False

表示每页的查询数量。

最大为100。

offset

int

False

offset用于确定查询的起始页。

offset取值公式为：offset=limit*(page-1)，取值范围：>=0。

page为需要查询的起始页。

响应消息

表3 响应消息体参数说明

参数名

数据类型

说明

resultCode

string

查询结果。取值如下：

  • "0100000"：成功
  • 其他：失败
  • 失败的原因说明请参见错误码参考。

resultDesc

object

查询成功后，返回结果信息的对象。

该对象的参数说明请参见表4
表4 resultDesc对象参数说明

参数名

数据类型

说明

data

array<callinDetial>

返回结果信息的对象数组。该对象数组的参数说明请参见表5

count

int

可查询数据的数量
表5 data对象参数说明

参数名

数据类型

说明

logDate

long

数据入库时间，毫秒级时间戳

callerNo

string

主叫号码

calleeNo

string

被叫号码

callId

string

呼叫ID

callType

int

呼叫类型，请参见表1

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", 
    "limit": 10,
    "offset": 0
}
  • 响应参数： 
    {
    "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
    }
}
父主题： VDN维度实时接口