华为云用户手册

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode number True 返回码。0表示成功，其他为失败。 1：上传OBS失败 3：VDN不可用 5：无对应历史记录 6：虚拟呼叫中心不存在 7：sftp信息为空 8：sftp用户密码为空 9：sftp连接失败 10：获取临时路径失败 11：从UAP下载文件失败 12：呼叫流水号长度不可大于50 13：录音文件大小超过限制 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 url string False 录音地址url 长度限制：string（200） 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：样例报文 请求头: x-app-key:6******************************b Authorization:Bearer e******************************6 Content-Type:application/json 请求参数: {"callSerialNo": "679218118865715226"} 响应头: {"connection": "keep-alive"，"content-type": "application/json;charset=UTF-8"} 响应参数: {"retMsg": "success"，"result": {"url": "https://aicc-obs0.obs.cn-south-1.myhuaweicloud.com:443/644429155876552705?AWSAccessKeyId=ZGUZVMUDBS2DKAQ5X141&Expires=1565681851&Signature=sb3ZDPyzg%2FXZLMIPK0zBTRA6x5s%3D"}，"retCode": "0"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False 用户标识，与tokenByAkSk接口请求参数中的app_key一致 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callSerialNo string True 呼叫流水号 长度限制：string（50）

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: {"callSerialNo": "645735364434067472"} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"retMsg": "Query call state successfully","retCode": "0","result": {"caller": "88889050","called": "88889060","callerPresent": "640003","startTime": 1621823865000,"state": 3,"reasonCode": 0,"agentPresent": "640060","endTime": 1621823872000}}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 0 ：成功，其他为失败 1 ：查询状态失败 3 ：呼叫流水号格式不符 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 state number False 呼叫状态： 0：待呼叫 1：正在呼叫 2：通话中 3：通话结束 长度限制：number（1） 1.3.2 reasonCode number False 通话结束原因码： 0~65535， 0: 通话结束，被叫挂机 1：通话结束，主叫关机 2：外呼主叫失败 3：外部被叫失败 4：外呼主叫无应答 5：外呼被叫无应答 6：启动呼叫失败 xxx：其他异常 长度限制：number（5） 针对ITA双呼还有一些reasonCode，请参见表4 1.3.3 callData string False 第三方自定义的呼叫数据信息 长度限制：string（1024） 1.3.4 caller string False 主叫号码 长度限制：string（32） 1.3.5 called string False 被叫号码 长度限制：string（32） 1.3.6 startTime string False 外呼开始时间，时间戳，如1572794607000 1.3.7 endTime string False 通话结束时间，时间戳，如1572794607000 1.3.8 callerPresent string False 外显号码，来电显示的号码 长度限制：string（32） 1.3.9 agentPresent string False 外显号码，客户经理来电显示的号码 表4 针对ITA双呼的reasonCode说明 retCode 原因值描述 0 不涉及 1 无法找到号码 2 无法路由到网络 3 无法路由到目的地 4 发送特殊消息 5 中继前缀出错 6 通道无法接入 7 已经建立频道 8 抢先占有 9 抢先占有保留 16 正常呼叫清除 17 用户忙 18 无应答 19 无用户应答 20 用户不可及 21 拒绝呼叫 22 号码已改变 23 重定向 25 交换路由错误 26 无用户准许 27 目标无序 28 非法号码格式 29 设备拒绝 30 状态查询 31 正常 34 路由不可达 38 网络状态不好 39 服务链接不上 40 链接进行中 41 暂时失败 42 设备拥塞 43 信息丢弃 44 通道无法接入 46 呼叫阻塞 47 无可用资源 49 品质无效 50 设备没预订 53 闭合群OCB呼出受限 55 闭合群ICB呼入受限 57 无权限发送 58 发送无效 62 等级不一致 63 服务无效 65 发送无法执行 66 通道无法执行 69 设备无效 70 发送有效 79 CV服务没设置 81 引用非法值 82 通道不存在 83 ID不存在 84 呼叫ID不存在 85 无呼叫等待 86 隐藏号码呼叫 87 CUG无成员 88 目标冲突 90 CUG不存在 91 无效网络 95 无效信息 96 非托管元素 97 类型不存在 98 信息没执行 99 信息单元不存在 100 无效的信息单元 101 呼叫状态不一致 102 定时器超时 103 参数不存在 110 消息中带有未识别的参数 111 协议错误 127 未指定的交互 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callSerialNo string True 呼叫流水号 长度限制：string（50）

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 返回码。0表示成功，其他为失败。 4：获取不到被叫标示 5：被叫未配置标示 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 devType number False 设备类型: 0：技能队列； 1：号码 长度限制：number (4) 1.3.2 called string False 被叫号码 长度限制:string(32) 1.3.3 skillId number False 技能队列 长度限制：number (16) 1.3.4 skillName string False 技能队列名称 长度限制：string(64) 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：样例报文 请求头： x-app-key:9******************************3 Authorization:Bearer 9******************************7 Content-Type:application/json 请求参数: {"caller": 8888888，"called": 6666614} 响应参数: {"retMsg": "Called is not configured"，"retCode": "5"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 called string True 被叫号码 长度限制:string(32) 1 caller string True 主叫号码 长度限制:string(32)

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 limit string False 分页查询时单页最多的记录条数，默认值100，即每页显示100条，非必选 1 offset string False 分页查询偏移量，默认值0，即不需要偏移，非必选

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 返回码。0表示成功，其他为失败。 1：查询失败 2：移动座席信息为空 3：注册服务地址或端口为空 4：limit或offset分页数据为空 5：虚拟呼叫中心信息为空 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 total number False 总记录数 1.3.2 singleRegServ array[object] False single模式 1.3.2.1 regIPAddress string False 注册地址 长度限制：string（50） 1.3.2.2 regPort string False 注册端口 长度限制：number（5） 1.3.3 poolRegServ object False pool模式 1.3.3.1 node1 array[object] False 节点1 1.3.3.1.1 regIPAddress string False 注册地址 长度限制：string（50） 1.3.3.1.2 regPort string False 注册端口 长度限制：number（5） 1.3.3.2 node2 array[object] False 节点2 1.3.3.2.1 regIPAddress string False 注册地址 长度限制：string（50） 1.3.3.2.2 regPort string False 注册端口 长度限制：number（5） 1.3.4 phone array[object] False 软电话信息列表 1.3.4.1 phoneNum string False 软电话号码 长度限制：string（32） 1.3.4.2 password string False 软电话密码 长度限制：string（50） 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：样例报文 请求头: x-app-key:2******************************8 Authorization:Bearer e******************************5 Content-Type:application/json 请求参数: {"offset": 0，"limit": 3} 响应参数: {"retMsg": "successfully"，"retCode": "0"，"result": {"total": 2，"regPort": "5060"，"phone": [{"phoneNum": "88881196"，"password": "****"}， {"phoneNum": "88881197"，"password": "****"}]，"regIPAddress": "10.162.98.43"}}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 workNo number True 座席工号

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string True 操作结果。0：成功，非0为失败 1.2 description string False 提示信息 1.3 restTime string False 休息时长，单位秒 1.4 agentType string False 座席类型（4：音频座席，5：多媒体座席，11：视频座席，99：全能型座席） 1.5 forceLogin boolean False 是否强制签入（true：是，false：否） 1.6 isAutoAnswer string False 是否自动应答（true：是，false：否） 1.7 videoMode number False 视频应用模式（0：SFU视频，1：MCU视频，2：SFU+MCU视频） 1.8 workNo number False 座席工号 1.9 isMultiChannelSupport boolean False 是否多渠道签入（true：是，false：否） 1.10 skills array[object] False 技能队列列表 1.10.1 skillId number False 技能队列ID 1.10.2 mediaTypeId string False 媒体类型（5：语音；53：多媒体；19：视频；2：语音点击通话；18：视频点击通话） 响应状态码: 401 鉴权失败 响应状态码: 404 请求资源不存在 响应状态码: 500 服务器内部异常

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:*********************Authorization:Bearer ********************* 请求参数: {"phone":"13800000000"，"workNo":107} 响应参数: { "restTime": ""， "agentType": "4"， "forceLogin": true， "isAutoAnswer": "true"， "description": "success"， "videoMode": 0， "workNo": 107， "skills": [ { "skillId": 4， "mediaTypeId": "5" } ]， "returnCode": "0"， "isMultiChannelSupport": false}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 phone string True 进行接听的号码（真实可用的号码，比如手机号、座机号） 1.2 workNo number True 座席工号

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 workNo number True 座席工号

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:*********************Authorization:Bearer ********************* 请求参数: {"workNo":107} 响应参数: { "returnCode": "0"， "data": false， "description": "success"}

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

响应说明 响应状态码: 200 表4 applyTokenRspBody参数结构 序号 名称 参数类型 是否必选 说明 1.1 token string True 生成的token，后续发起其他请求时，需在Header中将该值赋给ccmessaging-token。 说明： 该Token有1小时有效期，如果系统返回鉴权失败（401）时，需要重新使用applyToken获取新Token。 在会话期间内，Token失效，AICC会自动在当次请求时返回新Token，企业需要自行在Header中更新ccmessaging-token的取值。 1.2 resultCode string True 结果码 0：成功 1：失败 1.3 resultDesc string False 结果描述 当前暂时没有返回。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：查询排队信息 请求头： ccmessaging-token: xxxxx-app-key: xxxxAuthorization: Bearer xxxxContent-Type: application/json 请求参数： { "userId": "xxxx"， "channelConfigId": "xxxxx"， "channel": "WEB"} 响应参数： { "totalWaitTime": 3， "resultCode": "0"， "longestWaitTime": 3， "position": 1， "currentDeviceWaitTime": 3， "configMaxcWaitTime": 60， "estimateWaitTime": 60}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string False applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string False appKey字段，用户标识，在API Fabric上配置 3 Authorization string False 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody ReqBody True 请求体 表3 ReqBody参数结构 序号 名称 参数类型 是否必选 说明 1.1 userId string True 客户的唯一标识 1.2 channelConfigId string True 渠道配置id 1.3 channel string True 渠道类型

响应说明 响应状态码: 200 表4 RspMsg200参数结构 序号 名称 参数类型 是否必选 说明 1.1 position integer False 本呼叫在队列中的位置 1.2 totalWaitTime integer False 本呼叫累计排队时长（秒） 1.3 currentDeviceWaitTime integer False 当前技能队列的实际等待时长（秒） 1.4 configMaxcWaitTime integer False 配置的最大等待时长（秒） 1.5 longestWaitTime integer False 队列中正在排队呼叫的最大排队时长（秒） 1.6 estimateWaitTime integer False 对应队列的预估呼叫等待时长（秒） 1.7 resultCode string True 查询排队信息返回码。具体错误码信息如下： 0：正在排队，查询成功。 1：参数错误。 2：CCU CS 服务地址错误。 3：Token错误。 4：未知错误。 5：会话已结束。 160021：当前会话已经转到座席，不在排队状态。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string True appKey字段，用户标识，在API Fabric上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 satisfication satisficationInfo True 满意度评价信息 表3 satisficationInfo参数结构 序号 名称 参数类型 是否必选 说明 1.1 channel string True 渠道类型，当前固定为WEB。 1.2 userId string True 用户ID 1.3 evaluation string True 满意度等级（1-5） 1.4 comment string True 满意度评价语信息，小于512字符 1.5 channelConfigId string True 渠道ID，即在AICC侧配置的WEB渠道的“配置ID”。

响应说明 响应状态码: 200 表4 RspMsg参数结构 序号 名称 参数类型 是否必选 说明 1.1 resultCode string True 响应返回码 0：成功 13：呼叫信息获取失败，或提交满意度结果失败。 1.2 resultDesc string False 响应返回描述 如果响应码为0，返回可能是“Save satisfaction success!” 有时也会返回“Exception appeared!” 如果响应码为13，则返回“The callIdString obtained failed!”或“Save satisfaction failed”。 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求参数: {"fileType": "jpg"，"channel": "WEB"，"fileStream": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIp3+7j8a/PP/gqXP5/7QXh9tu3/AIpi34z/ANPV3SpXfxCP/9k="} 响应参数: {"returnCode": "0"，"objectKey": "44992392******************6cc328db296"}

响应说明 响应状态码: 200 表4 响应体参数结构 序号 名称 参数类型 说明 1.1 returnCode string 返回码。0：成功，非0表示失败，失败包括： 2：参数缺失 3：参数错误 13：上传失败 1.2 objectKey string 对象键 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string True appKey字段，用户标识，在API Fabric上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody ReqBody True 请求体 表3 ReqBody参数结构 序号 名称 参数类型 是否必选 说明 1.1 fileType string True 文件类型，支持jpg，png，bpm，mp3，aac，mp4，txt，csv。 1.2 fileStream string True Base64编码后的文件流。 1.3 channel string True 发送文件流渠道，当前只支持WEB。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口返回的token值。 会话过程中接口Response Header中返回的ccmessaging-token的值。 2 x-app-key string True appKey字段，用户标识，在API Fabric工具上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody ReqBody True 请求体 表3 ReqBody参数结构 序号 名称 参数类型 是否必选 说明 1.1 fileId string True 文件下载的fileId，在poll接口中携带 fileId取值 "local/" + content（poll接口响应）时，判定为发送本地文件。 1.2 channel string True 下载渠道类型，当前固定为WEB。 1.3 fileType string True 下载的文件类型，支持jpg，png，bpm，mp3，aac，mp4，txt，csv，richtext。 发送本地文件场景下，该参数为多媒体文件下行消息中mediaFileType字段 1.4 multiMedia string False 如果文件为多媒体库文件时，该参数必填，并且需要配置为“multiMedia”。

报文样例 场景描述： 请求参数: {"fileType": "jpg"，"channel": "WEB"，"fileId": "XXXXXXXXXXXXXXXX" "multiMedia":"multiMedia"} 响应参数: {"fileStream": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wAARCAA9ADwDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcI"}