华为云用户手册

错误码参考 当接口调用报错时，会返回resultCode和resultDesc，举例如下： { "resultCode": "0100002", "resultDesc": "参数不合法" } 错误码 描述 0100000 接口调用成功 0100001 接口调用失败 0100002 参数不合法。 0100003 当前接口仅支持CTI的V3R8版本，检测到当前CTI版本是V3R6 0100999 未知异常 0101001 质检关系接口异常 0101002 查询的号码在uap不存在 0101003 权限不足 父主题： 附录

请求说明 表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 category_id string True 敏感词分类的唯一标识

报文样例 场景描述：删除敏感词分类的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "category_id": "923002229017808896" } 响应参数: { "resultCode": "0401000", "resultDesc": "操作成功" }

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

报文样例 请求头: Content-Type:application/json X-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 }

响应说明 响应状态码: 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 服务器内部异常

请求说明 表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 座席工号

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

报文样例 场景描述：修改语速规则 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** x-TenantSpaceId:202101124979 请求参数: { "exception": { "under": { "customer": ["11064"] }, "over": { "customer": ["11093"] } }, "setting": { "score": 3, "other": { "call_end": null, "call_from": null }, "min": 90, "max": 100, "name": "toofast", "speed_id": "849706874868600832" } } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功" }

请求说明 表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 setting object True 基本信息 1.1.1 name string True 语速规则名称 1.1.2 score number True 违规扣分数0-100（包含0和100） 1.1.3 min number True 语速最小限制1-220（每分钟的字数） 1.1.4 max number True 语速最大限制1-2147483647（每分钟的字数） 1.1.5 other object False 触发条件（满足开始结束时间时触发） 1.1.5.1 call_from number False 通话发生开始时间（毫秒数） 1.1.5.2 call_end number False 通话发生结束时间（毫秒数） 1.1.6 speed_id string True 语速规则ID 1.2 exception object True 例外设置信息 1.2.1 under object True 语速低于最小限制时，客户有说出以下句子 1.2.1.1 customer array False 客户说的句子id 1.2.2 over object True 语速大于最高限制时，客户有说出以下句子 1.2.2.1 customer array False 客户说的句子id

响应说明 表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 当日后外呼次数

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

接口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 } ] }

响应消息 表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 未使用，平台保留值

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

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 callid string False 呼叫callid 2 mode int True 拒接模式，1：呼叫回原队列、座席示忙；2：呼叫释放、座席空闲 拒接模式是针对普通场景（用户呼入，座席拒接）进行说明的，对于复杂场景，例如内部求助、转移等场景，需要根据具体场景来判断拒接效果。

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

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

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

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

响应消息样例1 { "userid": "1528780879-9581", "outaction": 9, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "prompt_wav": "welcome", "prompt_text": "查询话费", "language": "0", "inter_idx": "1", "model_type":"1011201" "timeout": "10", "tone": "", "grammar": "", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }

响应消息样例 { "outaction": 12, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "inter_idx": "1", "moduleName":"查询", "xxx":"xxx" //扩展 } }

请求消息样例 { "userid": "1528780879-9581", "inaction": 9, "inparams": { "call_id": "1528780879-9581", "call_dst_id": "10086", "flow_result_type":"1", "input":"帮我查一下我的话费", "inter_idx": "1", "begin_play": "2018090407:16:24", "end_play": "2018090407:16:30", "result_time":"2018090407:16:3", "inter_no":"0" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005", "queueIndex":"2", "agentCount":"5", "estimateTime":"10", "idleAgentCount":"1" } } ODFS判断如果 flow_result_type = 1 且 input = (识别结果id值) 时会调用Redis获取转写文本（key=识别结果id值中redis值编号key），获取到的识别文本格式为字符串（非JSON格式）。 Lua脚本获取Redis结果示例代码如下，示例中代码key值为“msg”字符串。

响应消息样例3 { "userid": "1528780879-9581", "outaction": 10, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "start_time": "2018090407:16:24", "end_time": "2018090407:30:24", "release_reason": "0", "region_id": "025", "entrance_id": "03", "exit_id": "05", "user_type_id": "01", "suilu_region_id":"025" } }

响应消息样例2 { "userid": "1528780879-9581", "outaction": 11, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "calling_num":"1234567890", "trans_type": "1", "route_value": "123456789", "inter_idx": "1", "trans_idx": "1", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }