更新时间:2024-05-16 GMT+08:00
分享

查询指定VDN下的未接来电信息

场景描述

查询指定VDN下所有的未接来电信息。

接口方法

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

请求URL

https://ip:port/rest/cmsapp/v1/callin/queryMissedCalls

其中,公有云环境请联系管理员获取,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 请求体参数

序号

名称

参数类型

是否必选

说明

1

vdn

int

True

虚拟呼叫中心编号。取值范围:1~5000

2

offset

Number

True

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

offset取值范围为:offset=limit*(page-1)

3

limit

Number

True

查询条数,单次最大5000

4

beginTime

String

false

开始查询时间,零时区时间。

日期格式为:yyyy-MM-dd HH:mm:ss

5

endTime

String

false

结束查询时间,零时区时间。

日期格式为:yyyy-MM-dd HH:mm:ss

响应说明

表3 响应参数说明

参数名称

数据类型

是否必选

描述

returnCode

String

True

查询结果。取值范围:

  • 0:成功
  • 其他失败

total

Number

True

查询未接来电总条数。

missedCalls

MissedCall[]

True

未接来电详情列表,详细结果请参考表4

returnDesc

String

false

查询结果描述。

表4 MissedCall参数说明

参数名称

数据类型

是否必选

描述

callId

String

M

呼叫id。

callerNo

String

M

主叫号码。

calleeNo

String

M

被叫号码。

waitBegin

Datetime

M

呼叫开始等待时间。

callEnd

Datetime

M

呼叫结束时间。

mediaType

Int

N

媒体类型,具体请参见表1

subMediaType

Int

N

子媒体类型,具体请参见表3

报文样例

  • 请求头:
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • 请求参数:
    {
     "vdn":159,
     "offset":0,
     "limit":3,
     "beginTime":"2022-11-17 00:13:43",
     "endTime":"2022-11-17 23:44:13"
    }
  • 响应参数:
    {
        "returnCode": "0",
        "total": 2,
        "missedCalls": [
            {
                "callId": "1668048253-16797218",
                "callerNo": "1659960139858526939",
                "calleeNo": "6300111010",
                "waitBegin": "2022-11-17 23:44:13",
                "callEnd": "2022-11-17 23:44:25",
                 "mediaType":53,
                 "subMediaType":1
            },
            {
                "callId": "1668050023-1859",
                "callerNo": "88880990",
                "calleeNo": "31045665",
                "waitBegin": "2022-11-17 00:13:43",
                "callEnd": "2022-11-17 00:13:47",
                 "mediaType":53,
                 "subMediaType":1
            }
        ],
        "returnDesc": "query success"
    }
分享:

    相关文档

    相关产品