华为云用户手册

报文样例 请求头: {"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": "***" } ]}

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

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

响应说明 响应状态码: 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 业务失败：请依次确认您请求中各参数的取值。

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

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "skills": [ 1, 10 ]} 响应参数 { "message": "", "retcode": "0", "result": [ { "pilotNbr": "", "deviceNo": 1, "queueSize": 0, "queueTime": 0, "loadFactor": 65535, "estWaitTime": 0, "loggedOnAgents": 1, "availAgents": 1, "transferFlg": 0, "transferDeviceType": 255, "transferDeviceNo": 65535, "skillDescrip": "chat_madeqiang", "resourceIdleRate": 100, "serviceLevel": 100, "oldCallIdEx": { "dateTime": 4294967295000, "dsn": 65535, "server": 255, "handle": 255 }, "maxQueueSize": 100 }, { "pilotNbr": "1009", "deviceNo": 10, "queueSize": 0, "queueTime": 0, "loadFactor": 65535, "estWaitTime": 0, "loggedOnAgents": 2, "availAgents": 2, "transferFlg": 0, "transferDeviceType": 255, "transferDeviceNo": 65535, "skillDescrip": "chat_jinsitao", "resourceIdleRate": 100, "serviceLevel": 100, "oldCallIdEx": { "dateTime": 4294967295000, "dsn": 65535, "server": 255, "handle": 255 }, "maxQueueSize": 100 } ]}

接口URI https://ip:port/agentgateway/resource/queuedevice/{agentid}/queryacdstat 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 skills List True 技能队列ID列表，数组长度不能大于100

报文样例 请求头: Content-Type: application/jsonX-APP-KEY: **************************************Authorization: Bearer ************************************** 请求参数: {"phoneNo":"13020017****"} 响应参数: { "returnCode": "0", "data": { "areaCode": "110100", "province": "北京", "city": "北京", "cityCode": "010", "isp": "联通", "postCode": "100000", "phoneNo": "1302001" }, "description": "success"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 phoneNo string True 查询的11位手机号码，或者带区号固话。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码，0成功，非0失败 1.2 description string False 返回描述 1.3 data object False 手机号码归属地信息 1.3.1 areaCode string False 地区码 1.3.2 province string False 省 1.3.3 city string False 城市 1.3.4 cityCode string False 城市编码，可能多个，"/"分隔，如果查询的是固话，城市编码可能为空 1.3.5 isp string False 运营商：电信、移动、联通。 如果是固话查询则返回未知 1.3.6 postCode string False 邮政编码，可能多个，"/"分隔，如果查询的是固话，邮政编码可能为空 1.3.7 phoneNo string False 手机号码前7位，或者固话区号 响应状态码: 401 授权失败：1. 参数是否正确有效。 2. 请确认是否购买了相关服务。 3. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求路径可能不对。 响应状态码: 500 参数不对导致业务失败或者服务端内部异常。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestParam object True 请求参数 1.1 accountPwd string True 座席当前密码，修改软电话密码时需要校验座席当前密码，如果校验失败三次，会锁账号，当前会在30分钟后解锁，也可以登入租户管理员账号人工解锁。 1.2 newPhonePwd string True 新软电话密码，长度8-16位（默认密码规则组），默认需要提供以下三种的任意组合：大写字母、小写字母、数字和特殊字符。 特殊字符支持 ~@^*_+.? 1.3 userAccount string True 座席账号

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

报文样例 请求头: x-app-key: 68b*************6ec8e4Content-Type: application/jsonAuthorization: Bearer xxx 请求参数: { "userAccounts": [ "x1", "x2" ], "skillId": 4, "agentWeight": 1, "skillWeight": 1} 响应参数: { "resultCode": "0", "resultMessage": "success"}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 resultCode string True 请求成功为0，请求失败为1 1.2 resultMessage string False 请求失败，resultCode为1时会携带具体原因 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 userAccounts array True 座席账号数组，字符串型，长度最多不超过50 1.2 skillId integer True 技能队列ID 1.3 agentWeight integer True 座席权重，权重越高，越优先分配该座席，最低1 1.4 skillWeight integer True 技能队列权重，最低1

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 data array[object] False 返回数据 1.1.1 workNo number False 座席工号 1.1.2 agentType number False 座席类型： 4：音频座席； 11：视频座席 5：多媒体座席； 99：全能座席 1.1.3 agentWeight number False 座席权重，权重越高，越优先分配该座席，最低1 1.1.4 accountName string False 用户名称 1.1.5 sipAccount string False 软电话号码 1.1.6 skillWeight number False 技能队列权重，最低1 1.1.7 userAccount string False 座席账号，同创建座席的座席账号 1.2 count integer False 查询座席信息的数量 1.3 resultCode string False 请求成功返回0 ，请求失败返回1，会携带resultMessage，具体错误原因 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：根据技能队列ID查询座席信息 请求参数： { "skillId":3, "pageSize":10, "pageNum":0 } 响应参数： {"data": [ { "workNo": 107, "accountCode": "xxxxx", "agentType": 4, "agentWeight": 1, "accountName": "xxxxx", "sipAccount": "88880006", "skillWeight": 1 } ], "count": 1, "resultCode": "0" }

请求说明 表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开始

请求说明 表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"}

接口URI https://ip:port/agentgateway/resource/queuedevice/{agentid}/waitnumbyagent 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

响应说明 响应状态码: 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"}

报文样例 请求头: Content-Type: application/json X-APP-Key: ************************************ Authorization: Bearer ******************************** 请求参数: { "customNos": [ "135****1111", "wen11", "kehu@*****.com" ]} 响应参数: {"retCode": "0","retMsg": "VerifyParams success"}

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 Content-Type string False 内容类型，设置为application/json 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 customNos array True 客户号码列表（最多1000个，可以是主叫或被叫）

报文样例 请求头: "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(1024) False 账号校验信息 1.2 returnCode string(10) False 账号校验返回码 0：成功 1：失败 1.3 results object 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 业务失败：请依次确认您请求中各参数的取值。