查询接入码与技能队列、IVR绑定关系（queryCalledRoute）
场景描述
查询接入码与技能队列、IVR绑定关系的接口
接口方法
POST
接口URI
https://域名/apiaccess/rest/cc-management/v1/calledRoute/queryCalledRoute，例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
1 |
X-APP-Key |
string |
False |
appKey字段，用户标识，请联系运营人员获取appKey |
2 |
Authorization |
string |
True |
鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
1.1 |
accessCode |
string |
False |
接入码 |
1.2 |
extCode |
string |
False |
扩展码 |
1.3 |
devicetype |
integer |
False |
设备类型 1：技能队列 3：IVR |
1.4 |
deviceDesc |
string |
False |
设备名称（技能队列/IVR名称）支持模糊匹配 |
1.5 |
mediaTypeId |
integer |
False |
媒体类型 2：语音点击通话 5：音视频 18：视频点击通话 19：视频 53：多媒体 |
1.6 |
limit |
integer |
False |
表示每页的查询数量，0-100，默认100，如果输入超过100，将默认查询100条 |
1.7 |
offset |
integer |
False |
offset用于确定查询的起始页。offset取值范围为：offset=limit*(page-1)，page为需要查询的起始页。offset默认值为0，如果输入负数，将按照0查询 |
响应说明
- 响应状态码: 200
表3 响应体参数 序号
名称
参数类型
是否必选
说明
1.1
returnCode
string
False
返回码
0：成功
其他：失败
1.2
description
string
False
描述
1.3
data
object
False
-
1.3.1
total
integer
False
总数
1.3.2
calledRouteList
array[object]
False
被叫列表
1.3.2.1
extCode
string
False
扩展码
1.3.2.2
editable
string
False
0或null：可编辑和删除
1：不可编辑，可删除
2：不可删除
3：不可编辑和删除
1.3.2.3
accessCode
string
False
接入码
1.3.2.4
dnid
number
False
配置编号
1.3.2.5
id
string
False
被叫ID（表主键id）
1.3.2.6
deviceId
number
False
目前设备id
1.3.2.7
devicetype
number
False
设备类型
1：技能队列
3：IVR
1.3.2.8
deviceDesc
string
False
目的设备描述
1.3.2.9
mediatypeId
number
False
媒体类型
2：语音点击通话
5：音视频
18：视频点击通话
19：视频
53：多媒体
1.3.2.10
flowAccessCode
string
False
流程接入码
1.3.2.11
subMediaTypeId
number
False
多媒体技能队列子类型
空值或者null：技能队列无子类型
1：WEB类型
2：Whatsapp类型
3：Line类型
4：Wechat类型
5：Facebook Messenger类型
6： Twitter类型
7：5G消息类型
8：EMAIL类型
1.3.2.12
partdbId
string
False
分区id
1.3.2.13
tenantId
string
False
租户id
- 响应状态码: 400
错误的请求：请检查请求路径及参数
- 响应状态码: 401
未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 403
鉴权失败
- 响应状态码: 404
请求的内容未找到：请检查请求的路径。
- 响应状态码: 500
业务失败：请依次确认您请求中各参数的取值。
错误码
无。
报文样例
请求头:
Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX
请求参数:
{
"accessCode": "9911411",
"extCode": "11",
"devicetype": 1,
"deviceDesc": "defaultVideoSkill",
"mediatypeId": 19,
"limit":10,
"offset":0
}
响应参数:
{
"returnCode": "0",
"data": {
"total": 3,
"calledRouteList": [
{
"id": "1125397061153369092",
"dnid": 3,
"accessCode": "9911411",
"mediatypeId": 19,
"extCode": "11",
"devicetype": 1,
"deviceId": 1,
"deviceDesc": "defaultVideoSkill",
"editable": "0"
},
{
"id": "1127983948544239618",
"dnid": 1,
"accessCode": "9911411",
"mediatypeId": null,
"extCode": "",
"devicetype": 1,
"deviceId": 1,
"deviceDesc": "defaultVideoSkill",
"editable": "0"
},
{
"id": "1127986019188238339",
"dnid": 2,
"accessCode": "9911411",
"mediatypeId": 19,
"extCode": "1",
"devicetype": 1,
"deviceId": 1,
"deviceDesc": "defaultVideoSkill",
"editable": "0"
}
]
},
"description": "success"
}
