对话接口
场景描述
智能助手平台提供接口给第三方接入方调用，实现初始化、对话交互、对话转移以及拆线的实时对话操作，第三方通过调用该接口能够实现与终端用户的进行多轮对话交互以及办理和查询等业务。
接口方法
设置成“POST”。
URL
https://IP:PORT/oifde/rest/crs/process
请求说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
|---|---|---|---|---|
userid |
String |
body |
True |
ODFS根据在Userid内部建立呼叫实例，同一时间ODFS内部可能有多个呼叫实例， 后继的交互根据Userid将同一通电话关联起来。 不超过64位 |
inaction |
int |
body |
True |
接入方本次执行的是什么类型的请求： 8: 对话初始化请求 (第一次调用时) 9: 对话交互后请求 11: 对话转移后请求 注：除了第一次调用时必须为8， 后继传入值即为上次交互接收到的“outaction”即可。 |
seat |
String |
body |
False |
座席类型，不填默认为vir
|
inparams |
Object |
body |
True |
用于向ODFS传递参数，告知ODFS本次操作结果的详细信息，Inaction的值不同，Inparams的参数也不相同，根据下面细分的场景详细了解参数介绍。 |
extparams |
Object |
body |
False |
用于向ODFS传递参数，可选的扩展参数，当前只有初始化场景使用。 Inaction的值不同，extparams的参数也不相同，根据下面细分的场景详细了解参数介绍。 |
响应说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
|---|---|---|---|---|
ret |
int |
body |
True |
执行结果
|
userid |
String |
body |
True |
ODFS根据在userid内部建立呼叫实例，同一时间ODFS内部可能有多个呼叫实例，，后继的交互根据userid将同一通电话关联起来。 |
outaction |
int |
body |
True |
接下来接入方需要执行什么类型的操作
|
outparams |
Object |
body |
True |
用于知会接入方完成操作需要的详细信息，请根据具体的场景查看参数介绍。 |
返回码
在响应消息体中没有返回码和描述信息，直接使用如下HTTPS协议原生的返回码。
返回码 |
返回描述 |
可能原因 |
解决方案 |
|---|---|---|---|
200 |
成功响应码 |
处理成功 |
- |
400 |
错误请求 |
请求URL错误 |
请核对您的请求URL是否正确。 |
500 |
业务失败 |
您请求中的某参数值在系统中不存在，例如，您发送的工单类别编码在系统中不存在。 |
请依次确认您请求中各参数的取值。 |
其他 |
参照标准的HTTPS协议状态码 |
- |
- |
- 对话初始化接口（inaction=8）
接入方首次向ODFS发起请求时，需要发送一条inaction为8的请求，表示通知ODFS初始化，由ODFS在outparams中返回接入方的下一步操作。本节介绍请求参数inparams的具体结构以及请求消息样例，几种不同场景的返回参数结构与消息样例。 - 对话交互后接口（inaction=9）
接入方执行完放音、文字交谈等操作后，将当前操作的结果作为入参，继续请求ODFS下一次的操作，以下是请求参数结构。 - 对话转接后请求（inaction=11）
接入方执行完对话转接操作后，将当前操作的结果作为入参，继续请求ODFS下一次的操作，以下是请求参数结构。 - 对话开启抓包录制请求（inaction=7）
接入方首次向ODFS发起请求时，首先请求ODFS开启宇高录制，但ODFS是否会向宇高请求开启，则还由发布流程时确定。只限对接了抓包系统（如宇高）组网下智能IVR业务 - 请求识别结果（inaction=13）
接入方请求ODFS返回用户语音识别结果，便于进行打断放音等处理。只限对接了抓包系统（如宇高）组网下智能IVR业务
