文档首页/ 云客服/ API参考/ 呼叫中心配置类/ 号码管理/ 单个创建接入码与技能队列、IVR绑定关系(createCalledRoute)
更新时间:2024-09-24 GMT+08:00
分享

单个创建接入码与技能队列、IVR绑定关系(createCalledRoute)

场景描述

单个创建接入码与技能队列、IVR绑定关系的接口

接口方法

POST

接口URI

https://域名/apiaccess/rest/cc-management/v1/calledRoute/createCalledRoute,例如域名是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

True

接入码;最大长度32字符

1.2

extCode

string

False

扩展码; 最大长度12字符(如果希望一个接入码能设置多个目的设备。这种情况下可通过配置扩展码的方式来实现,例如,接入码为12345,我们可以添加扩展码1,路由到技能队列A,扩展码2,路由到技能队列B。这样客户可直接拨打123451实现直接接入技能队列A。)

1.3

mediaTypeId

integer

False

媒体类型;默认值:5

字段可选值:(2:语音点击通话 5:音视频 18:视频点击通话 19:视频 53:多媒体)

说明:

1、传入技能队列(devicetype=1)时,mediaTypeId等于传入的技能队列绑定的mediaTypeId(没有绑定默认5)

2、接入码accessCode所属的媒体类型(查询接入码接口返回的mediaTypeId字段)和该入参mediaTypeId的对应关系如下:

5对应5和19;

53对应53;

2对应2和18

1.4

devicetype

integer

True

设备类型;

1:技能队列

3:IVR

说明:多媒体渠道不能选择IVR流程

1.5

deviceId

integer

True

目标设备id(技能队列skillId、IVR的id)

说明:传入技能队列(devicetype=1)时,deviceId的对应的媒体类型要和入参mediaTypeId一致

响应说明

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

    序号

    名称

    参数类型

    是否必选

    说明

    1.1

    returnCode

    string

    False

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

    1.2

    description

    string

    False

    描述

  • 响应状态码: 400

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

  • 响应状态码: 401

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

  • 响应状态码: 403

    鉴权失败

  • 响应状态码: 404

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

  • 响应状态码: 500

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

错误码

无。

报文样例

请求头:

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

请求参数:

{
    "accessCode": "9911411", 
    "extCode": "11",
    "devicetype": 1, 
    "deviceId": 1,
    "mediaTypeId": 19
}

响应参数:

{
    "returnCode": "0",
    "description": "data create success"
}

相关文档