查询常见问题

查询常见问题。

请求字段限制：

uid：必填，访客在调用方系统里的唯一标识
robotId：选填，机器人 ID
templateId：选填，常见问题模板 ID
fromType：必填，当前访客咨询来源渠道
productId：选填，当前咨询应用标识
fromPage：选填，当前访客咨询来源页面

请求参数

名称	类型	必填	描述	示例值
appKey	string	是	应用 AppKey	1c088a89de51d0af457616605f28390f
time	int64	是	请求时间戳（秒）；与服务器时间误差超过 10 分钟会鉴权失败	1511832531
checksum	string	是	请求签名校验和	f570a5eb049eb803b086e45829b07e48
checksumAlgorithm	int32	否	签名算法：0-SHA-1，1-SHA-256；不传默认为 0（SHA-1）	0

请求体

名称	类型	必填	描述	示例值
uid	string	是	访客在调用方系统里的唯一标识	user-001
robotId	int64	否	机器人 ID	123456
templateId	int64	否	常见问题模板 ID	10002
fromType	string	是	当前访客咨询来源渠道	web
productId	string	否	当前咨询应用标识	com.example.app
fromPage	string	否	当前访客咨询来源页面	https://example.com/help

返回参数

名称	类型	描述	示例值
code	int32	业务状态码，200 表示成功	200
message	string	响应消息	success
data	object
└robotId	int64	机器人 ID
└questionGuide	string	常见问题引导语
└questionList	object[]	常见问题列表
└id	int64	问题 ID
└type	int32	问题类型：1-FAQ，2-内置寒暄，3-自定义寒暄，4-BOT，101-第三方自定义数据
└question	string	问题内容
└groupQuestions	object[]	分组格式的常见问题列表
└groupName	string	常见问题分组名称
└questions	object[]	常见问题列表
└id	int64	问题 ID
└type	int32	问题类型：1-FAQ，2-内置寒暄，3-自定义寒暄，4-BOT，101-第三方自定义数据
└question	string	问题内容
total	int32	分页总数，分页接口返回	100
requestId	string	链路请求 ID	0a1b2c3d4e5f
result	object	部分历史接口使用 result 字段承载业务数据

错误码

状态码	描述
14001	AppKey 缺失或不存在
14002	checksum 校验失败
14003	请求时间戳与服务器时间误差超过 10 分钟
14004	请求体不是合法 JSON 对象，或参数缺失、格式非法
14009	频控限制：接口调用超过限流阈值
14500	服务内部错误
14501	数据查询范围超出限制
14515	当前 AppKey 无接口或资源访问权限

postEndpoint

/openapi/robot/session/commonQuestions

curl -X POST "https://qiyukf.com/openapi/robot/session/commonQuestions?appKey=1c088a89de51d0af457616605f28390f&time=1511832531&checksum=f570a5eb049eb803b086e45829b07e48" \  -H "Content-Type: application/json" \  -d '{    "uid": "user-001",    "fromType": "web",    "productId": "com.example.app",    "robotId": 123456  }'

{
  "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": "未开通机器人服务"
}