文档首页/ 云客服/ API参考/ 呼叫中心配置类/ 号码管理/ 查询接入码(queryAccessCodeList)
更新时间:2024-09-24 GMT+08:00
分享

查询接入码(queryAccessCodeList)

场景描述

查询指定租间的接入码(接入码:即您面向客户提供的客服热线)

接口方法

POST

接口URI

https://域名/apiaccess/rest/cc-management/v1/accessCodeInfo/queryAccessCodeList,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

False

appKey字段,用户标识,请联系运营人员获取appKey

2

Authorization

string

True

鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1.1

accessCode

string

False

接入码 支持模糊查询

1.2

mediatypeId

integer

False

媒体类型

2:点击通话

5:音视频

53:多媒体

1.3

description

string

False

接入码描述 支持模糊查询

1.4

limit

integer

False

表示每页的查询数量,0-100,默认100,如果输入超过100,将默认查询100条

1.5

offset

integer

False

offset用于确定查询的起始页。offset取值范围为:offset=limit*(page-1),page为需要查询的起始页。offset默认值0,最大值100

响应说明

  • 响应状态码: 200
    表3 响应体参数

    序号

    名称

    参数类型

    是否必选

    说明

    1.1

    data

    object

    False

    -

    1.1.1

    total

    number

    False

    数据总量

    1.1.2

    calledRouteList

    array[object]

    False

    接入码信息列表

    1.1.2.1

    id

    string

    False

    接入码ID

    1.1.2.2

    accessCode

    string

    False

    接入码

    1.1.2.3

    mediatypeId

    integer

    False

    媒体类型:

    2:语音点击通话

    5:音视频

    18:视频点击通话

    19:视频

    53:多媒体

    1.1.2.4

    n400Number

    string

    False

    接入码页面配置的服务号码,通常为核心网映射的400号码

    1.1.2.5

    description

    string

    False

    接入码描述

    1.1.2.6

    numCallAttr

    number

    False

    号码属性(3:呼入和呼出;2:呼出;1:呼入)

    1.2

    returnCode

    string

    False

    返回码 0:成功 其他:失败

    1.3

    description

    string

    False

    描述

  • 响应状态码: 400

    错误的请求:请检查请求路径及参数

  • 响应状态码: 401

    未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。

  • 响应状态码: 403

    鉴权失败

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

请求头:

Content-Type:application/json
Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX
X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX

请求参数:

{
   "accessCode": "9911411",
   "mediatypeId": 5,
   "description": "接入码",
   "limit":10,
    "offset":0
}

响应参数:

{
    "returnCode": "0",
    "data": {
        "total": 1,
        "calledRouteList": [
            {
                "id": "1124167935465633793",
                "accessCode": "9911411",
                "mediatypeId": 5,
                "n400Number": null,
                "description": null,
                "numCallAttr": 3				
            }
        ]
    },
    "description": "success"
}

相关文档