七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
在线机器人机器人会话

机器人会话通用结构

机器人会话消息中的通用知识结构、答案结构和 workflow 模板结构。

通用数据结构说明

对接中常见的数据结构说明。

通用知识结构

  • SimpleQuestion
字段类型注释
questionstring问题内容
typeinteger问题类型 1-FAQ 2-内置寒暄 3-自定义寒暄 4-BOT 101-第三方自定义数据
  • 备注:通用知识问题结构,用来描述会话流程中各种问题数据,包括 常见问题/关联问题/相似问题;

通用消息格式

  • CommonMsg:通用的消息描述
字段类型注释
msgTypestring消息类型
msgBodyobject消息内容

枚举消息类型,及每种类型消息体格式

  • text/richtext:文本/富文本类型
字段类型注释
contentstring文本消息体
  • image:图片类型
字段类型注释
urlstring图片资源地址
winteger宽度
hinteger高度
sizeinteger大小
  • video:视频类型
字段类型注释
urlstring视频资源地址
  • audio:音频类型
字段类型注释
urlstring音频资源地址
  • event_trans:转人工事件类型
字段类型注释
closeReasoninteger转人工事件触发原因
transGuidestring转人工引导语
  • workflow:一触即达流程数据类型
字段类型注释
paramsstring节点参数,取系统返回的数据
targetstring节点跳转的目标节点id,取系统返回的数据
templateIdstring样式模版id,可取值范围:qiyu_template_text、drawer_list、bubble_list、qiyu_template_item
templateobject模版数据

template数据格式由templateId决定,格式对应如下:

  • templateId:qiyu_template_text文本模版
字段类型注释
labelstring文本文案,取系统返回数据
  • templateId:qiyu_template_item卡片模版详情
字段类型注释
p_attr_1string卡片属性1,取系统返回数据
p_attr_2string卡片属性2,取系统返回数据
p_attr_3string卡片属性3,取系统返回数据
p_imgstring卡片图片,取系统返回数据
p_titlestring卡片标题,取系统返回数据
p_sub_titlestring卡片子标题,取系统返回数据
  • templateId:drawer_list、bubble_list卡片列表加载更多

此时template传空即可

这篇文档有帮助吗?

目录