华为云用户手册

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 2 x-app-key string True appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 moduleId string True 模块ID 人工外呼：80031 自动外呼：80081 智能实训：80083 2 result string True 对答卷进行的操作。 save：保存（创建）答卷 submit：提交答卷 3 surveyId string True 问卷ID 4 custId string False 用户ID 5 serviceId1 string False 问卷对应的任务ID

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 totalCount int 外显结果的总数量。 4 data List 外显结果列表。 5 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 6 returnDesc String 描述。 表4 data 序号 参数名 参数类型 说明 1 displayResult String 外显结果。 2 resultCode String 外显结果码。 3 defId String 外显结果ID。

报文样例 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "displayResult": "就是不接电话6", "resultCode": "002", "defId":"12345" } ], "resultCode": "0200000", "resultDesc": "query outboundResult success", "totalCount": 1, "returnDesc": "query outboundResult success" }

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

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResults?pageSize={pageSize}&pageNum={pageNum} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 pageSize int True 页容量取值范围1-50。 3 pageNum int True 页码，取值范围大于0。

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

报文样例 请求头: { "x-app-key": ******************** "Authorization": Bearer ************************ } 请求参数: { "questionAnswerId": "123456789", "answerText": "你好", "voiceScore": 50.00, "operScore": 20.52, "costTime": 12 } 响应参数: { "resultCode": "1203000", "resultDesc": "Opration Successful." }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 x-app-key string True appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 questionAnswerId String True 问题答案ID 2 answerText String False 答案内容 3 voiceScore DECIMAL (11，2) False 语音得分 4 operScore DECIMAL (11，2) False 操作得分 5 costTime int False 问题耗时，单位：秒。

请求消息 消息头 表1 消息头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。 消息体 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 说明 1 serverId string True CTI平台已存在的订阅任务的编号，也就是订阅注册时CTI平台返回给第三方业务客户端的订阅任务编号。 不能设置为空或空白字符串。

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

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

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string False 0：成功，其他为失败 1 ：添加外呼任务失败，外呼数据库中可能已存在相同外呼任务 2 ：呼叫数据信息 3 ：未查询出呼叫流水号字段 5 ：主被叫或外显号码格式不符 6 ：VDN不可用 8 ：主叫号码不在租户所分配的移动座席使用的软电话号码范围内 16 ：试用租户的座席侧号码未在白名单内 21 ：试用租户一键双呼超过每天10次限制 针对ITA双呼还有一些retCode，请参见表4 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo string 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 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 caller string False 主叫号码，客户经理手机号码，或是软电话号码 长度限制：string（32） 1.2 softPhone string True 软电话号码（座席对应） 长度限制：string（32） 1.3 called string True 被叫号码 长度限制：string（32） 1.4 callData string False 呼叫数据 长度限制：string（1024） 说明： ITA双呼不支持callData字段。 1.5 callerPresent string False 用户侧主叫显示号码，用户看到的主叫号码，不携带的情况下默认采用租间的接入码，携带的情况下该号码必须传接入码。如果需要传非接入码号码，请联系运维人员开通主叫透显特性，该特性开通后号码校验规则为：接入码或者11-14位的数字。 说明： ITA双呼不支持callerPresent字段。

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

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 查询成功后，返回座席当前呼叫统计信息对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 talktime long 当日总通话时长，单位：s。 3.2 answernums int 当日后接听次数 3.3 calloutnums int 当日后外呼次数

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

响应参数 名称 是否必选 参数类型 长度 说明 errorMsg False String 512 错误信息 errorCode False String 20 错误码 intentsResponses False Intents[] - 意图数组，成功时必须返回。 nonce False String 128 token认证失败时返回，服务端随机生成的字符串，同时需要返回状态码401。 表3 Intents 名称 是否必选 参数类型 长度 说明 responses False String[] 4096 Chatbot返回的应答信息，字符串数组，可以有多个。 confidence True float 4 置信度 机器人回复的可靠度，取值范围０～１，最小值是０，最大值是１，例如基于你的一个问题1，有10个回答，其中6个回答是相同的Answer１，那么Answer１的置信度是0.6 commands True String[] 64 意图命令字 params False Map - 命令字参数信息，一般意图的槽位信息都通过这个返回。例如{"Number":"3"}。 一般意图操作具体详情参考添加意图模板章节。 scenarioName False String 64 意图名 scenarioType False int 4 场景类型，辅助场景=1， 业务场景=0， 无场景= -1 scenarioStatus False String 64 场景状态（暂不使用）

报文样例 请求样例 { "request": { "sentence":"查询3月账单"， "targetIntentCount":1， "confidence2Top":0.2， "accessCode":"10086"， "channel":"OIFDE"， "tenantId":"NJ_001"， "language":"zh_CN"， "userId":"123456789" } } 响应成功样例：

请求说明 表1 请求体参数 名称 是否必选 参数类型 说明 request True requestBody 请求体 表2 requestBody 名称 是否必选 参数类型 长度 说明 userId True String 64 用户ID accesscode False String 32 接入码（用户通过拨打什么号码接入的） channel False String 32 渠道（目前固定填OIFDE） sentence True String 1024 客户输入的文本信息 tenantId True String 64 租户ID language True String 20 语言 中文：zh_CN 英文：en_US context False String 64 意图识别需要的上下文 targetIntentCount False int 4 需要chatbot返回多个意图时的意图数量，一般用于客户输入一句话可以匹配多个意图的情况 范围：1——5 confidence2Top False float 4 置信度间距 如果返回多个意图，要求后面的意图与第一个置信度最高的意图的置信度间距，这个值越小表示返回的意图越接近。 范围：0——1 timeZone False String 10 时区，8表示东8区。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170 } 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "agentId": 1086, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601086", "realFlag": 1 }, { "agentId": 1087, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601087", "realFlag": 1 } ], "resultDesc": [ { "agentId": 1086, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601086", "realFlag": 1 }, { "agentId": 1087, "groupId": -1, "rights": "[1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]", "name": "HW285601087", "realFlag": 1 } ] }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求消息体参数说明 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围：1～65535 2 vdn int True 虚拟呼叫中心编号。 取值范围：1～5000

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 agentId int 座席工号 2.2 groupId int 所属班组ID。 班组：为了方便对业务代表进行管理，通常对虚拟呼叫中心的业务代表进行分组。分为一组的业务代表形成一个班组。 2.3 rights string 座席的权限值。0表示没有权限，1表示有权限。角色权限位说明如表5 2.4 name string 座席姓名 2.5 realFlag int 是否为网络座席。取值：0表示网络座席，1表示普通座席。AICC当前均为普通座席 表5 座席权值 位数 描述 1 示忙/示闲 2 静音/结束静音 3 保持/取保持 4 连接保持 5 普通呼出 6 内部呼叫 7 内部转移 8 接转接来话 9 三方通话 10 转出 11 人工转移自动 12 不接来话 13 监听/监听插入/耳语 14 拦截 15 强制签出/强制示忙/强制示闲 16 质检录音/质检放音 17 质检监视 18 考评管理员 19 普通考评员 20 告警台 21 报表处理员 22 未使用，平台保留值 23 监控台 24 配置管理员 25 报表管理员 26 国内长途呼出 27 国际长途呼出 28 本呼叫中心接入码呼出 29 全屏质检 30 同组代答 31 未使用，平台保留值 32 配置业务代表 33~256 未使用，平台保留值

响应说明 表5 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 serverId String 生成文件服务ID 全局唯一 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表6 5 returnDesc String 描述。

错误结果码 表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。 2 port String True port 3 filePath String True 文件服务器默认路径 示例：/home/sftp

错误结果码 表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 参数个数不能大于规定个数

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

接口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。