文档首页/ 云客服/ API参考/ 机器人管理/ 对话接口(V2)
更新时间:2023-09-27 GMT+08:00

对话接口(V2)

场景描述

智能助手平台提供接口给第三方接入方调用,实现初始化、对话交互、对话转移以及拆线的实时对话操作,第三方通过调用该接口能够实现与终端用户的进行多轮对话交互以及办理和查询等业务。

此对话接口(V2)对比原对话接口,区别是对话接口(V2)支持依据vdnId进行灰度路由(在接口url中携带vdnId标识),接口参数与逻辑均与原对话接口相同。

接口方法

设置成“POST”。

URL

https://IP:PORT/oifde/rest/v2/crs/process/{vdnId}

请求说明

表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传递参数,可选的扩展参数,当前只有初始化场景使用。

响应说明

参数名称

数据类型

参数位置

必选/可选

描述

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

用于知会接入方完成操作需要的详细信息,请根据具体的场景查看参数介绍。

返回码

在响应消息体中没有返回码和描述信息,直接使用如下HTTPS协议原生的返回码。

返回码

返回描述

可能原因

解决方案

200

成功响应码

处理成功

-

400

错误请求

请求URL错误

请核对您的请求URL是否正确。

500

业务失败

您请求中的某参数值在系统中不存在,例如,您发送的工单类别编码在系统中不存在。

请依次确认您请求中各参数的取值。

其他

参照标准的HTTPS协议状态码

-

-