华为云用户手册

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码； 2、语音外呼问卷场景时为流程接入码；3、其他交互场景时传入接入标识。 不超过20位 begin_trans String body True 转移开始时间。 end_trans String body True 转移结束时间。 trans_result String body True 转移结果。 0：成功 其他值：失败 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 record_result String body False 录音结果（仅当转接第三方号码成功时生效） 0：成功 其他值：失败 input String body False 交互结果,（此参数请参考以下场景） 当转移成功后,接入方的请求参数需要传入trans_result=0的参数,不需要input；此后接入方收到ODFS的拆线(outaction=10)的响应,需接入方再次发送此请求,且请求参数需要包含input参数,取值为hangup。 hangup：挂机 不超过1024位 inter_idx String body False(语音导航场景特有字段) 交互次数,直接取上一次ODFS返回的inter_idx值即可。 mediaType String body False 媒体类型（文本,音频,视频... 例如：audio,video...） call_media_type String body False 呼入ivr的呼叫类型,文本：0 音频：1视频：3 channelType String body False 渠道类型 WEB（Web） INSTAG RAM （Instagram） TELEGRAM(Telegram) WECHAT(微信) FACEBOOK（Facebook） TWITTER（X (Twitter)） EMAIL（邮件） LINE WHATSAPP（WhatsApp） 5G（5G消息） SMS （短信）。 说明： 括号里为界面字段,区别于接口传参字段。

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： 无。 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "restReasonId": 100, "restReason": "身体不适" } ], "resultDesc": [ { "restReasonId": 100, "restReason": "身体不适" } ]}

样例报文 请求头： Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数： { "ccId":1, "vdn":170} 响应参数： { "result": "0", "resultCode": "0100000", "resultDatas": [ { "id": 1, "serviceNo": 1, "realFlag": 1, "accessNo": "85000", "description": "异常处理流程" }, { "id": 2, "serviceNo": 1, "realFlag": 1, "accessNo": "85001", "description": "主流程" } ], "resultDesc": [ { "id": 1, "serviceNo": 1, "realFlag": 1, "accessNo": "85000", "description": "异常处理流程" }, { "id": 2, "serviceNo": 1, "realFlag": 1, "accessNo": "85001", "description": "主流程" } ]}

请求URL https://ip:port/rest/cmsapp/v1/openapi/agentgroup/restreasons/{ccId}/{vdn} 其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。 非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明 表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.12及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.12及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 restReasonId int 休息原因码 2.2 restReason string 休息原因描述

响应消息 表3 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下： 0：成功 其他：失败 失败的原因说明请参见错误码参考。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下： "0100000"：成功 其他：失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 3 resultDesc array 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 表4 resultDesc/resultDatas数组中对象参数说明 序号 名称 参数类型 说明 2.1 id int IVR流程ID 2.2 serviceNo int 业务类型编号 2.3 realFlag int 虚实队列 1-实队列 2-虚队列 2.4 accessNo string 接入码 2.5 description string 接入码功能描述

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

报文样例 请求消息样例 {"userId": "1649209493813571405","sentence": "查询话费","tenantId": "202205125916","language": "zh_CN","targetIntentCount": "2","confidence2Top": "0.5","authToken": "Xun4*******************yAmResnf", "context":"查询话费", "domainList":[10039], "faqGroupList":[10952,10950]} 响应消息样例 { "intentsResponses": [ { "scenarioStatus": "finish", "confidence": 1.0, "responses": "尊敬的用户,您当前话费账户余额为56元。", "scenarioName": "话费查询", "commands": "查询话费" } ], "errorCode": 0} 请求消息样例(包含FAQ问答) {"userId": "1649209493813571405","sentence": "优惠套餐推荐","tenantId": "202205125916","language": "zh_CN","targetIntentCount": "2","confidence2Top": "0.5","authToken": "Xun4vb*******************mResnf", "context":"", "domainList":[10039], "faqGroupList":[10952,10950]} 响应消息样例 { "intentsResponses": [ { "simQuestions": [ "有实惠一点的流量套餐可以办理" ], "scenarioStatus": "SUC CES S", "confidence": 23.0, "responses": "本月特惠,10元3G流量。", "scenarioName": "1721756338", "commands": "systemQA" } ], "errorCode": 0}

请求说明 表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 意图名称,若为内容回复,则同replyIntentCode字段值。 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" : "" }

报文样例 请求消息样例 { "tenantId":"202104237142", "language":"zh_CN", "pageNum":1, "pageSize":20, "authToken": "t*********************", "domainInfo":{ "domainName":"机器人", "domainId": "10149" }} 响应消息样例 { "errorMsg": "", "errorCode": 0, "intentions": [ { "intentName": "移车地址", "intentDesc": " ", "intentCmd": "移车地址" }, { "intentName": "社保业务", "intentDesc": " ", "intentCmd": "社保业务" }, { "intentName": "移车业务", "intentDesc": "移车业务", "intentCmd": "移车" }, { "intentName": "公积金问题", "intentDesc": " ", "intentCmd": "公积金问题" }, { "intentName": "是否", "intentDesc": " ", "intentCmd": "是否" }, { "intentName": "公积金业务", "intentDesc": " ", "intentCmd": "公积金" } ], "total": 6}

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID language String body True 语言 en_US：英文 zh_CN：中文 pt_BR：葡萄牙语 th_TH：泰语 fr_FR：法语 ar：阿拉伯语 pageNum int body True 页码 分页查询,查询第几页,首页为1 pageSize int body True 每页多少条 支持每页 5、10、20、50、100条 domainInfo DomainInfo body 配置项oifde.slient.use = ipcc 时True,反之False 领域信息 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。 表2 DomainInfo 参数名称 数据类型 参数位置 必选/可选 描述 domainName String body False 领 域名 称 domainId int body True 领域ID language String body False 语言 tenantId String body False 租户ID

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

接口URI https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/forcerest/{workNo}/{time}/{reason} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 workNo string True 指定座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。 3 time long True 休息时长，单位：秒，取值范围：1-86399。 4 reason int True 休息原因码，取值范围：1-255。

响应说明 表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 任务描述

报文样例 请求消息样例 { "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：完成

请求说明 表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 智能助手平台接口鉴权方式。

报文样例 请求样例 { "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" ] } ]}

报文样例 请求消息样例 { "tenantId": "00030010", "faqGroupId":10000, "name":"", "pageNum":1, "pageSize":10, "authToken": "e**************************"} 响应消息样例 { "data": [ { "id": 10007, "faqId": 10000, "question": "什么是 问答机器人 ？", "simQuestions": [], "answer": " 根据用户的具体问题自动给出具体答案的应答机器人。", "simAnswers": [], "keywords": [] }, { "id": 10008, "faqId": 10000, "question": "什么是任务型 对话机器人 ？", "simQuestions": [], "answer": " 一系列以完成某项有明确目标的一系列任务（例如预订机票、订餐、开通彩铃等）为导向的对话机器人。", "simAnswers": [], "keywords": [] } ], "totalSize": 2}

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID faqGroupId int body True 问答组id name String body False 名称：一条问答记录的问题,不填则返回全部问答。 pageNum int body True 页码 分页查询,查询第几页,首页为1 pageSize int body True 每页多少条 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

报文样例 请求消息样例 { "authToken": "e***************************", "model":{ "id": -1, "tenantId": "00030010", "name": "Social Security Related FAQ2", "description": "This is a test group.", "language": "en_US" }} 响应消息样例 { "errorCode" : "0", "errorMsg" : "" }

响应消息样例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" }}

ExtParams参数 参数名称 数据类型 参数位置 必选/可选 描述 transin_data String body False 由接入方跟OIAP约定的随路数据参数，例如IVR传入的数据包参数 release_reason String body False(语音导航场景特有字段) ivr上报给odfs呼叫拆线的原因码： 0、业务流程正常拆线； 1、系统异常拆线； 2、用户拆线； queueIndex String body False(查询排队信息场景特有) 查询技能队列的排队位置 agentCount String body False(查询排队信息场景特有) 查询技能队列的在线座席数 estimateTime String body False(查询排队信息场景特有) 查询技能队列的预计等待时间 idleAgentCount String body False(查询排队信息场景特有) 查询技能队列的空闲座席数

响应消息样例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" }}

请求消息样例 { "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" }}

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同，给流程使用。 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入被叫号码； 2、语音外呼问卷场景时为问卷类型id； 3、其他交互场景时传入接入标识。 不超过20位 flow_result_type String body True 结果类型。 1： 语音识别 输入或者文字输入 2：语音按键输入 3：正常无输入(只播放) 4：录音结束 -1：其他 5：数字人流媒体服务 input String body True 对话交互结果。 语音识别结果或者文字输入：语音识别结果为id值，格式为redis值编号key+@+inter_no；文字输入结果则直接为文字内容 语音按键结果：按键值，如"1","201801"等 playover：放音结束 timeout：超时 nomatch：识别或按键失败 sys_err：系统异常 hangup：挂机 recordend：录音结束 当结果为hangup时，可触发ODFS的拆线响应。 不超过1024位 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 recordFileName String body False(支持全流程录音的语音导航场景特有字段) 全流程录音的路径文件名，例如：Y:/record/1/20200421/xxxxxx.wav inter_idx String body False(语音导航场景特有字段) 交互次数,直接取上一次ODFS返回的inter_idx值即可。 begin_play String body False(语音导航场景特有字段) 放音开始时间 end_play String body False(语音导航场景特有字段) 放音结束时间 result_time String body False(语音导航场景特有字段) 结果产生的时间 inter_no String body False(语音导航场景特有字段) 识别标识 IACmd String body False(语音导航场景特有字段) 智能匹配和智能工单填写专用字段 智能匹配时，只支持值为match 智能工单时，可取值如下： match：请求填单 rematch：当识别的事项分类错误时,重新识别 confirm：当座席点选某字段时,告知odfs该字段已确认 TextSource String body False(语音导航场景特有字段) 当IACmd为match时，用于区分输入文本来自座席还是用户（智能匹配、智能工单相同）,值为staff或customer staff：座席 customer：用户 当IACmd为confirm时，传入座席点选的字段名,如：对象二级 当IACmd为rematch时，可不填 feedback int body False 反馈的满意度: 1(满意)；0(不满意) feedbackContent String body False 反馈的不满意原因(如果反馈为满意则为空) mediaType String body False 媒体类型（文本,音频,视频... 例如：audio,video...） call_media_type String body False 呼入ivr的呼叫类型，文本：0 音频：1视频：3 channelType String body False 渠道类型 WEB（Web） INSTAGRAM（Instagram） TELEGRAM(Telegram) WECHAT(微信) FACEBOOK（Facebook） TWITTER（X (Twitter)） EMAIL（邮件） LINE WHATSAPP（WhatsApp） 5G（5G消息） SMS（短信）。 说明： 括号里为界面字段,区别于接口传参字段。 refeedbackContentcordFileName String body False 录音文件名 action String body 数字人回复图元 操作类型。 3: interrupt 4：callback action_result int body False 0：流 媒体处理 成功 1：流媒体处理失败 2：流媒体处理异常

报文样例 请求消息样例 { "authToken": "e***************************", "model":{ "id": 10000, "tenantId": "00030010", "name": "Social Security Related FAQ2", "description": "This is a test group.", "language": "" }} 响应消息样例 { "errorCode" : "0", "errorMsg" : "" }