华为云用户手册

响应消息 表3 消息体参数说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 resultDesc array 查询成功后，返回结果信息的对象数组。 该接口的响应消息体参数说明请参考表4 表4 响应消息体参数说明 参数名 数据类型 说明 totalCount int 日外呼量。 succCount int 成功呼叫数（接通量）。 failCount int 失败呼叫数。 succRate String 成功率（接通率）。 compCount int 完成呼叫数。 waitCount int 等待呼叫数。 execCount int 执行中呼叫数。 compRate String 完成率。

报文样例 请求头: Content-Type:application/json X-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXX Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "limit": "10", "offset": 0 } 响应参数: { "returnCode": "0", "total": 1, "data": [ { "skillId": 1, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "name": "defaultVideoSkill", "mediaTypeId": 19, "description": "2021ok", "maxWaitNum": 100, "skillParam": { "noAgents": { "transferType": "Release" }, "busy": { "transferType": "Release" }, "answerFunction": "0", "timeOut": { "transferType": "Release" }, "waitVoice": { "parameterType": "Voice" } } } ], "description": "success" }

报文样例 场景描述：完成抽检任务。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "isGroup": false, "callId": "951849808525254658", "callGroupId": null, "qualityTaskCallId": 951849808189710338 } 响应参数: { "resultCode": 0409000, "resultDesc": "success" }

请求说明 表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 isGroup boolean True 是否在通话组 1.2 callId number True 通话id 1.3 callGroupId number True 通话组id 1.4 qualityTaskCallId number True 任务id

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

报文样例 请求头: { "Content-Type": application/json "x-app-key": ******************** "Authorization": Bearer ************************ } 请求参数: { "offset":0, "limit":10, "type":2 } 响应参数: { "returnCode": "0", "description": "query success", "voiceInfo": [ { "tenant_id": "20******234", "uploaddate": 163*****4000, "voice_id": "113379*********9999", "name": "welcome", "voicecontent": "{\"0\":{\"languageId\":\"0\"，\"textcontent\":\"欢迎光临\"}}", "type": 2, "tenantSpaceName": "************" } ] }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string True appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）。 生成方式参见C1 系统配置类接口鉴权方式。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 reqBody object True - 1.1 offset integer False 起始游标，即分页查询时的起始记录行号。 首次查询传入“0”。 后续查询其他分页时传入该分页的第一条记录的序号。返回记录中第一条记录序号为“0”，后续依次排序。例如每页为50条录，查询第二页时应传入“50”。 不传时默认0，无最大值限制 1.2 limit integer False 分页查询时的每页记录数，正整数，不传时默认100，最大值100，传入超过100的值也会转换为100 1.3 type integer False 录音文件类型 0：音频，2：text文本

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 返回码，0：成功，其他失败（1：请求参数type不正确） 1.2 description string False 返回描述 1.3 voiceInfo object False 录音信息 1.3.1 tenant_id string True 租户id 1.3.2 uploaddate number True 上传时间，格式为timestamp 1.3.3 voice_id string True 录音id 1.3.4 name string True 录音名称 1.3.5 voicecontent string False 语音内容 1.3.6 type number True 类型 0：音频，2：text文本 1.3.7 tenantSpaceName string False 租户名称 1.3.8 auditaccount string False 审核者账号 1.3.9 noReference boolean False 提示音和故障音是否被引用 1.3.10 auditcomments string False 审核意见 1.3.11 auditdate number False 审核时间，格式为timestamp 1.3.12 scene number False 使用场景 1.3.13 uploadaccount string False 上传账号 1.3.14 isUpdateRec number False 是否是更新记录 1.3.15 status number False 回调状态 1.3.16 callbackTimes number False 回调次数 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：获取录音文件转换后的文本 请求头: x-app-key:************************************ Authorization:Bearer ************************************ 请求参数: { "language": "zh_CN", "taskId": "605d5aff00000927" } 响应参数: { "errorMessage": "Failed to obtain the task id is {}605d5aff00000927", "errorCode": 1010404 }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 响应状态码 1.2 bytesZip string False zip格式压缩包 1.3 resultDesc string False 响应状态消息 表4 bytesZip解压后0.json字段说明 序号 名称 参数类型 是否必选 说明 1 sentences jsonArray - 转写后的句子内容 1.1 st int - 开始时间 1.2 et int - 结束时间 1.3 text string - 断句识别结果 1.4 c int - 置信度，[0,1] 1.5 sa jsonObject - 质检结果 1.5.1 role string - 说话角色 1.5.2 agent string - 座席 1.5.3 user string - 客户 1.6 e string - 情绪，HAPPY,ANGRY,SAD,DISGUSTED四者之一 响应状态码: 400 请求的内容未找到：请检查请求的路径和各参数的取值。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 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后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 taskId string True 新建任务的ID，通过voice2Text接口获取。 说明： taskId仅支持填写创建质检任务后三天内的任务ID 1.2 language string True 录音文件语言（zh_CN 代表中文，en_US 代表英文）

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 说明： 当出现错误提示“Unknown ERROR._*****”时，*****表示CTI错误结果码，详情请参见表2。 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result map 请参考表4 表4 会议ID数组 序号 名称 参数类型 说明 3.1 confIds array 会议ID数组

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

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

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requestwhisperagent?whisperagentid={whisperagentid} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 whisperagentid string False 被质检耳语的座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

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

报文样例 场景描述：更新句子分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "name": "cs3", "category_id": "1070149256381206528" } 响应参数: { "resultCode": "0403000", "id": "1070149256381206528", "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 name string True 修改后的句子分类名称 1.2 category_id string True 需要修改的句子分类的唯一标识

典型交互序列 第一步 获取token 首先确认是系统粒度（内部系统如客服云或 CS P）对接还是租户粒度（第三方系统）对接。 第三方系统在与智能助手平台系统对接,需要使用租户id来获取token（C3 智能助手平台接口鉴权方式）,在token有效期内完成调用操作，而且后续每一次接口调用都需要传入获取的token。 内部系统（客服云或CSP）与OIAP对接，需要使用默认系统对接约定的默认用户来获取token（C3 智能助手平台接口鉴权方式），在token有效期内完成调用操作，而且后续每一次接口调用都需要传入获取的token。 第二步 建立与智能助手平台系统的绑定关系 在获取token后，第三方需通过传入特定租户和语言信息查询号航系统对应已激活的领域（领域查询接口），并绑定第三方的接入标识与领域的绑定（对话标识绑定查询接口）。 第三步 完成对话交互 在将接入标识与智能助手平台系统的领域完成绑定后，就可以通过调用智能助手平台的各种对话接口来实现对话交互了（对话接口），比如初始化，放音，转接，挂机等。

常用错误码 表1 常用错误码参考表 错误码 描述 900001 无Token信息,或Token已过期。 900002 检查Token信息失败。 10000001 内部错误，通常因为应用系统故障引起。 10000002 参数错误。通常由于请求中未提供全部必填字段的值。 10000006 接口入参重复 10000007 接口出参重复 10000008 接口头参数重复 10000003 参数不存在,必须输入该参数 10000004 参数已经在系统中存在,不能重复使用 20000001 处于发布状态不能修改 20000002 流程名已经存在 20000003 删除节点错误,节点被别的流程引用 20000004 删除变量错误,变量被流程或者模板引用 20000005 修改变量错误,原变量被流程或者模板引用 20000006 文件路径不存在 20000007 IOException 读取文件流错误 20000008 更新数据错误 200900002 内部错误,通常因为应用系统故障引起 200900003 参数错误。通常由于请求中未提供全部必填字段的值 200800001 密钥不存在 200800002 密钥错误 200800003 锁账号

报文样例 场景描述：根据ID查询语速规则详情 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** x-TenantSpaceId:202101124979 请求参数: { "speed_id": "849706874868600832" } 响应参数: { "exception": { "over": { "customer": [] }, "under": { "customer": [] } }, "resultCode": "0405000", "resultDesc": "操作成功", "setting": { "score": "-3", "other": { "call_end": 0, "call_from": 0 }, "min": "90", "max": "150", "name": "语速规则", "speed_id": "925095745760006144" } }

请求说明 表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 speed_id string True 语速规则ID

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 exception object False 例外信息 1.1.1 under object False 语速低于最小限制时 1.1.1.1 customer array[object] False 客户有说出的句子 1.1.1.1.1 sentence_id string False 句子ID 1.1.1.1.2 sentence_name string False 句子名称 1.1.1.1.3 category_id string False 句子分类ID 1.1.2 over object False 语速高于最大限制时 1.1.2.1 customer array[object] False 客户有说出的句子 1.1.2.1.1 sentence_id string False 句子ID 1.1.2.1.2 sentence_name string False 句子名称 1.1.2.1.3 category_id string False 句子分类ID 1.2 setting object False 基本信息 1.2.1 name string False 语速规则名字 1.2.2 score number False 违规扣分数0-100（包含0和100） 1.2.3 min number False 语速最小限制1-220（每分钟的字数） 1.2.4 max number False 语速最大限制1-2147483647（每分钟的字数） 1.2.5 speed_id string False 语速规则ID 1.2.6 other object False 触发条件（满足开始结束时间时触发） 1.2.6.1 call_end number False 通话发生开始时间（毫秒数） 1.2.6.2 call_from number False 通话发生结束时间（毫秒数） 1.3 resultCode string True 返回码，0405000表示成功，其他表示失败 1.4 resultDesc string True 返回的描述信息 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

样例报文 请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "vdn":170, "callerNo": "12345", "calleeNo": "23131", "beginDate": "14511111111", "endDate": "14522222222", "limit": 10, "offset": 0 } 响应参数： { "resultCode":"0100000", "resultDesc":{ "data":[ { "logDate": "1615717765000", // 统计时间 "callerNo": "1212", // 主叫号码 "calleeNo": "12121212",// 被叫号码 "callId": "167789709-33", // 呼叫标识 "callType": "1",// 呼叫类型 "waitBegin": "1615717765000",// 呼叫等待开始时间 "ackBegin": "1615717765000",// 呼叫应答时间 "callBegin": "1615717765000",// 通话开始时间 "callEnd": "1615717765000",// 通话结束时间 "vdn": 170, // vdn编号 "leaveReason": "1"， // 呼叫离开设备原因 "mediaType":53, // 媒体类型 "subMediaType":1 // 子媒体类型 } ], count: 5 } }

报文样例 场景描述：更新句子 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "category_id": "1070149256381206528", "sentence_name": "句子名称766", "tagDataList": [ { "tag_type": "dialogue_act", "pos_sentences": [ { "name": "11111111111222222222" }, { "id": "10162", "name": "同义语料585111111111111111" } ], "neg_sentences": [ { "name": "1111111111111111" }, { "id": "10040", "name": "反义语料461111111111111" } ] }, { "tag_type": "keyword", "pos_sentences": [ { "name": "222222222222222222222222" }, { "id": "10094", "name": "关键字9891111111111111111" }, { "id": "10093", "name": "关键字11111111111111111111" } ] } ], "sentence_id": "10863", "deleteTagDataList": [] } 响应参数: { "resultCode": "0403000", "id": "10863", "resultDesc": "操作成功" }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 id string False 句子的唯一标识 1.2 resultCode string False 返回码 0403000 表示成功 其他表示失败 1.3 resultDesc string False 返回描述 1.4 statusCode number 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 category_id string True 句子分类的唯一标识 1.2 sentence_name string True 句子名称 1.3 sentence_id string True 句子标识 1.4 tagDataList array[object] True 句子使用到的语义与关键词 1.4.1 tag_type string True 标签类型，取值范围： keyword：关键字 dialogue_act：语料 regular_exp：正则表达式 1.4.2 pos_sentences array[object] False 正向的语料，关键字和正则表达式 1.4.2.1 id string False 语料的唯一标识 1.4.2.2 name string False 语料内容 1.4.3 neg_sentences array[object] False 反向语料，与pos_sentences在同一个标签对象中不能同时存在 1.4.3.1 id string False 语料的唯一标识 1.4.3.2 name string False 语料内容

报文样例 请求头: Content-Type:application/json X-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXX Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "skillId": 3, "description": "2021ok", "maxWaitTime": 60 } 响应参数: { "returnCode": "0", "description": "Update Skill successfully" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 description string False 技能简称或描述，不超过50个字符（允许的字符包括中文、字母、数字） 1.2 maxWaitTime number False 最大排队等待时间，单位秒，最大值60000 1.3 maxWaitNum number False 最大排队等待人数，最大值10000 1.4 maxAgentWrapupTime number False 整理态时长，单位秒，最大值3600 1.5 skillParam object False 技能队列参数信息，媒体类型为53或2或18时，只有noAgents、busy和timeOut三项配置，媒体类型为53时deviceType的值只能为1；媒体类型为5或19时noAgents、busy、timeOut、answerFunction和waitVoice配置必填 1.5.1 noAgents object True 无人上班配置 1.5.1.1 deviceType string False 设备类型。 3：IVR 1：技能队列 1.5.1.2 transferType string True 处理策略。 Release：释放，此时同级其他参数不填 Transfer：转接，此时同级其他参数必填 1.5.1.3 value number False 技能队列时取skillId，IVR时取IVR流程编号id 1.5.2 busy object True 排队遇忙、溢出配置 1.5.2.1 deviceType string False 设备类型 3：IVR 1：技能队列 1.5.2.2 transferType string True 处理策略。 Release：释放，此时同级其他参数不填 Transfer：转接，此时同级其他参数必填 1.5.2.3 value number False 技能队列时取skillId，IVR时取IVR流程编号id 1.5.3 answerFunction string False 业务代表应答方式配置，0报工号2不报语音 1.5.4 timeOut object True 排队超时配置 1.5.4.1 deviceType string False 设备类型 3：IVR 1：技能队列 1.5.4.2 transferType string True 处理策略。 Release：释放，此时同级其他参数不填 Transfer：转接，此时同级其他参数必填 1.5.4.3 value number False 技能队列时取skillId，IVR时取IVR流程编号id 1.5.5 waitVoice object False 排队等待配置 1.5.5.1 parameterType string True Voice：Voice，此时同级其他参数不填 IVR：IVR，此时同级其他参数必填 1.5.5.2 id string False IVR时取IVR流程编号id 1.6 skillId integer True 技能队列ID

会议放音结束事件 标示符 AgentConf_StopVoice 作用 表示会议放音结束。 附带信息 result表示停止会议放音的结果。0：成功 1：失败。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentConf_StopVoice","workNo":"154","content":{"result":0}}} 父主题： 座席会议事件