华为云用户手册

报文样例 场景描述：修改静默规则信息 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "exception": { "before": { "staff": ["14161"], "customer": [] }, "after": {} }, "setting": { "score": 4, "seconds": 5, "times": 4, "silence_id": "922988537635147776", "other": { "call_end": 1624430285, "call_from": 1623911884 }, "name": "test35444" } } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功" }

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

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": { "agentcustomstate": "65535" }, "message": "success", "retcode": "0" }

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/forcerest/{workNo}/{time}/{reason} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 workNo string True 指定座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。 3 time long True 休息时长，单位：秒，取值范围：1-86399。 4 reason int True 休息原因码，取值范围：1-255。

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: { "caller": "88889050", "called": "88889060", "agentWorkNo": "", "callerPresent": "640003", "agentPresent": "640060", "callData": "333333" } 响应头: { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数: { "result": { "callSerialNo": "1771078210739978242" }, "retCode": "0", "retMsg": "Created successfully." }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 caller string True 主叫号码，客户经理手机号码，或是软电话号码 长度限制：string（32） 2 called string True 被叫号码 长度限制：string（32） 3 agentWorkNo decimal False 发起双呼的座席的工号。 长度限制：decimal（5） 4 callData string False 呼叫数据 长度限制：string（1024） 说明： ITA双呼不支持callData字段。 5 callerPresent string False 用户侧主叫显示号码，用户看到的主叫号码，不携带的情况下默认采用租间的接入码，携带的情况下该号码必须传接入码。如果需要传非接入码号码，请联系运维人员开通主叫透显特性，该特性开通后号码校验规则为：接入码或者11-14位的数字。 说明： ITA双呼不支持callerPresent字段。 6 agentPresent string False 座席侧主叫显示号码，客户经理看到的主叫号码，不携带的情况下默认采用租间的接入码，携带的情况下该号码必须传接入码。如果需要传非接入码号码，请联系运维人员开通主叫透显特性，该特性开通后号码校验规则为：接入码或者11-14位的数字。 说明： ITA双呼不支持agentPresent字段。 7 callBackUrl string False 此参数请采用BASE64编码进行加密。 此字段用于设置客户接收状态上报的挂机回调URL。 云客服CEC平台将业务触发过程中通话的状态信息推送至此服务器，客户服务器根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或 域名 ，推荐使用域名，支持http和https。http为不安全协议，请谨慎使用。且该域名对应多个服务器，避免单点故障无法接收通知。 URL只能由大小写字母（a-z、A-Z），数字（0-9）， - : . / _ # ? &组成，不支持其它字符。 回调URL的域名或IP端口已通过系统管理员加入手机客服回调的地址白名单中。 须知： 如果入参callBackUrl不生效，可能是因为您所在的云客服环境接口未正常升级，请联系运管理员确认当前的发布态的API名称是否为createCall_kugui，如果不是，则暂时不能使用callBackUrl入参。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 0：成功，其他为失败 1 ：添加外呼任务失败，外呼数据库中可能已存在相同外呼任务 2 ：呼叫数据信息 3 ：未查询出呼叫流水号字段 5 ：主被叫或外显号码格式不符 6 ：VDN不可用 8 ：主叫号码不在租户所分配的移动座席使用的软电话号码范围内 9 ：callBackUrl不符合条件 16 ：试用租户的座席侧号码未在白名单内 21 ：试用租户一键双呼超过每天10次限制 针对ITA双呼还有一些retCode，请参见表4 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo number False 呼叫流水号 表4 针对ITA双呼的retcode说明 retcode retMsg 说明 90100100 Invalid Input Parameter 请求报文不正确。如缺少参数或者不支持的参数 90100200 Auth Failed 请求的来源或者请求的签名未通过校验 90100300 Bad Request 错误请求 90100400 Not found 请求资源不存在 90100600 Internal Server Error 系统内部错误 90102001 Insufficient Balance 额度不足 90102002 Request Restriction 请求限制 90104001 Insufficient Permission 权限不足 90104003 Request Forbidden 请求被禁止 90104004 Service Unavailable 不支持的业务功能或者未实现 90104008 Service Process Failure 业务处理超时或者处理失败 90104029 Too Many Requests 请求过多 90106001 Binding relationship already exists 小号绑定关系已存在 90106002 Binding relationship not exists 小号绑定关系不存在 90106003 Insufficient Number resources 小号号码池资源不足 90106004 No corresponding number found 未找到可用小号 90106005 Inconsistent binding data 小号绑定数据不一致 90106006 Other Error 小号其他原因导致错误 90106010 Policy Forbid 策略禁止 90106011 Caller Forbid 主叫限制 90106012 Callee forbid 被叫限制 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

监视座席通知事件 表示符 QC_AgentState_Notify 作用 表示某个座席的监视（质检）事件。 附带信息 agentname：表示座席工号或用户名。 subtype：子类型，表示被监视座席的状态或操作。 示例： {"eventType":"QC_AgentState_Notify","workNo":"107","content":{"subtype":"QC_AgentState_Login","monitoredagent":"108","agentname":"108","mediaserver":"CtiServer","jsonKey":["subtype","monitoredagent","agentname","mediaserver"]},"jsonKey":["eventType","workNo","content"]} 其中subtype的类型有： QC_AgentState_Login:监视座席签入事件 QC_AgentState_Logout:监视座席签出事件。 父主题： 实时质检事件

报文样例 场景描述：第三方请求鉴权 请求头： X-APP-Key: b*************c7b Authorization: Bearer 1fea*************1d6a15 Content-Type: application/json 请求参数： { "userId": "XXXXXXXXX", "userName": "XXXXXXXX", "channelId": "XXXXXXXXXXXX", "locale": "zh" } 响应参数： { "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" }

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

请求说明 表1 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String（1-32） True 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 billFileName String（1-49） True 无 话单和录音索引文件名称，已调用“生成话单和录音索引”获取。 格式：yyyyMMdd_{responseId}.zip。 例如：已调用“生成话单和录音索引”接口，调用“生成话单和录音索引”接口的日期为2018-07-02，获取到的录音索引responseId为9239cb50a8384bb0ab503441bf08944，则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成话单文件，文件后缀名为.zip，文件中各参数定义参考话单录音索引文件定义，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表4，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象，参数说明详见表5 不推荐使用，为兼容老版本保留字段。 表5 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码。 4.3 resultMsg String 请求结果描述。

报文样例 请求头 POST /CCFS/resource/ccfs/downloadBillFile HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:43:08Z/content-length;content-type;host /ae066c2f5d******************13a0afc161cb7e66f5d Accept: */* Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "billFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip" } }

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "workNo": "49999", "skills": [ 10, 25 ] } 响应参数 { "message": "", "retcode": "0", "result": {} }

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

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "agentIds":[1032,1099], "indexIds":["IDX_AGENT_PHONE","IDX_AGENT_CURRENT_STATE","IDX_DURATION_AGENT_CURRENT_STATE","IDX_AGENT_ LOG IN_SKILLS"] } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": "88880103", "id": "IDX_AGENT_PHONE" }, { "val": 7, "id": "IDX_AGENT_CURRENT_STATE" }, { "val": 17728, "id": "IDX_DURATION_AGENT_CURRENT_STATE" }, { "val": [ 3 ], "id": "IDX_AGENT_LOGIN_SKILLS" } ], "id": 1032 }, { "idxs": [ { "val": "88881609", "id": "IDX_AGENT_PHONE" }, { "val": 1, "id": "IDX_AGENT_CURRENT_STATE" }, { "val": 1414, "id": "IDX_DURATION_AGENT_CURRENT_STATE" }, { "val": [ 2, 4 ], "id": "IDX_AGENT_LOGIN_SKILLS" } ], "id": 1099 } ], "resultDesc": [ { "idxs": [ { "val": "88880103", "id": "IDX_AGENT_PHONE" }, { "val": 7, "id": "IDX_AGENT_CURRENT_STATE" }, { "val": 17728, "id": "IDX_DURATION_AGENT_CURRENT_STATE" }, { "val": [ 3 ], "id": "IDX_AGENT_LOGIN_SKILLS" } ], "id": 1032 }, { "idxs": [ { "val": "88881609", "id": "IDX_AGENT_PHONE" }, { "val": 1, "id": "IDX_AGENT_CURRENT_STATE" }, { "val": 1414, "id": "IDX_DURATION_AGENT_CURRENT_STATE" }, { "val": [ 2, 4 ], "id": "IDX_AGENT_LOGIN_SKILLS" } ], "id": 1099 } ] }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明 参数名 数据类型 是否必选 说明 ccId int True 呼叫中心编。 取值范围：1～65535 vdn int True 虚拟呼叫中心编号。 取值范围：1～5000 agentIds array True 座席工号的数组，最大数组长度为100。 取值范围：101-59999 indexIds array True 指标的数组。数组最大长度为座席实时监控指标的个数，当前不大于4。 该对象的参数说明请参见表2

响应消息 表3 消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 表4 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 id int 座席工号。 idxs array 指标结果集。 该对象的参数说明请参见表5 表5 idxs对象参数说明 参数名 数据类型 说明 id string 指标ID。 val object 指标结果。 该对象的参数说明请参见表2

报文样例 场景描述：删除对话逻辑 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "flow_id": "871578307970207744" } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功" }

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 flow_id string True 对话逻辑标识

接口URI https://ip:port/agentgateway/resource/recordplay/{agentid}/backfast/{time} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 time string True 快进的时长，单位为秒（s），取值范围：0~2147483647。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "callid":"1552524689-16797284", "userType":"user" } 响应参数 { "message": "success", "retcode": "0" }

接口URI https://ip:port/agentgateway/resource/mediacall/{agentid}/imagecapture 其中，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 userType string True 用户类型。 默认为“user”代表用户 2 callid string True 呼叫标识。

自己离开会议事件 标示符 AgentConf_SelfLeaveResult 作用 表示当前座席离开会议。 附带信息 confId表示会议ID。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentConf_SelfLeaveResult","workNo":"153","content":{"confId":1030400}}} 父主题： 座席会议事件

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 call_time number False 通话时间 1.2 call_type number True 通话文件类型 1.3 file_name string True 上传文件名 1.4 staff_id string False 座席人员的userId 可在登录后，进入座席管理页面，查看接口返回的accountId 1.5 staff_name string False 座席姓名

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

报文样例 场景描述：创建质检任务。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "call_type": 0, "staff_name": "0", "staff_id": "0", "file_name": "helloworld123456" } 响应参数: { "call_uuid": "434l2j4242424jjl242" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string True 接口返回码 2 resultDesc string True 接口返回消息描述。 3 questionId string True 题目ID 4 answerNo int True 题目编号 5 optionIdList array[object] True 题目选项，当题目类型为选择题时有值 6 questionType string True 题目类型 single：单选题 multi：多选题 essay：简答题 voice：语音 voiceOperation：语音+操作 7 content string True 题目内容 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。