华为云用户手册

  • Issue 09(2022-12-05) 本次随MicroService 1.11.0 版本发布,变更如下接口。 表4 接口修改记录 序号 接口 类型 备注 1 https://域名/apiaccess/rest/new_case/v2/cases 新增 创建工单 2 https://域名/apiaccess/rest/new_case/v2/cases/modify 新增 修改工单属性 3 https://域名/apiaccess/rest/new_case/v2/cases/casetypes 新增 查询工单类型信息 4 https://域名/apiaccess/rest/new_case/v2/cases/casedetails 新增 查询工单详情 5 https://域名/apiaccess/rest/new_case/v2/cases/dealCase 新增 处理工单操作 6 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/create 新增 创建任务 7 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/queryByTaskItemId 新增 查询任务项信息 8 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/queryByTaskId 新增 根据任务id查询任务信息 9 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/dynamicCondition/query?mode=all 新增 根据条件查询任务信息 10 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/transfer 新增 任务转派 11 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/release 新增 任务释放 12 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/claim 新增 任务认领 13 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/done 新增 任务处理 14 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/recall 新增 任务撤回 15 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/return 新增 任务退回 16 https://域名/oifde/rest/crs/process 修改 对话交互后接口V1(inaction=9) 17 https://域名/oifde/rest/crs/process 修改 对话交互后接口V2(inaction=9) 18 释放事件回调接口 修改 新增请求体参数的releaseReason
  • Issue 08(2022-10-20) 本次随MicroService 1.10.0 版本发布,变更如下接口。 表5 接口修改记录 序号 接口 类型 备注 1 https://域名/apiaccess/rest/cc-management/v1/agentAccount/create 修改 请求体参数phone长度改为不超过25位 2 https://域名/apiaccess/rest/cc-management/v1/agentAccount/update 新增 请求体参数phone长度改为不超过25位 3 https://域名/apiaccess/ccmessaging/queryHistoryChatMessage 新增 查询历史消息 4 https://域名/apiaccess/ccmessaging/send,例如域名是https://service.besclouds.com 修改 请求参数mediaType支持位置消息(LOCATE)。
  • 话单记录文件(yyyymmddhhmmssSSS+3位随机数_call_文件序号.csv)定义 导出的话单记录csv文件中每一行表示一条数据,在该条数据下每行数据按列排序,每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 developer String(1-64) 开发者ID。 2 account_id String(1-64) 企业帐号。 3 cc_id String(1-64) 呼叫中心ID。 4 agent_id String(1-32) 座席ID。 5 call_id String(1-25) 呼叫标识。 6 caller_no String(1-26) 主叫号码。 7 callee_no String(1-26) 被叫号码。 8 wait_begin DATE 等待开始时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 9 wait_end DATE 等待结束时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 10 ack_begin DATE 应答开始时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 11 ack_end DATE 应答结束时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 12 call_begin DATE 呼叫开始时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 13 call_end DATE 呼叫截止时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 14 device_type Int(1-4) 设备类型。 1:技能队列,2:座席,3:IVR流程 15 device_no Int(1-5) 设备号。 如果设备类型为技能队列,设备号为技能队列ID; 如果设备类型为座席,设备号为座席ID; 如果设备类型为IVR,设备号为IVR流程ID。 16 call_type Int(1-4) 呼叫类型。详见呼叫类型说明。 17 release_cause Int(1-5) 呼叫释放原因。详见呼叫释放原因码 对CallIDNUM = -1的话单(参考本表第18项),表示呼叫的释放原因,其他情况下无意义。 18 call_id_num Int(1-4) 呼叫标识的序列。其中: 若相同呼叫标识只有一条,即该呼叫标识是唯一的,则该序列为-1。 若相同呼叫标识为多条,则最后一条是-1,其他的按顺序排列。如:相同呼叫标识有4条,callidnum为1、2、3以及-1。 19 vdn_id String(1-32) 指处理呼叫的虚拟呼叫中心编号。 20 pre_device_type String(1-32) 呼叫经历的上一个设备的设备类型。取值范围:1:队列 2:座席 3:IVR 21 pre_device_no String(1-32) 呼叫经历的上一个设备的设备编号。 22 skill_id String(1-32) 呼叫所属技能队列的ID。当溢出转和无人上班转时,为呼入的第一个技能队列的ID 23 current_skill_id String(1-32) 当前处理呼叫的技能队列的编号。
  • 录音记录索引文件(yyyymmddhhmmssSSS+3位随机数_record_文件序号.csv)定义 导出的录音记录csv文件中每一行表示一条数据,在该条数据下每行数据按列排序,每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 developer String(1-64) 开发者ID。 2 account_id String(1-64) 企业帐号。 3 cc_id String(1-64) 呼叫中心ID。 4 agent_id String(1-32) 座席ID。 5 call_id String(1-25) 呼叫标识。 6 caller_no String(1-25) 主叫号码。 7 callee_no String(1-25) 被叫号码。 8 call_begin DATE 开始时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 9 call_end DATE 结束时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 10 file_name String(1-255) 录音文件名。例如:/10/1/record/100/13533/0903379.wav 11 task_status String(1-20) 是否有将录音文件转为文字文件(1:是,0:否)。 12 task_result String(1-20) 录音文件转为文字文件是否成功的状态信息(success:成功,failed:失败)。 13 original_file_name String(1-129) 原始录音文件路径。例如:X:\17\0\20180903\15470\2043295.V3 14 vdn_id String(1-64) 指处理呼叫的虚拟呼叫中心编号。 15 call_type String(1-64) 呼叫类型。详见呼叫类型说明。 16 media_type String(1-64) 媒体类型。详见媒体类型。 17 user_wanted_skill_id String(1-64) 引导技能。 18 current_skill_id String(1-64) 当前处理呼叫的技能队列的编号。
  • 请求消息样例 { "userid": "1528780879-9581", "inaction": 13, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian" }} ODFS接收到inaction为13的请求后,检索该呼叫从宇高上报识别结果队列是否有数据,如果有数据,就给IVR返回1,否则返回0:
  • 相关术语 表1 术语表 名词 描述 VDN 虚拟呼叫中心,为CTI侧的概念。在云客服中,一个租户创建配置完毕后即对应一个虚拟呼叫中心,虚拟呼叫中心等同于租户、租间。 技能队列 技能队列指处理同类问题或解答同类疑问的座席分组,区分技能队列可提高座席的工作效率,缩短服务时长。技能队列包含语音、多媒体、视频、语音点击通话和视频点击通话,5种类型,用于处理不同的问题。 当用户请求某种媒体服务时,用户呼叫先进入到该媒体下的某个技能队列,由签入技能队列的座席为呼叫用户提供服务。 接入码 面向客户提供的客服热线,客户通过拨打接入码接通到座席侧。 扩展码 如果希望一个接入码能设置多个目的设备。这种情况下可通过配置扩展码的方式来实现,例如,接入码为12345,我们可以添加扩展码1,路由到技能队列A,扩展码2,路由到技能队列B。这样客户可直接拨打123451实现直接接入技能队列A。 软电话号码 即为您OpenEye的登录账号,Openeye是一个多媒体软终端产品。 APPKey 即AK,也可写作APP ID,开发者账号。当第三方调用云客服系统的对外开放接口时,需要通过AK和SK 获取Token 认证信息。 APPSecret 即SK,认证密钥。当第三方调用云客服系统的对外开放接口时,需要通过AK和SK获取Token认证信息。 IP:PORT 用户登录云客服时,登录页面的域名。接口文档中URL会涉及到此术语,例如URL为“https://IP:PORT/oifde/rest/api/spellcheck”,云客服登录页面域名为“southvideo.aicccloud.com”,则IP:PORT可以用对应的域名“southvideo.aicccloud.com”替换。
  • inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body False 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_sor_id String body False 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码; 2、语音外呼问卷场景时为流程接入码; 3、其他交互场景时传入接入标识。 不超过20位 real_callee String body False 实际接入IVR时的被叫号码,当语音导航场景下有效 不超过32位 cti_callid String body False(语音导航场景特有字段) 华为ivr传入的实际呼叫的CTI的callid,其他场景此值为空 不超过32位 auth_token String body True 授权信息,取接入控制系统返回的token值。
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 0或者null:成功 非0表示失败 或可通过状态码为200判断为成功 errorMsg String body False 错误描述 domains domain[] body True 领域信息,数组形式输出 表3 domain 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID domainId int body True 领域ID domainName String body True 领域名称 language String body True 语言。选项如下: zh_CN:中文 en_US:英文 es_ES:西班牙语 ar:阿拉伯语 如果没有该字段,则返回所有语言的domain,如果有,只返回指定语言的domain。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 表2 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 language String body False 语言。选项如下: zh_CN:中文 en_US:英文 es_ES:西班牙语 ar:阿拉伯语 如果language为空或者为""都是返回全部的领域结果,如果有,只返回指定语言的domain。 authToken String body True 认证Token 请参见C3 智能助手平台接口鉴权方式。
  • 报文样例 请求消息体 { "appKey": "tenant001", "appSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } 响应消息体 { "errorCode" : 0, // int, 错误码,无错时为0 "errorMsg" : "", // String, 出错信息,无错时为空 "authToken": "2************************", "expireTime" : 3600}
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 0:成功 非0表示失败 或可通过状态码为200判断为成功 errorMsg String body False 错误描述 authToken String body True 认证token expireTime int body False 令牌有效期,单位是秒数,默认 3600 秒; 错误码非0时,无返回。
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 ret int body True 执行结果 0:成功 非0表示失败 userid String body True ODFS根据在userid内部建立呼叫实例,同一时间ODFS内部可能有多个呼叫实例,,后继的交互根据userid将同一通电话关联起来。 outaction int body True 接下来接入方需要执行什么类型的操作 9:对话交互类操作 11:对话转接类操作 10:拆线操作 12:查询类操作 7:对话开启抓包录制请求 13:请求识别结果 outparams Object body True 用于知会接入方完成操作需要的详细信息,请根据具体的场景查看参数介绍。
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 userid String body True ODFS根据在Userid内部建立呼叫实例,同一时间ODFS内部可能有多个呼叫实例, 后继的交互根据Userid将同一通电话关联起来。 不超过64位 inaction int body True 接入方本次执行的是什么类型的请求: 8: 对话初始化请求 (第一次调用时) 9: 对话交互后请求 11: 对话转移后请求 注:除了第一次调用时必须为8, 后继传入值即为上次交互接收到的“outaction”即可。 seat String body False 座席类型,不填默认为vir vir:虚拟座席 ass:座席助手 inparams Object body True 用于向ODFS传递参数,告知ODFS本次操作结果的详细信息,Inaction的值不同,Params的参数也不相同,根据下面细分的场景详细了解参数介绍。 extparams Object body False 用于向ODFS传递参数,可选的扩展参数,当前只有初始化场景使用
  • 报文样例 请求消息样例 { "tenantId": "tenant001" , "flowId": "??" , "flowName": "??" , "flowCode": "??" , "pageNum": 5 , "pageSize": 10 , "authToken": "0************************" } 响应消息样例 { "total": 1, "flowList": [ { "flowId": "201904151183171584", "flowCode": "flow_ivr_5d06dad92731499abbe6cc6ebcb9d29d", "flowName": "按键测试", "flowDesc": null, "scenarioType": "subFlow", "tenantId": "NJ_001", "createDate": 1555293043000, "status": "VALID", "statusDate": 1555401640000, "flowStartNode": "node_view_c157d73a1b5640d280ee1cb4dcb239e2", "flowEndNode": "node_end_97dda8c5a62541c5b44b184a4645f6e8", "ext01": null, "logSwitch": null, "isDefault": "1", "version": "v1", "ruleId": null, "ruleName": null, "source":"IVR", "flowVariableList": [] } ] }
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 flowId String body False 流程ID flowName String body False 流程名称 flowCode String body False 流程编码 source String body False 流程来源 IVR: 来自IVR传统流程 OIFDE:表示来自ODFS配置的智能化流程 不传,默认按照IVR处理 pageNum int body False 页码 分页查询,查询第几页,首页为1 pageSize int body False 每页多少条 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。
  • outparams参数(outaction=11:对话转接类操作) 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) trans_type String body True 对话转移类型 1:转人工(路由码方式转技能队列) 2:转IVR 3:转人工(技能名称方式转技能队列) 4:转人工(转座席工号) 5:转接第三方号码 6:在线数字辅助 7:转人工(转熟客,目前仅支持多媒体) 8:转人工(转座席所在技能队列,目前仅支持多媒体) 31:转多媒体留言(转熟客) 32:转多媒体留言(转技能队列) 33:转多媒体留言(转座席) route_value String body True 路由值信息,依赖trans_type取值,当trans_type= 如下值时: 1,route_value=技能队列后续接入码 2,route_value=IVR流程接入码 3,route_value=技能队列名称 4,route_value=座席工号 5,route_value=第三方号码 6,流程路由码 7,无 8,座席工号 31,无 32,技能队列名称或者接入码 33,座席工号 trans_data String body False 随路数据(转人工时传递) calling_num String body False 呼叫转移第三方号码时,优先使用此号码作为主叫号码 record_path String body False 录音全路径名(仅当route_value=第三方号码时生效,启动会场录音,当为空或不存在时则不录音) inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。 trans_idx String body O(语音导航场景特有字段) 跳转序数。 question_id String body False(语音外呼问卷场景特有字段) 问题id(外呼场景使用)(废弃) question_name String body False(语音外呼问卷场景特有字段) 问题名称(外呼场景使用)(废弃) answer_id String body False(语音外呼问卷场景特有字段) 问题答案(外呼场景使用)(废弃)
  • 响应消息样例4 { "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" }}
  • outparams参数(outaction=10:对话拆线类操作) 注:一通会话结束,都要以IVR发起inaction=9/11且input=hangup的请求后,ODFS触发拆线响应,返回给IVR后为结束标记,IVR此后不再调用ODFS的接口。 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) call_dst_id String body True 接入标识 (1、语音导航场景传入被叫号码; 2、语音外呼问卷场景时为问卷类型id; 3、其他交互场景时传入接入标识)。 start_time String body True 对话交互开始时间 end_time String body True 对话交互结束时间。 release_reason String body False odfs流程走到结束图元是否是正常流程逻辑 0、正常业务逻辑进入结束图元; 1、流程遇到异常、超时等没有容错业务逻辑处理时走到结束图元。 region_id String body False(语音导航场景特有字段) 用户归属地。 entrance_id String body False(语音导航场景特有字段) 入口维度。 exit_id String body False(语音导航场景特有字段) 出口维度,取值同入口维度。 user_type_id String body False(语音导航场景特有字段) 用户类型。 suilu_region_id String body False(语音导航场景特有字段) 呼叫接入地。
  • 响应消息样例5 { "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": 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" }}
  • outparams参数(outaction=12:查询类操作,用于普通IVR流程) 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 prompt_type String body True 查询类型。 1:通话在技能队列中排队时,查询当前技能队列排队信息; 2:通话不在技能队列排队,进入技能队列前,根据技能队列Id查询排队信息; 3:根据座席工号,查询座席所在技能队列信息 5: 音视频切换操作 skill_id String String False 技能队列Id。 prompt_type为2的场景,必填;其他场景无该参数。 moduleName String body False 模块名称,图元的名称 inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。
  • inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码; 2、语音外呼问卷场景时为流程接入码; 3、其他交互场景时传入接入标识。 不超过20位 real_callee String body False 实际接入IVR时的被叫号码,当语音导航场景下有效 不超过32位 cti_callid String body False(语音导航场景特有字段) 华为ivr传入的实际呼叫的CTI的callid,其他场景此值为空 不超过32位 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 suilu_region_id String body False(语音导航场景特有字段) 呼入地。 不超过64位 entrance_id String body False(语音导航场景特有字段) 导航入口。 01:广告语 02:欢迎语 03:首层主菜单 04:人工拦截 05:人工座席 06:直接通过短号接入 07:全语音门户 08:“0”号夜间导航模式 09:夜间全语音门户 10:直接通过自助短号接入 11:人工忙碌 98:其他 99:未识别 mediaType String body False 媒体类型(文本,音频,视频...) channelType String body False 渠道类型 WEB INSTAG RAM TELEGRAM WECHAT FACEBOOK TWITTER EMAIL LINE WHATSAPP 5G SMS responseStyle String body False 回复风格
  • 请求消息样例1 { "userid": "1528780879-9581", "inaction": 8, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian", "suilu_region_id": "025", "entrance_id": "03" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" }}
  • ExtParams参数 参数名称 数据类型 参数位置 必选/可选 描述 transin_data String body False 由接入方跟OIAP约定的随路数据参数,例如IVR传入的数据包参数 locationid String body False 呼叫录音节点号 mediaability String body False 媒体能力 1:音频 2:视频 3:音视频 ieValue String body False 接入方跟OIAP约定的随路数据参数,使用场景为:在与其他的平台对接时,如果呼叫是从其他的第三方的平台转移过来的呼叫,使用该参数携带呼叫信息。 注意:在OIAP的流程中,该参数的取值将会匿名化处理。
  • outparams参数(outaction=9:对话交互类操作) 参数名称 数据类型 参数位置 必选/可选 描述 prompt_type String body True 交互类型。 0: 语音交互 播放指定提示音(全路径) 1:语音交互播放指定提示 2:语音交互播放 TTS 内容 3:文字交互 4:对呼叫方录音 5:视频播放 6:多媒体 7:卡片 prompt_wav String body False(语音导航场景特有字段) 当prompt_type=0,4,5 时填播放或录音的文件全路径名(必须保证为UAP可读取的路径); 当prompt_type=1 时填语音文件名(不包含路径头,播放时由IVR拼接路径头) prompt_text String body True TTS动态文本内容/文字对话内容, 当prompt_type为2、3、6、7时必填 language String body True 语种id(TTS放音以及ASR识别必须传) 0:中文 1:英文 inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。 model_type String body O(语音导航场景特有字段) 模板类型,由7位数字组成。前三位分别代表放音\识别\按键的支持情况(对于放音:1表示支持,0表示不支持;对于识别/按键,1表示支持且会打断放音,2表示支持且不打断放音,0表示不支持)。紧接着两位代表最大按键长度,后两位是*#是否做为功能键(1功能键-#代表确定,*代表取消,0不作为功能键-普通输入键)。 如:1011201代表支持放音按键,不支持识别,最大按键长度为12位,#为确认键。 1101200 代表支持放音识别,不支持按键,后面四位1200无效。 timeout String body False(语音导航场景特有字段) 放音超时时长(秒),放音结束后等待输入超时时间。 tone String body False(语音导航场景特有字段) 当prompt_type=4 录音时必传 true:录音开始前播放“嘀”音 false:录音开始前不播放“嘀”音 vendor String body False(语音导航场景特有字段) 语音识别 扩展参数 grammar String body False(语音导航场景特有字段) 语法文件名(包含路径和后缀) question_id String body False(语音外呼问卷场景特有字段) 问题序号(外呼场景使用),如Q1,Q2;(废弃) question_name String body False(语音外呼问卷场景特有字段) 问题名称(外呼场景使用) (废弃) answer_id String body False(语音外呼问卷场景特有字段) 问题答案(外呼场景使用), 是:Y; 否:N; 超时:TIMEOUT; 拒识:NOMATCH; 其他异常:ERROR 如问题设定非“是”“否”这种答案,则需要以实际约定配置的结果为准 (废弃) flowRecordFlag String body False 是否需要录音标志。 0:需要 1:不需要 不设置的场景,默认为1 flowRecordPath String body False 需要录音时返回录音文件的路径。 ttsGroupId String body False TTS服务器在Uap上配置的GroupId ttsSoundEffect String body False TTS声效 男生朗读:0 女生朗读:1; ttsSoundSpeed String body False TTS音速: 低速朗读:0; 中速朗读:1; 高速朗读:2 ttsMRCPVendor String body False TTS扩展参数,即它的mrcp vendor参数,当前最大长度40 asrMRCPId String body False ASR服务器在Uap上配置的MRCPId asrSlotName String body False 解析ASR识别槽位使用的关键字 asrRecognizeType String body False ASR识别类型 普通识别:0; 智能识别:1 asrNoInputTimeout String body False 用户无话超时时长,默认100,单位s asrRecognitionTimeout String body False 识别结果超时时长,默认200,单位s asrSpeechCompleteTimeout String body False 用户停顿超时长,默认500,单位s responseSource int body False 回复来自机器人还是静默座席,机器人--0,静默座席--1 specialRecognize int body False 是否使用抓包录制的识别 原始识别--0,抓包录制识别--1 Prompt_text格式说明【for 智能信息匹配业务】 参数名称 数据类型 参数位置 必选/可选 Value描述 来源 sensitive_word Json Object body False 敏感词的提醒信息 {"违禁语":["密码"]} TUC敏感词配置 Intend String body True 客户意图 说明文本 TUC意图 recomand_KP List body False 推荐知识点信息 业务知识库 call_script Json String body True 话术推荐 说明: intentcode是TUC意图码,允许为空;intentDsp是意图描述,不能为空 { {intentcode:“”, intentDsp:“”,"status":"",childintent[{intentcode:“”, intentDsp:“”,"status":""},{intentcode:“”, intentDsp:“”, "status":""}…]} { intentcode:“”, intentDsp:“”, "status":""} } ODFS资源模板配置 call_script_matchedstep String body False 意图码 对应上述call_script中的意图码 表示话术进展(被匹配的步骤) TUC意图 Prompt_text格式说明【for 智能工单填写业务】 参数名称 数据类型 参数位置 必选/可选 描述 使用方法 beginIndex String body True 实体在文本中的开始索引位置 实体在文本中的开始索引位置 endIndex String body True 实体在文本中的结束索引位置 实体在文本中的结束索引位置 type String body True 抽取的实体类型 用于标注此实体的识别类型,不需要填入表单 entity String body True 实体内容,已做规则化 用于填入表单对应字段 tag String body True 表单中待填写的字段名 如:对象二级
  • outparams参数(outaction=11:对话转接类操作) 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) trans_type String body True 对话转移类型 1:转人工(路由码方式转技能队列) 2:转IVR 3:转人工(技能名称方式转技能队列) 4:转人工(转座席工号) 5:转接第三方号码 6:在线数字辅助 7:转人工(转熟客,目前仅支持多媒体) 8:转人工(转座席所在技能队列,目前仅支持多媒体) 31:转多媒体留言(转熟客) 32:转多媒体留言(转技能队列) 33:转多媒体留言(转座席) route_value String body True 路由值信息,依赖trans_type取值,当trans_type= 如下值时: 1,route_value=技能队列后续接入码 2,route_value=IVR流程接入码 3,route_value=技能队列名称 4,route_value=座席工号 5,route_value=第三方号码 6,流程路由码 7,无 8,座席工号 31,无 32,技能队列名称或者接入码 33,座席工号 trans_data String body False 随路数据(转人工时传递) calling_num String body False 呼叫转移第三方号码时,优先使用此号码作为主叫号码 record_path String body False 录音全路径名(仅当route_value=第三方号码时生效,启动会场录音,当为空或不存在时则不录音) inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。 trans_idx String body O(语音导航场景特有字段) 跳转序数。 question_id String body False(语音外呼问卷场景特有字段) 问题id(外呼场景使用)(废弃) question_name String body False(语音外呼问卷场景特有字段) 问题名称(外呼场景使用)(废弃) answer_id String body False(语音外呼问卷场景特有字段) 问题答案(外呼场景使用)(废弃)
  • outparams参数(outaction=10:对话拆线类操作) 注:一通会话结束,都要以IVR发起inaction=9/11且input=hangup的请求后,ODFS触发拆线响应,返回给IVR后为结束标记,IVR此后不再调用ODFS的接口。 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) call_dst_id String body True 接入标识 (1、语音导航场景传入被叫号码; 2、语音外呼问卷场景时为问卷类型id; 3、其他交互场景时传入接入标识)。 start_time String body True 对话交互开始时间 end_time String body True 对话交互结束时间。 release_reason String body O odfs流程走到结束图元是否是正常流程逻辑 0、正常业务逻辑进入结束图元; 1、流程遇到异常、超时等没有容错业务逻辑处理时走到结束图元。 region_id String body O(语音导航场景特有字段) 用户归属地。 entrance_id String body O(语音导航场景特有字段) 入口维度。 exit_id String body O(语音导航场景特有字段) 出口维度,取值同入口维度。 user_type_id String body False(语音导航场景特有字段) 用户类型。 suilu_region_id String body False(语音导航场景特有字段) 呼叫接入地。
  • outparams参数(outaction=12:查询类操作,用于普通IVR流程) 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 prompt_type String body True 查询类型。 1:通话在技能队列中排队时,查询当前技能队列排队信息; 2:通话不在技能队列排队,进入技能队列前,根据技能队列Id查询排队信息; 3:根据座席工号,查询座席所在技能队列信息 5: 音视频切换操作 skill_id String String False 技能队列Id。 prompt_type为2的场景,必填;其他场景无该参数。 moduleName String body False 模块名称,图元的名称 inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。
  • 响应消息样例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" }}
  • 响应消息样例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" }}
共100000条