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

智能辅助

智能辅助。

请求字段限制:

  • robotId:选填,机器人 ID
  • content:必填,用户输入内容
  • uid:必填,访客在调用方系统里的唯一标识
  • fromType:必填,当前访客咨询来源渠道
  • productId:必填,当前咨询应用标识
  • fromPage:选填,当前访客咨询来源页面

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey1c088a89de51d0af457616605f28390f
timeint64是请求时间戳(秒);与服务器时间误差超过 10 分钟会鉴权失败1511832531
checksumstring是请求签名校验和f570a5eb049eb803b086e45829b07e48
checksumAlgorithmint32否签名算法:0-SHA-1,1-SHA-256;不传默认为 0(SHA-1)0

请求体

名称类型必填描述示例值
robotIdint64否机器人 ID123456
contentstring是用户输入内容订单什么时候发货
uidstring是访客在调用方系统里的唯一标识user-001
fromTypestring是当前访客咨询来源渠道web
productIdstring是当前咨询应用标识com.example.app
fromPagestring否当前访客咨询来源页面https://example.com/help

返回参数

名称类型描述示例值
codeint32业务状态码,200 表示成功200
messagestring响应消息success
dataobject
└assistTypeint32机器人辅助回复类型:1-精准回复,2-推荐回复,4-未匹配
└assistContentobject[]辅助回复答案。assistType=1 时有且仅有 1 个问答对,assistType=2 时有 1-3 个问答对
└questionobject
└idint64问题 ID
└typeint32问题类型:1-FAQ,2-内置寒暄,3-自定义寒暄,4-BOT,101-第三方自定义数据
└questionstring问题内容
└answerobject
└msgTypestring消息类型
└msgBodyobject消息内容
└scorefloat匹配得分
totalint32分页总数,分页接口返回100
requestIdstring链路请求 ID0a1b2c3d4e5f
resultobject部分历史接口使用 result 字段承载业务数据

错误码

状态码描述
14001AppKey 缺失或不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体不是合法 JSON 对象,或参数缺失、格式非法
14009频控限制:接口调用超过限流阈值
14500服务内部错误
14501数据查询范围超出限制
14515当前 AppKey 无接口或资源访问权限
postEndpoint
/openapi/robot/session/assist
POST
/openapi/robot/session/assist
curl -X POST "https://qiyukf.com/openapi/robot/session/assist?appKey=1c088a89de51d0af457616605f28390f&time=1511832531&checksum=f570a5eb049eb803b086e45829b07e48" \  -H "Content-Type: application/json" \  -d '{    "uid": "user-001",    "productId": "com.example.app",    "fromType": "web",    "content": "订单什么时候发货"  }'
{
  "code": 200,
  "data": {},
  "message": "success"
}
{
  "code": 14001,
  "message": "AppKey not exists"
}
{
  "code": 14002,
  "message": "Bad checksum"
}
{
  "code": 14003,
  "message": "Bad time"
}
{
  "code": 14004,
  "message": "body内容json解析错误"
}
{
  "code": 14009,
  "message": "单位时间内请求过于频繁"
}
{
  "code": 14500,
  "message": "Internal error"
}
{
  "code": 14501,
  "message": "Data limit exceeded"
}
{
  "code": 14515,
  "message": "未开通机器人服务"
}

这篇文档有帮助吗?