华为云用户手册

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200033 外呼数据不存在。 3 0200034 子状态与业务结果不匹配。 4 02000005 参数长度超过指定范围 5 02000001 参数值为空 6 02000002 参数包含非法字符 7 02000003 参数长度不能大于规定长度 8 02000004 参数长度不能小于规定长度 9 02000005 参数长度需要介于规定长度之间 10 02000006 参数值类型不正确 11 02000007 参数值大小不正确 12 02000008 参数转换异常，请检查请求参数 13 02000009 参数组合不正确，请检查请求参数 14 02000010 hour和minute必须同时存在

报文样例 该接口的请求消息体举例如下： { "userName":"zhangsan", "serverInfo":{ "ip":"1.2.3.4", "port":"22", "filePath":"/home/sftp" }, "serverPwd":"******" } 该接口的响应消息体举例如下： { "resultCode": "02000005", "description": " 参数长度需要介于8和80之间" }

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/addServer 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 serverInfo JsonObject True 文件服务器信息。 2 userName String True 用户名 3 serverPwd String True 服务密码，明文传递，后台密文保存 表4 serverInfo参数说明 序号 参数名 参数类型 是否必选 说明 1 ip String True 文件服务器IP。客户自备ip地址。 2 port String True port 3 filePath String True 文件服务器默认路径 示例：/home/sftp

响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 4 returnDesc String 描述。 5 successCount int 成功数量

错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动不存在。 4 0200028 当前状态不允许删除号码。 5 0200030 时间格式不正确。 6 02000001 参数值为空 7 02000002 参数包含非法字符 8 02000003 参数长度不能大于规定长度 9 02000004 参数长度不能小于规定长度 10 02000005 参数长度需要介于规定长度之间 11 02000006 参数值类型不正确 12 02000007 参数值大小不正确 13 02000008 参数转换异常，请检查请求参数 14 02000009 参数组合不正确，请检查请求参数 15 02000010 hour和minute必须同时存在 16 02000011 参数个数不能大于规定个数

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/delete 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动的ID。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 sessionId String False 标识用户的ID，外呼结果中会回传用户。 最大长度为32个字符。 2 called String False 被叫号码。 最大长度为24个字符，有效字符为：0~9、*、#。 3 customField String False 用户自定义字段，删除时可根据该字段批量删除，最大长度为200个字符。 4 recycleTime String False 回收时间，格式为yyyy-mm-dd hh:mm:ss。 5 recycleType String False 回收类型。只在传入recycleTime的同时传入，该参数有效。 取值范围： 1：删除早于传入的recycleTime（精确到天）的外呼号码。 例如，传入2020-12-04 17:57:00，会将指定外呼活动下，recycleTime在12月4日及以前的外呼号码都删除 2：删除传入的recycleTime当天的外呼号码。 例如，传入2020-12-04 17:57:00，会删除指定外呼活动下，recycleTime在2020-12-04 00:00:00到2020-12-04 23:59:59之间的外呼号码 3：删除与传入的recycleTime相等的外呼号码。 6 archiveHistory int False 是否移历史表。 取值范围：0，1。 0：不移历史表，直接删除。1：移入历史表。默认为0。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":1, "callId":"1453723531-574" } 响应消参数： { "result": "0", "resultCode": "0100000", "resultDatas": { "time": 1606115215000, "dsn": 0, "handle": 0, "server": 0, "keyId": "", "callingNum": "88881364", "calledNum": "650550", "mid": 5, "trunkNo": 582, "priority": 0, "deviceType": 2, "deviceNo": 1177, "callSkill": "defaultAudioSkill", "partyNum": 1, "callFeature": 0, "orgiCalledNum": "", "mediaType": 5, "place": 0, "waitTime": 0, "totalTalkingTimes": 275, "logonTimes": 284, "serviceType": 2, "callInCause": 65535, "enterReason": 0, "mediaBillType":0 }, "resultDesc": { "time": 1606115215000, "dsn": 0, "handle": 0, "server": 0, "keyId": "", "callingNum": "88881364", "calledNum": "650550", "mid": 5, "trunkNo": 582, "priority": 0, "deviceType": 2, "deviceNo": 1177, "callSkill": "defaultAudioSkill", "partyNum": 1, "callFeature": 0, "orgiCalledNum": "", "mediaType": 5, "place": 0, "waitTime": 0, "totalTalkingTimes": 275, "logonTimes": 284, "serviceType": 2, "callInCause": 65535, "enterReason": 0, "mediaBillType":0 } }

响应消息 表3 消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDatas Object 查询成功后，返回结果信息的对象。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc Object 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表4 表4 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 time Date 呼叫进入平台的时间。单位为毫秒。 dsn int 标识呼叫的任务号。 handle int 呼叫任务的控制块被循环使用的次数。 server int 处理呼叫的媒体服务器的标识。 keyId string 呼叫的唯一标识 callingNum string 主叫号码 calledNum string 被叫号码 mid int UAP模块号 trunkNo int 中继号 priority int 用户级别 deviceType int 正在处理的设备类型，请参见表1 deviceNo int 正在处理的设备编号。 对于业务代表设备来说，设备号即为业务代表工号。 对于队列或虚设备，设备号即为在配置台上配置的队列ID号或虚设备对应的网络共享设备ID号 对于其他设备类型，均为内部标识号 callSkill int 技能队列描述 partyNum int 呼叫轨迹经过的设备数目 callFeature int 呼叫特征，请参见表1 orgiCalledNum int 原始被叫 呼叫在进入系统前被叫发生变化，则该参数记录的是首次被呼叫方的号码。 mediaType int 媒体类型，请参见表1 place int 用户所在的位置（呼叫进入的地点） waitTime long 排队等待时间 totalTalkingTimes long 通话时长 logonTimes long 进入总时长 serviceType int 业务类型 callInCause int 呼入原因 enterReason int 进入本设备的原因，请参见表1 mediaBillType string 多媒体报表类型。

请求说明 表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 callId string True 呼叫callId，最大长度20。 参数值为时间戳-呼叫编号，其中时间戳为呼叫开始时间，必须为毫秒级时间戳。 例如：1659513159000-546750

接口URI https://ip:port/agentgateway/resource/recordplay/{agentid}/record 其中，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 fileName string False 录音文件存储路径（最大长度为100，可为空）。 不传或为空时，系统自动生成，格式如下： 盘符：\VDN号\媒体类型编号\年月日\工号\文件名+后缀 其中盘符可以由basic.properties中MAPPINGDISK配置项配置，不配置时默认为“Y” 2 mediaType int True 被录制的媒体类型，目前只能填写5，普通语音 3 recordMode int False 录制的方式 0:覆盖方式 1:追加方式 当不传参或传入参数为其他值时，默认为0 4 recordFormat int False 录制的文件格式 0: 按资源侧缺省配置格式播放，语音缺省文件格式，在录音资源侧配置 1: 24KVOX语音文件 2: 32KVOX语音文件 3: 64KALAW语音文件 不传参时，默认为0 说明： 一套环境中，只能使用一种录音格式，不能在不同的呼叫中设置不同的录音格式。 下发的录音格式，需要与UAP上配置的放音格式保持一致。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "fileName": "Y:/15/0/20201119/186/142702.V3", "mediaType": 5, "recordMode": 0, "recordFormat": 0 } 响应参数 { "result": { "taskId": "5086" }, "message": "success", "retcode": "0" }

报文样例 场景描述：终止质检任务。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "qualityTaskId": "16239241148860783173" } 响应参数: { "resultCode": "0409000", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0409000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 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.1 qualityTaskId number True 抽检任务ID

报文样例 请求头: 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）

响应说明 表2 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 0表示成功 非0表示失败 errorMessage String body True 错误描述 total long body False 总条数 transferRecordList transferRecord[] body False 返回转接记录列表（数组结构）

报文样例 请求消息样例 { "authToken": "P********************oN1ix", "tenantId": "202204017094", "beginTime":"2022-02-21 20:04:38", "endTime":"", "pageNum": "1", "pageSize": "5", "callId": "1648805538-165717321823298", "userMobile": "", "ctiCallId": "" } 响应消息样例 { "errorCode": 0, //接口成功失败标识 "errorMessage": "success!",//接口成功失败描述 "total": 1,//总数 "transferRecordList": [ { "id": "202204013156893697", "tenantId": "202204017094", "callId": "1648805538-165717321823298", "ctiCallId": "1648805538-1657", "flowInstId": "88880301202204011732186311648805538-165717321823298", "callingNumber": "88880301", "calledNumber": "30502", "transfNumber": "88880302", "startTime": 1648805539000, "endTime": 1648805558000, "recordFilePath": "Y:/61/transferrecord/20220401/77448039.wav", "locationId": "0", "opResult": "SUC CES S", "recordResult": "N/A" } ] }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID authToken String body True 访问接口的有效Token值。 有效Token信息通过 获取Token 接口获取。 请参见C3 智能助手平台接口鉴权方式。 beginTime String body False 开始时间 格式： yyyy-MM-dd HH:mm:ss endTime String body False 结束时间 格式： yyyy-MM-dd HH:mm:ss pageNum String body False 页码 分页查询,查询第几页,首页为1 不传,默认页码为1 pageSize String body False 每页多少条 可配置：5,10,20,50,100 不传,默认一页100条 callId String body False 流程呼叫ID (userMobile、callId和ctiCallId需要传其中一个) userMobile String body False 用户号码(userMobile、callId和ctiCallId需要传其中一个) ctiCallId String body False 平台呼叫ID (userMobile、callId和ctiCallId需要传其中一个)

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

报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: { "userId": "10gg000000y6OOrNaUFs" } 响应头: { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数: { "returnCode": "0", "returnDesc": "The AgentSettings delete successfully." }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 userId String True 用户id。 t_aicc_pub_appcube_user表中USER_ID的值。

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

报文样例 场景描述：根据ID查询静默规则详情 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "silence_id": "922988537635147776" } 响应参数: { "exception": { "before": { "staff": [{ "category_id": "894378237264662529", "sentence_id": "14161", "sentence_name": "意图名称demo1" }], "customer": [] }, "after": { "staff": [] } }, "resultCode": "0405000", "resultDesc": "操作成功", "setting": { "score": "-4", "seconds": "5", "times": "4", "silence_id": "922988537635147776", "other": { "call_end": 1624430285, "call_from": 1623911884 }, "name": "test35444" } }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 exception object False 例外设定 1.1.1 before object False 静默之前的例外设定 1.1.1.1 staff array[object] False 座席说的句子标识集合 1.1.1.1.1 category_id string False 句子分类标识 1.1.1.1.2 sentence_id string False 句子标识 1.1.1.1.3 sentence_name string False 句子名称 1.1.1.2 customer array[object] False 客户说的句子标识集合 1.1.1.2.1 category_id string False 句子分类标识 1.1.1.2.2 sentence_id string False 句子标识 1.1.1.2.3 sentence_name string False 句子名称 1.1.2 after object False 静默之后的例外设定 1.1.2.1 staff array[object] False 座席说的句子标识集合 1.1.2.1.1 category_id string False 句子分类标识 1.1.2.1.2 sentence_id string False 句子标识 1.1.2.1.3 sentence_name string False 句子名称 1.2 resultCode string False 返回码，0405000表示成功，其他表示失败 1.3 resultDesc string False 返回描述 1.4 setting object False 静默规则基本信息 1.4.1 score string False 规则分数 1.4.2 seconds string False 连续静默秒数 1.4.3 times string False 静默次数 1.4.4 silence_id string False 静默规则标识 1.4.5 other object False 触发条件 1.4.5.1 call_end number False 单通通话开始时间：填写时间戳，单位秒 1.4.5.2 call_from number False 单通通话结束时间：填写时间戳，单位秒 1.4.6 name string False 规则名称 响应状态码: 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 silence_id string True 静默规则标识