DialogSummaryQuery-查询指定会话对话小结
API访问域名
请求参数
| 字段 |
类型 |
必填 |
说明 |
| Content-Type |
string |
是 |
固定值:application/json |
| token |
String |
是 |
机器人API KEY。 详细获取方式参考:准备工作 |
Body参数
| 字段 |
类型 |
必填 |
说明 |
| startDate |
String |
是 |
对话开始时间,格式:yyyy-MM-dd HH:mm:ss,例如 2025-06-09 00:00:00 |
| endDate |
String |
是 |
对话结束时间,格式:yyyy-MM-dd HH:mm:ss,例如 2025-06-24 23:59:59 |
| searchType |
Integer |
否 |
搜索类型:用户名称 1;会话 ID 3。不传时按时间、渠道分页查询 |
| keyword |
String |
否 |
用户名称搜索关键字。searchType=1 且非空时按用户名称短语匹配;为空时不追加用户名称过滤 |
| sessionIds |
List |
条件必填 |
会话 ID 列表。searchType=3 时必填,单次最多 100 个 |
| order |
String |
否 |
按会话开始时间排序:正序 asc;倒序 desc;默认 desc |
| channel |
List |
否 |
来源渠道列表,例如 ["test_window", "default", "_sys_web"];列表包含 all 时不过滤渠道 |
| pn |
Integer |
否 |
页码,默认 1;小于 1 时按 1 处理 |
| ps |
Integer |
否 |
每页大小。小于 10 或不传时默认 100;默认上限 100 |
请求示例
1{
2 "startDate": "2025-06-09 00:00:00",
3 "endDate": "2025-06-24 23:59:59",
4 "searchType": 3,
5 "sessionIds": [
6 "session_001",
7 "session_002"
8 ],
9 "order": "desc",
10 "channel": [
11 "default",
12 "_sys_web"
13 ],
14 "pn": 1,
15 "ps": 20
16}
响应参数
| 字段 |
类型 |
说明 |
| code |
Integer |
状态码,成功为 200 |
| msg |
String |
状态描述,成功为 OK |
| time |
Long |
响应时间戳 |
| data |
Object |
分页结果,详见data子数据 |
data子数据
| 字段 |
类型 |
说明 |
| total |
Integer |
符合条件的总记录数 |
| pn |
Integer |
当前页码 |
| ps |
Integer |
当前每页大小 |
| totalPn |
Integer |
总页数,由 total 和 ps 计算得到 |
| list |
List<Object> |
当前页记录列表,详见list子数据 |
list子数据
| 字段 |
类型 |
说明 |
| userId |
String |
用户 ID,对应小结索引中的 uid |
| userName |
String |
用户名 |
| sessionId |
String |
对话 ID |
| status |
String |
小结状态,例如 SUCCESS |
| errorMessage |
String |
异常信息。状态为 INVALID_JSON 时固定返回 对话小结抽取结果格式错误。 |
| channel |
String |
渠道 |
| startTime |
String |
本次对话开始时间 |
| endTime |
String |
本次对话结束时间 |
| roundNumber |
Integer |
交互轮次 |
| conversation |
String |
对话内容。若索引中存储的是 bos_ 前缀文件键,服务端会读取文件内容后返回;读取失败时返回空字符串 |
| dialogueSummary |
String |
对话小结 JSON 字符串。仅当小结状态为 SUCCESS 时返回 summaryJson;其他状态返回空字符串 |
小结状态说明
接口返回的 status 取自小结索引中的 summaryStatus 字段;当 summaryStatus 为空时,降级使用索引中的 status 字段。
| 状态 |
说明 |
dialogueSummary |
errorMessage |
| SUCCESS |
小结生成成功,summaryJson 为有效 JSON 字符串 |
返回 summaryJson 原文 |
返回索引中的异常信息,通常为空 |
| INVALID_JSON |
小结抽取结果不是合法 JSON 或不符合解析要求 |
返回空字符串 |
固定返回 对话小结抽取结果格式错误。 |
| INIT |
对话小结任务已初始化,仍在等待对话结束或空闲超时收口 |
返回空字符串 |
返回索引中的异常信息,通常为空 |
| PENDING |
对话小结任务已进入待生成队列,等待后台派发 |
返回空字符串 |
返回索引中的异常信息,通常为空 |
| RUNNING |
对话小结任务已派发,正在生成中 |
返回空字符串 |
返回索引中的异常信息,通常为空 |
| 其他状态 |
兼容生成侧写入的其他状态值,接口透传原始状态 |
返回空字符串 |
返回索引中的异常信息 |
说明:
- 当前 OpenAPI 分页查询不按
status 过滤,命中时间、机器人、渠道、用户名称或会话 ID 条件的记录都会返回。
- 只有
status=SUCCESS 时,接口才会返回 dialogueSummary;其他状态下 dialogueSummary 固定为空字符串。
-
INVALID_JSON 的异常信息会由接口统一转为固定中文提示,其他状态透传索引中的 errorMessage,为空时返回空字符串或空值,取决于序列化配置。
响应示例
1{
2 "code": 200,
3 "msg": "OK",
4 "time": 1710000000000,
5 "data": {
6 "total": 1,
7 "pn": 1,
8 "ps": 20,
9 "totalPn": 1,
10 "list": [
11 {
12 "userId": "user_001",
13 "userName": "张三",
14 "sessionId": "session_001",
15 "status": "SUCCESS",
16 "errorMessage": "",
17 "channel": "default",
18 "startTime": "2025-06-09 10:00:00",
19 "endTime": "2025-06-09 10:05:00",
20 "roundNumber": 5,
21 "conversation": "用户: 投诉。\nAI: 请您描述问题。\n用户: 餐品送来已经没法吃了。",
22 "dialogueSummary": "{\"summary\":\"用户反馈餐品无法食用,机器人已引导用户描述问题。\"}"
23 }
24 ]
25 }
26}
处理规则
-
token 不能为空,且必须能识别到有效机器人;机器人必须存在,且机器人租户 ID 不能为空。
-
startDate 和 endDate 必填,格式必须为 yyyy-MM-dd HH:mm:ss。
- 查询时间范围不能超过 1 个月。当前实现会直接拒绝超过 1 个月的请求,不会自动调整到最近 1 个月或当前时间。
-
order 仅支持 asc、desc,为空默认按 desc 排序。
-
searchType 仅支持 1 和 3。不传 searchType 时按时间、渠道分页查询。
-
searchType=1 时,keyword 非空才追加用户名匹配条件;为空时不按用户名过滤。
-
searchType=3 时,sessionIds 必填,且单次最多 100 个。
-
channel 非空且不包含 all 时,按渠道列表过滤;为空或包含 all 时不过滤渠道。
- 查询范围限定在 token 对应机器人的
tenantId 和 agentId 下。
- 排序字段为本次对话开始时间
startTime;开始时间相同的记录再按小结创建时间 createdTime 排序,两个排序字段使用相同的 order。
- 当前分页查询不按小结状态过滤;返回记录会包含
status 和 errorMessage。其中 dialogueSummary 仅在 status=SUCCESS 时返回小结 JSON 字符串。
- 无匹配记录、索引不存在或 ES 查询异常时,返回成功响应和空分页列表。
常见错误码
| code |
说明 |
| 4040000 |
无效 token,查询不到对应 AI 客服 |
| 4000604 |
agent 不存在 |
| 4009851 |
查询对话小结请求不能为空 |
| 4009852 |
startDate 和 endDate 不能为空 |
| 4009853 |
时间格式必须为 yyyy-MM-dd HH:mm:ss |
| 4009854 |
order 仅支持 asc 或 desc |
| 4009856 |
searchType 仅支持 1 用户名称、3 会话 ID |
| 4009865 |
按会话 ID 查询时 sessionIds 不能为空 |
| 4009850 |
sessionIds 单次最多支持 100 个 |
| 4009857 |
机器人租户为空 |
| 4009866 |
当前查询范围超过 1 个月 |