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

查询一触即达意图

查询一触即达意图。

按分类、标题和状态分页查询指定机器人下的一触即达意图。curPage 默认 1,pageSize 默认 50 且最大 50;不传 status 查询全部状态。

请求字段限制:

  • robotId:必填,机器人 ID
  • groupId:选填,意图分类 ID
  • includeChildren:选填,是否包含子分类意图,默认 false,默认值:false
  • searchContent:选填,意图标题搜索关键词
  • status:选填,意图状态:1-已完成,2-草稿;不传查询全部,可选值:1/2
  • curPage:选填,页码,默认 1,默认值:1
  • pageSize:选填,每页条数,默认 50,最大 50,最大值 50,默认值:50

请求参数

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

请求体

名称类型必填描述示例值
robotIdint64是机器人 ID123456
groupIdstring否意图分类 IDgroup-001
includeChildrenboolean否是否包含子分类意图,默认 falsefalse
searchContentstring否意图标题搜索关键词退款
statusstring否意图状态:1-已完成,2-草稿;不传查询全部1
curPageint32否页码,默认 11
pageSizeint32否每页条数,默认 50,最大 5020

返回参数

名称类型描述示例值
codeint32业务状态码,200 表示成功200
messagestring响应消息success
dataobject一触即达意图分页响应
└totalint64符合条件的意图总数20
└listobject[]一触即达意图列表
└dialogueIdstring意图 IDdialogue-001
└intentNamestring意图名称申请退款
└standardSentencestring标准问法如何申请退款
totalint32分页总数,分页接口返回100
requestIdstring链路请求 ID0a1b2c3d4e5f
resultobject部分历史接口使用 result 字段承载业务数据

错误码

状态码描述
14001AppKey 缺失或不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体不是合法 JSON 对象,或参数缺失、格式非法
14009频控限制:接口调用超过限流阈值
14500服务内部错误
14501数据查询范围超出限制
14515当前 AppKey 无接口或资源访问权限
postEndpoint
/openapi/robot/data/mining/botIntents
POST
/openapi/robot/data/mining/botIntents
curl -X POST "https://qiyukf.com/openapi/robot/data/mining/botIntents?appKey=1c088a89de51d0af457616605f28390f&time=1511832531&checksum=f570a5eb049eb803b086e45829b07e48" \  -H "Content-Type: application/json" \  -d '{    "curPage": 1,    "groupId": "group-001",    "pageSize": 20,    "robotId": 123456,    "searchContent": "退款"  }'
{
  "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": "未开通机器人服务"
}

这篇文档有帮助吗?