华为云用户手册

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestParam object True 请求参数 1.1 skillId integer True 技能队列ID 1.2 pageSize integer True 分页大小，最大值为100 1.3 pageNum integer True 分页页号，从0开始

报文样例 请求头: {"x-app-key": "f******************************f"，"Authorization": "Bearer 0******************************8"} 响应参数: {"servicePort": 448，"serviceIp": "127.0.0.0"，"sipServiceIp": "127.0.0.0"，"sipServicePort": 5060，"agents": [{"workNo": 1522，"password": "7****tt"，"sipAccount": "88881619"，"sipPwd": "1****tt"}， {"workNo": 1523，"password": "f*****xL"，"sipAccount": "88881620"，"sipPwd": "1*****xL"}]}

报文样例 请求头: {"x-app-key": "f******************************f"，"Authorization": "Bearer 0******************************8"} {"connection": "keep-alive"，"content-type": "application/json;charset=UTF-8"} 响应头: 响应参数: { "sipServiceIp": "10.10.96.98"， "sipServicePort": 5060， "agents": [ { "workNo": 1522， "accountCode": "aaaa"， "sipAccount": "88881619"， "sipPwd": "***" }， { "workNo": 1523， "sipAccount": "88881620"， "sipPwd": "***" } ]}

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 serviceIp string False 座席登录服务实例地址，Nginx地址，或SLB地址 长度限制:string(50) 1.2 sipServicePort string False 软电话注册端口，1~65535 长度限制:string(5) 1.3 sipServiceIp string False 软电话注册地址 长度限制:string(50) 1.4 servicePort string False 座席登录服务端口 长度限制:string(5) 1.5 agents array[object] False 座席集合 1.5.1 workNo integer True 座席工号，范围从101到59999 1.5.2 sipAccount string False SIP软电话号码 长度限制:string(24) 1.5.3 sipPwd string False SIP软电话加密前密码 长度限制:string(24) 1.5.4 password string False 座席签入登录平台的加密前密码 长度限制:string(8) 响应状态码: 400 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误的请求：请检查请求路径及参数。 响应状态码: 401 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 请求的内容未找到：请检查请求的路径。 响应状态码: 500 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sipServicePort string False 软电话注册端口，1~65535 长度限制:string(5) 1.2 sipServiceIp string False 软电话注册地址，IPV4格式 长度限制:string(50) 1.3 agents array[object] False 座席集合 1.3.1 workNo integer True 座席工号，范围从101到59999 1.3.2 sipAccount string False SIP软电话号码 长度限制:string(24) 1.3.3 sipPwd string False SIP软电话加密前密码 长度限制:string(24) 1.3.4 accountCode string False 关联的Service Cloud登录账号 长度限制:string(100) 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string True 操作结果。0：成功，非0为失败 1.2 description string False 提示信息 1.3 skillId string False 技能ID 响应状态码: 401 鉴权失败 响应状态码: 404 请求资源不存在 响应状态码: 500 服务器内部异常

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXXAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "mediaTypeId": 5， "description": "ccfdc"， "name": "dddpodfst"， "maxWaitTime": 30， "maxWaitNum": 100， "maxAgentWrapupTime": 5， "skillParam": { "noAgents": { "deviceType": "1"， "transferType": "Transfer"， "value": 2 }， "busy": { "deviceType": "1"， "transferType": "Transfer"， "value": 1 }， "answerFunction": "0"， "timeOut": { "deviceType": "1"， "transferType": "Transfer"， "value": 1 }， "waitVoice": { "parameterType": "Voice" } }} 响应参数: { "returnCode": "0"， "skillId": "5"， "description": "Create Skill successfully"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 skillIds string True 技能队列ID，多个以英文逗号或分号或横线隔开，最多10个SkillId

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXXAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: {"skillIds":"3，4"} 响应参数: { "returnCode": "0"， "description": "Success"}

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXXAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: {"skillId":3，"description":"2021ok"，"maxWaitTime":60} 响应参数: { "returnCode": "0"， "description": "Update Skill successfully"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 description string False 技能简称或描述，不超过50个字符（允许的字符包括中文、字母、数字） 1.2 maxWaitTime number False 最大排队等待时间，单位秒，最大值60000 1.3 maxWaitNum number False 最大排队等待人数，最大值10000 1.4 maxAgentWrapupTime number False 整理态时长，单位秒，最大值3600 1.5 skillParam object False 技能队列参数信息，媒体类型为53或2或18时，只有noAgents、busy和timeOut三项配置，媒体类型为53时deviceType的值只能为1；媒体类型为5或19时noAgents、busy、timeOut、answerFunction和waitVoice配置必填 1.5.1 noAgents object True 无人上班配置 1.5.1.1 deviceType string False 设备类型。 3：IVR 1：技能队列 1.5.1.2 transferType string True 处理策略。 Release：释放，此时同级其他参数不填 Transfer：转接，此时同级其他参数必填 1.5.1.3 value number False 技能队列时取skillId，IVR时取IVR流程编号id 1.5.2 busy object True 排队遇忙、溢出配置 1.5.2.1 deviceType string False 设备类型 3：IVR 1：技能队列 1.5.2.2 transferType string True 处理策略。 Release：释放，此时同级其他参数不填 Transfer：转接，此时同级其他参数必填 1.5.2.3 value number False 技能队列时取skillId，IVR时取IVR流程编号id 1.5.3 answerFunction string False 业务代表应答方式配置，0报工号2不报语音 1.5.4 timeOut object True 排队超时配置 1.5.4.1 deviceType string False 设备类型 3：IVR 1：技能队列 1.5.4.2 transferType string True 处理策略。 Release：释放，此时同级其他参数不填 Transfer：转接，此时同级其他参数必填 1.5.4.3 value number False 技能队列时取skillId，IVR时取IVR流程编号id 1.5.5 waitVoice object False 排队等待配置 1.5.5.1 parameterType string True Voice：Voice，此时同级其他参数不填 IVR：IVR，此时同级其他参数必填 1.5.5.2 id string False IVR时取IVR流程编号id 1.6 skillId integer True 技能队列ID

报文样例 请求头: "x-app-key":"e******************************a"， "Authorization":"Bearer e******************************8""Content-Type":"application/json;charset=UTF-8"， "Connection":"keep-alive" 请求参数： {"account": "ls120201"，"password": "S*****x"} 响应参数： {"returnCode": "0"，"results": {"sipServerInfo": [{"sipServiceIp": "10.10.10.11"，"sipServicePort": "33"，"type": "0"}]，"password": "11****8Q"，"sipAccount": "88887818"，"workNo": "1516"}，"message": "verify Account or password success."}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False App标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 password string(100) True 登录密码 1.2 account string(100) True 登录账号

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 message string(1，024) False 账号校验信息 1.2 returnCode string(10) False 账号校验返回码 0：成功 1：失败 1.3 results Results False 查询结果 表4 Results参数结构 序号 名称 参数类型 是否必选 说明 1.1 workNo string(5) False 座席工号 1.2 password string(100) False 座席签入登录平台的加密前密码 1.3 sipAccount string(24) False SIP软电话号码 1.4 sipPwd string(100) False SIP软电话加密前密码 1.5 sipServerInfo array[SIPServerInfo] False SIP服务信息 表5 SIPServerInfo参数结构 序号 名称 参数类型 是否必选 说明 1.1 sipServiceIp string(50) False 软电话注册地址 1.2 sipServicePort string(5) False 座席登录服务端口 1.3 node string(10) False sip服务节点 1.4 type string(10) False sip服务类型，默认SIP 0：SIP 1：WebRTC 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0：成功 其他：失败 1.2 description string False 描述 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表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一致

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "accessCode": "9911411"， "extCode": "11"， "devicetype": 1， "deviceId": 1， "mediaTypeId": 19} 响应参数: { "returnCode": "0"， "description": "data create success"}

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXXAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "limit": "10"， "offset": 0} 响应参数: { "returnCode": "0"， "total": 1， "data": [ { "skillId": 1， "maxAgentWrapupTime": 5， "maxWaitTime": 60， "name": "defaultVideoSkill"， "mediaTypeId": 19， "description": "2021ok"， "maxWaitNum": 100， "skillParam": { "noAgents": { "transferType": "Release" }， "busy": { "transferType": "Release" }， "answerFunction": "0"， "timeOut": { "transferType": "Release" }， "waitVoice": { "parameterType": "Voice" } } } ]， "description": "success"}

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-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"}

请求说明 表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 array[object] False - 1.1.1 id string False 接入码ID 1.1.2 accessCode string False 接入码 1.1.3 mediatypeId integer False 媒体类型： 2：语音点击通话 5：音视频 18：视频点击通话 19：视频 53：多媒体 1.1.4 n400Number string False 接入码页面配置的服务号码，通常为核心网映射的400号码 1.1.5 description string False 接入码描述 1.1.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 业务失败：请依次确认您请求中各参数的取值。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0：成功 其他：失败 1.2 description string False 描述 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "id": "1125397061153369092"， "devicetype": 1， "deviceId": 1} 响应参数: { "returnCode": "0"， "description": "data update success"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id string True 被叫配置ID 1.2 devicetype integer True 设备类型；1：技能队列 3：IVR 1.3 deviceId integer True 目前设备id（技能队列skillId、IVR的id）

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0：成功 其他：失败 1.2 description string False 描述 1.3 data object False 删除情况展示 1.3.1 id string False 删除的绑定数据id 1.3.2 name string False 删除的绑定数据"accessCode"+"extCode" 1.3.3 content string False 删除的accessCode 1、全部删除成功或者全部删除失败时，和name一样 2、部分删除成功时，字符串结构为"Success:"+"同name一样"+"，Failed:"+"同name一样" 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 dnids string True 配置编号(查询被叫配置时返回的dnid); 删除多个用，隔开；最大删除数1000

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "dnids": "1，2"} 响应参数: { "returnCode": "0"， "data": { "name": "9911411，99114111"， "id": "1127983948544239618，1127986019188238339"， "content": "9911411，99114111" }， "description": "data delete success"}

响应说明 响应状态码: 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：多媒体 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-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"}

请求说明 表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 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查询