华为云用户手册

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID user String body True 测试用户ID sentence String body True 请求语句 language String body True 语言 英文：en_US、 中文：zh_CN、 西班牙语：es_ES、 阿拉伯语：ar、 泰语：th_TH、 葡萄牙语：pt_BR authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求消息样例 { "tenantId":"XXX"， "callId":"123123412300030010"， "agentId":"88880002"， "workMode":"3"， "authToken": "t***********************"， "callTransferRequest"{ "callTransferType":"5"， "callTransferRouteValue":"88880006"， "callTransferTransData":""， "callTransferNumber":"" } } 响应消息样例 { "errorCode" : "0"， "errorMsg" : "" }

报文样例 请求样例 { "tenantId":"202104237142"， "accessCode":"943370855474270208"， "timestamp":1628784000000， "type":"hour"， "authToken":"wEd*******************Q6VwYMj"} 响应样例 [ { "recordTime": 1628820000000， "tenantId": "202104237142"， "accessCode": "943370855474270208"， "callCount": 1， "exitNoConsultCount": 0， "callStaffNoConsultCount": 0， "callStaffConsultCount": 0， "exitConsultingCount": 1， "interactCount": 2， "autonomyRate": "1.0000"， "averageInteractPerCall": "2.00"， "dbRecordTime": 1628820000000， "type": "hour"， "interfaceRequestCount": 0， "interfaceSuccessCount": 0， "interfaceSuccessRate": "-1.0000" }]

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 - QueryCallStatisticsRes[] body True 呼叫统计报表信息 表2 QueryCallStatisticsRes 名称 是否必选 参数类型 说明 recordTime True long 记录日期的毫秒时间戳 tenantId True String 租户ID accessCode True String 接入标识（机器人接入码） callCount True long 接入量 exitNoConsultCount True long 直接退出量，用户和IVR只交互一次的量 callStaffNoConsultCount True long 直接转人工量，用户和IVR交互大于1次且小于等于3次，并且不在IVR挂机的量 callStaffConsultCount True long 咨询后转人工量，用户和IVR交互大于3次，并且不在IVR挂机的量 exitConsultingCount True long 仅咨询机器人量，用户和IVR交互大于1次，并且在IVR挂机的量 interactCount True long 对话轮次，总的用户和IVR交互次数 autonomyRate True String 净自助解决率 -1.000: 机器人总使用量为0（直接转人工量+咨询后转人工量+仅咨询机器人量） 0-1.000：仅咨询机器人量/机器人总使用量 averageInteractPerCall True String 平均对话轮次，平均每通对话，用户和IVR的交互次数 dbRecordTime True Date 数据库记录日期，未设置为null type True String 查询类型 hour: 按小时查询 day: 按天查询 interfaceRequestCount True long 接口调用总数 interfaceSuccessCount True long 接口调用成功数 interfaceSuccessRate True String 接口调用成功率 -1.000: 接口调用总数为0 0-1.000：接口调用成功数/接口调用总数

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 hour: 按小时查询，特定日期的报表数据 day: 按天查询，三十日内的报表数据 tenantId String body True 租户ID accessCode String body True 接入标识（机器人接入码） timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求消息样例 { "callId":"16064786965020f6fb86792bd25dbbb489426"， "agentId":"10001"， "nodeId":"node_action_97511fbc15d9b23074405ee736187a82c529"， "nodeIndex":2， "replyType":0， "replyIntentCode":"car"， "replyIntentContent":"测试汽车"， "replyIntentName":"ssq测试"， "authToken": "t*****************************" } 响应消息样例 { "errorCode" : "0"， "errorMsg" : "" }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租戶ID callId String body True 会话ID agentId String body True 座席ID nodeId String body True 图元节点ID，传给静默座席，静默座席回传 nodeIndex int body False 回复的图元节点执行位置，传给静默座席，静默座席回传 replyType int body False 回复类型，默认为0 0：意图回复 1：内容回复 replyIntentCode String body True 意图码，当静默座席回复自定义内容（即replyType为1）时，若为插入状态，固定赋值slientInsertReply。 replyIntentContent String body True 座席返回的答复。意图中配置的回复内容。 若为自定义内容，即直接输入静默座席回复的话 replyIntentName String body True 意图名称，若为内容回复，则同reolyIntentCode字段值 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 hour: 按小时查询，特定日期的报表数据 day: 按天查询，三十日内的报表数据 tenantId String body True 租户ID accessCode String body True 接入标识（机器人接入码） timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 - ChatbotReportRes[] body True 机器人报表信息 表2 ChatbotReportRes Name Mandatory Type Description recordTime True long 记录日期的毫秒时间戳 tenantId True String 租户ID accessCode True String 接入标识（机器人接入码） type True String 查询类型 hour: 按小时查询 day: 按天查询 consultCount True int 机器人总的回复数 responseSuccessCount True int 机器人总的成功回复数 unknowCount True int 机器人未知回复数 responseRate True String 成功回复率 feedbackCount True int 参评数 使用满意度反馈流程，客户参与评价的数目。 positiveFeedbackCount True int 满意参评数 使用满意度反馈流程，客户满意评价的数目。 positiveFeedbackRate True String 满意参评率 -1.0000: feedbackCount为0； 0-1.0000：满意参评率公式为positiveFeedbackCount/feedbackCount

报文样例 请求样例 { "tenantId":"202104237142"， "accessCode":"950964151029600256"， "timestamp":1630512000000， "type":"hour"， "authToken":"E***********************"} 响应样例 [ { "tenantId": "202104237142"， "accessCode": "950964151029600256"， "recordTime": 1630580400000， "type": "hour"， "consultCount": 1， "responseSuccessCount": 0， "unknowCount": 1， "responseRate": "0.0000"， "feedbackCount": 0， "positiveFeedbackCount": 0， "positiveFeedbackRate": "-1.0000" }]

报文样例 请求样例 { "tenantId":"202104237142"， "timestamp":1630684800000， "type":"month"， "authToken":"0kQl*******************PHFhoyDy"} 响应样例 { "tenantId": "202104237142"， "recordTime": 1630684800000， "type": "month"， "qaCount": 78， "intentCount": 42， "talkCount": 45， "effectiveQaCount": 1， "effectiveIntentCount": 7， "effectiveTalkCount": 6， "effectiveQaSum": 1， "effectiveIntentSum": 17， "effectiveTalkSum": 22， "qaList": [ { "name": "我们在测试"， "count": 1 } ]， "intentList": [ { "name": "话费查询(话费查询)"， "count": 7 }， { "name": "套餐降级(套餐降级)"， "count": 3 }， { "name": "无需服务(无需服务)"， "count": 2 }， { "name": "是否(是否)"， "count": 2 }， { "name": "Taxa de chamada(Taxa de chamada)"， "count": 1 }， { "name": "公积金业务(公积金)"， "count": 1 }， { "name": "公积金问题(公积金问题)"， "count": 1 } ]}

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 day: 按天查询，特定日期的报表数据 month: 按月查询，以timestamp往后一天作为结束时间，三十日内的报表数据 tenantId String body True 租户ID timestamp long body False 查询日期的毫秒时间戳 如果不传，仅返回租间问答、意图和语聊的数目。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

响应参数 名称 是否必选 参数类型 长度 说明 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 - 命令字参数信息，一般意图的槽位信息都通过这个返回。 scenarioName False String 64 意图名 scenarioType False int 4 场景类型，辅助场景=1， 业务场景=0， 无场景= -1 scenarioStatus False String 64 场景状态（暂不使用）

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

基本信息 给第三方接入方调用，实现文本分类、实体识别能力，可应用于智能座席助手的智能工单分类、智能填单场景。智能座席助手，通过调用文本分类接口进行完整的工单分类；通过调用实体识别接口，提取工单信息中的工单实体，完善工单；进一步增强智能座席助手的能力。 对接Customer Service Platform系统时，采取Headers头部的userName+token组合鉴权方式，其中userName为ipcc，token获取方式参见C3 智能助手平台接口鉴权方式。 对接其他第三方系统，采取请求体的authToken鉴权方式。

报文样例 请求样例 { "tenantId":"202104237142"， "language":"zh_CN"， "sentence":"长沙岳麓区岳麓大道旺龙路，下雨天积水严重，影响出行"， "authToken":"E2mjXcv*******************XX1av"} 响应样例 { "count": 4， "entityMsgV2List": [ { "citation": "@system.any"， // 匹配任意用户输入 "type": -1， "userEntity": false， "envEntity": false， "beginIndex": 0， "endIndex": 25， "values": { "@system.any": "长沙岳麓区岳麓大道旺龙路，下雨天积水严重，影响出行"， "@system.any.raw": "长沙岳麓区岳麓大道旺龙路，下雨天积水严重，影响出行" }， "formats": [ "raw" ] }， { "citation": "@system.env.time"， // 当前时间 "type": -1， "userEntity": false， "envEntity": true， "beginIndex": -1， "endIndex": -1， "values": { "@system.env.time.hour": "11"， "@system.env.time.minute": "09"， "@system.env.time": "11:09" }， "formats": [ "hour"， "minute" ] }， { "citation": "@system.env.date"， // 当前日期 "type": -1， "userEntity": false， "envEntity": true， "beginIndex": -1， "endIndex": -1， "values": { "@system.env.date.yyyyMM": "202110"， "@system.env.date": "2021-10-19"， "@system.env.date.year": "2021"， "@system.env.date.month": "10"， "@system.env.date.day": "19" }， "formats": [ "yyyyMM"， "year"， "month"， "day" ] }， { "citation": "@system.address"， // 地址检测 "type": -1， "userEntity": false， "envEntity": false， "beginIndex": 0， "endIndex": 5， "values": { "@system.address.raw": "长沙岳麓区"， "@system.address": "湖南省长沙市岳麓区"， "@system.address.province": "湖南省" }， "formats": [ "raw"， "province" ] } ]}

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 language String body True 语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 th_TH：泰语 pt_BR：葡萄牙语 说明： 基于Tuc的实体识别，支持如上选项语种。 基于Lodas的实体识别，支持语言以Lodas实体识别模型为准。 sentence String body True 输入语句。 实体识别的依据，最大长度4096字符。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 day: 按天查询，特定日期的报表数据 month: 按月查询，以timestamp往后一天作为结束时间，三十日内的报表数据 tenantId String body True 租户ID timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求样例 { "tenantId":"202104237142"， "timestamp":1630684800000， "type":"month"， "authToken":"0kQl*******************FhoyDy"} 响应样例 [ { "name": "947988117535592448"， "count": 19 }， { "name": "943382168053223424"， "count": 10 }， { "name": "943372803514568704"， "count": 4 }， { "name": "940757366746386432"， "count": 4 }， { "name": "943218432118099968"， "count": 4 }， { "name": "947918435541585920"， "count": 4 }， { "name": "942949731485618176"， "count": 3 }， { "name": "950966390083293184"， "count": 3 }， { "name": "943370855474270208"， "count": 2 }， { "name": "942919556320464896"， "count": 1 }]

报文样例 请求样例 { "tenantId":"fangyg"， "language":"zh_CN"， "text":"发票开不出来"， "authToken":"XI0*******************lYbYACW"} 响应样例 { "results": [ { "label": "移动业务→基础服务→电子发票→全局流转→功能使用→发票无法打印→全局流转"， "probability": 0.41408610343933105 }， { "label": "移动业务→服务触点→一点对接业务→全局流转→业务规则→对业务规定/流程不满→全局流转"， "probability": 0.012493142858147621 }， { "label": "移动业务→业务营销→资费套餐→降档套餐→办理规范→限制渠道办理不认可→全局流转"， "probability": 0.004905845504254103 } ]}

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 language String body True 语言。选项如下： zh_CN：中文 en_US：英文 es_ES：西班牙语 ar：阿拉伯语 th_TH：泰语 pt_BR：葡萄牙语 注意：智能工单分类场景，以Lodas文本分类模型支持语言为准。 text String body True 输入语句。 文本分类的依据，最大长度4096字符。 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求消息样例 { "tenantId": "202201010101"， "authToken": "abcdefg"， "inputJsonData": { "caseId": "0000000002"， "userId": "123456"， }， "description": "描述队列数据"， "queueUid": "123456789"， "priority": "normal"} 响应消息样例 { "errorCode": 0， "errorMsg": null， "queueData": { "id": 67， "uid": "1234567890123"， "queueName": "创建工单"， "queueUid": "123456789"， "createTime": 1652100233488， "expectStartTime": null， "expectEndTime": null， "status": "init"， "priority": "normal"， "inactived": "active"， "tag": null， "inputJsonData": "{\"caseId\":\"0000000002\"}"， "outputJsonData": null， "analysisJsonData": null， "failedReason": null， "failedReasonDetail": null， "description": "描述队列数据"， "progress": null }}

响应说明 表2 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 返回0：成功 其他值：失败 errorMsg String body False 错误信息 queueData QueueData[] body False 队列数据，成功时必须返回。 表3 QueueData参数说明 参数名称 数据类型 参数位置 必选/可选 描述 id long body False 队列数据自增ID uid string body False 队列数据UUID queueName string(32) body False 队列名称 queueUid string body False 队列UUID createTime long body False 创建时间(0-7258089600000L)时间戳 expectStartTime long body False 计划开始时间(0-7258089600000L)时间戳 expectEndTime long body False 计划结束时间(0-7258089600000L)时间戳 status string body False 队列状态枚举类型为： init：等待处理 processing：处理中 success：成功 failed：失败 priority string body False 优先级枚举类型为： low：低 normal：中 high：高 inactived string body False 队列启用状态枚举类型为： active：已启用 inactive：已停用 tag string(32) body False 队列数据标签 inputJsonData string(65535) body False 输入的队列数据，json格式字符串 outputJsonData string(65535) body False 输出的结果数据，json格式字符串 analysisJsonData string(65535) body False 中间的队列数据，json格式字符串 failedReason string(512) body False 失败原因 failedReasonDetail string(65535) body False 失败原因细节 description string(100) body False 队列数据描述 progress int body False 进度(0-100)

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度：64 authToken String body True 访问接口的有效Token值。 有效Token信息通过获取Token接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度：32 tag string(32) body False 队列数据标签，同一个队列标签唯一 priority string body False 优先级使用枚举类型，默认值为normal low：低 normal：中 high：高 inputJsonData string(65535) body False 输入的队列数据，json格式字符串 expectStartTime long body False 计划开始时间(0-7258089600000L)时间戳 expectEndTime long body False 计划结束时间(0-7258089600000L)时间戳 description string(100) body False 队列数据描述 queueUid string body True 队列UUID，唯一标识。

报文样例 请求消息样例 { "tenantId": "202201072597"， "authToken": "hjbLf*******************RQFv3nq"， "pageNo": 1， "pageSize": 10， "conditions": {}} 响应消息样例 { "total": 1， "jobs": [ { "uid": "0c9358552188478a8d5ff9203db8791f"， "jobName": "AICC_RPA"， "createTime": "2022-04-24 17:12:02"， "startTime": "2022-04-29 11:47:25"， "status": "running"， "mode": "queueTrigger"， "runMode": "online"， "timeout": 120， "description": null } ]， "errorCode": 0， "errorMsg": null}

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID 限制长度：64 pageNo Integer body False 查询页数，默认1页 pageSize Integer body False 每页多少条，默认50条 可选值：5，10，20，50 conditions RpaJobCondition body False 查询条件 authToken String body True 访问接口的有效Token值。 有效Token信息通过获取Token接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度：32 表2 RpaJobConditions参数 参数名称 数据类型 参数位置 必选/可选 描述 jobName String body False 任务名称模糊查询 status Integer body False 任务状态条件搜索，如下： init：待执行 running：运行 suspend：暂停 success：完成

响应说明 表3 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode Int body True 错误码 返回0：成功 其他值：失败 errorMsg String body False 错误信息 total Int body False 总记录数 jobs RpaDetailJobResult[] body False 任务列表，成功时必须返回。 表4 RpaDetailJobResult 参数说明 参数名称 数据类型 参数位置 必选/可选 描述 uid String body False 任务UUID jobName String body False 任务名称 createTime String body False 任务创建时间 startTime String body False 任务开始时间 status String body False 任务状态，枚举类型为： init：待执行 running：运行 success：完成 suspend：暂停 mode string body False 执行方式：once、repeat runMode string body False 运行模式：在线online；离线offline timeout Integer body False 任务的超时时间，单位s description string body False 任务描述

报文样例 请求消息头 Content-Type:application/json; charset=UTF-8userName:ODFS_SYS_OPENAPItoken:******************** 请求体消息 {"body": {"state": {"code": 0，"success": true }，"body": {"aid": "FJKkMeepk8l"，"lattices": [{"begin": 4360，"end": 5970，"lid": 0，"onebest": "喂接通了吗？"，"spk": 0 }] } }} 响应体消息 { "retCode": "0"， "retMsg": "success"}

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

请求说明 表2 请求体参数 序号 参数名 参数类型 是否必选 说明 1 body Object True 回写结果。 该对象的参数说明请参见表3。 表3 body参数说明 序号 参数名 参数类型 是否必选 说明 1.1 state Object True 转写状态。 该对象的参数说明请参见表4。 1.2 body Object True 回写结果body体。 该对象的参数说明请参见表5。 表4 state参数说明 序号 参数名 参数类型 是否必选 说明 1.1.1 code String True 转写的结果编码。 1.1.2 success boolean True 转写是否成功，true标识成功，false标识失败。 表5 body参数说明 序号 参数名 参数类型 是否必选 说明 1.2.1 aid String True 音频文件唯一标识符，由客户端传入。 1.2.2 lattices List True 转写结果。 该对象的参数说明请参见表6。 表6 lattices参数说明 序号 参数名 参数类型 是否必选 说明 1.2.2.1 lid int True 片段序列号。 1.2.2.2 begin int True 分片开始时间。 1.2.2.3 end int True 分片结束时间。 1.2.2.4 onebest String True 转写后的文本。 1.2.2.5 spk int True 说话人的角色。