在线机器人机器人知识库
查询问答回溯记录列表
查询问答回溯记录列表。
接口级参数规则:robotId、startTime、endTime 必填;keyword 最长 50 个字符;page 不传默认 1;pageSize 不传默认 50,最大 50;查询时间不能晚于当天、不可早于近 180 天,且跨度不能超过 30 天。
请求字段限制:
- robotId:必填,机器人 ID,必须属于当前 appKey 对应企业
- keyword:选填,搜索关键词,可搜索问题或会话 ID,最长 50 个字符
- scenario:选填,数组
- evaluation:选填,数组
- transType:选填,数组
- resolved:选填,数组
- startTime:必填,查询开始时间,毫秒时间戳;不可早于近 180 天
- endTime:必填,查询结束时间,毫秒时间戳;不能晚于当天,且与 startTime 间隔不能超过 30 天
- page:选填,页码,从 1 开始;不传默认 1,最小值 1,默认值:1
- pageSize:选填,每页条数;不传默认 50,最大 50,最小值 1,最大值 50,默认值:50
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | 1c088a89de51d0af457616605f28390f |
| time | int64 | 是 | 请求时间戳(秒);与服务器时间误差超过 10 分钟会鉴权失败 | 1511832531 |
| checksum | string | 是 | 请求签名校验和 | f570a5eb049eb803b086e45829b07e48 |
| checksumAlgorithm | int32 | 否 | 签名算法:0-SHA-1,1-SHA-256;不传默认为 0(SHA-1) | 0 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| robotId | int64 | 是 | 机器人 ID,必须属于当前 appKey 对应企业 | 123456 |
| keyword | string | 否 | 搜索关键词,可搜索问题或会话 ID,最长 50 个字符 | 订单什么时候发货 |
| scenario | int32[] | 否 | ||
| evaluation | int32[] | 否 | ||
| transType | int32[] | 否 | ||
| resolved | int32[] | 否 | ||
| startTime | int64 | 是 | 查询开始时间,毫秒时间戳;不可早于近 180 天 | 1700000000000 |
| endTime | int64 | 是 | 查询结束时间,毫秒时间戳;不能晚于当天,且与 startTime 间隔不能超过 30 天 | 1700100000000 |
| page | int32 | 否 | 页码,从 1 开始;不传默认 1 | 1 |
| pageSize | int32 | 否 | 每页条数;不传默认 50,最大 50 | 50 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务状态码,200 表示成功 | 200 |
| message | string | 响应消息 | success |
| data | object[] | 业务数据列表 | |
| └sessionId | int64 | 会话唯一标识 | 1000000001 |
| └question | string | 用户提问的原始文本 | 订单什么时候发货 |
| └answer | string | 系统或人工给出的回答 | 一般 48 小时内发货 |
| └scenario | int32 | 对话发生所属的业务场景:0-机器人,1-在线坐席辅助,2-呼叫坐席辅助 | 0 |
| └isLlm | int32 | 响应来源:0-小模型,1-大模型 | 1 |
| └answerType | int32 | 应答来源类型,取值同服务端 answerType | 2 |
| └agentName | string | Agent 名称;当 answerType 为 Agent 类型时用于展示应答来源 | 售后助手 |
| └accurate | int32 | 标注情况:0-无,1-准确,2-不准确,3-可优化 | 1 |
| └markContent | string | 标注内容 | 回答准确 |
| └evaluation | int32 | 评价状态:1-未评价,2-好评,3-差评 | 2 |
| └transType | int32 | 会话转接情况:0-未转接,1-转接人工,2-转接机器人 | 1 |
| └transStaffName | string | 转接员工名称,用于展示会话转接情况 | 张三 |
| └transferMethod | int32 | 转接方式,取值同服务端 closeReason | 30 |
| └lastMessage | int32 | 是否最后一条消息内容:0-否,1-是 | 1 |
| └resolved | int32 | 会话是否已解决:0-未解决,1-已解决 | 1 |
| └firstResponseTime | int64 | 会话首次响应时间,毫秒时间戳 | 1700000000000 |
| └sessionCategory | string | 会话分类名称,多个分类以逗号拼接 | 售后,订单 |
| └visitorSource | string | 访客来源渠道名称 | Web |
| └visitorName | string | 访客名称 | 访客001 |
| 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/doc/match/recordscurl -X POST "https://qiyukf.com/openapi/robot/doc/match/records?appKey=1c088a89de51d0af457616605f28390f&time=1511832531&checksum=f570a5eb049eb803b086e45829b07e48" \ -H "Content-Type: application/json" \ -d '{ "evaluation": [ 2 ], "transType": [ 1 ], "scenario": [ 0 ], "pageSize": 50, "startTime": 1700000000000, "endTime": 1700100000000, "page": 1, "robotId": 123456, "keyword": "订单什么时候发货", "resolved": [ 1 ] }'{
"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": "未开通机器人服务"
}这篇文档有帮助吗?