云服务器内容精选

  • 报文样例 请求消息样例 { "authToken": "e***************************", "model":{ "id": 10000, "tenantId": "00030010", "name": "Social Security Related FAQ2", "description": "This is a test group.", "language": "" }} 响应消息样例 { "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" }}
  • 响应消息样例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) INSTAG RAM (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:流媒体处理异常
  • 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(查询排队信息场景特有) 查询技能队列的空闲座席数
  • 报文样例 请求消息样例 { "authToken": "e***************************", "model":{ "id": -1, "tenantId": "00030010", "name": "Social Security Related FAQ2", "description": "This is a test group.", "language": "en_US" }} 响应消息样例 { "errorCode" : "0", "errorMsg" : "" }
  • 报文样例 请求消息样例 { "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 智能助手平台接口鉴权方式。
  • 报文样例 请求样例 { "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 智能助手平台接口鉴权方式。
  • 响应说明 表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 任务描述
  • 请求说明 表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:完成
  • 报文样例 请求消息样例 { "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}