查询规则标签列表
概述
调用接口,可分页查询当前租户指定机器人下的自定义规则标签(V2),支持按标签名称筛选。
data.list 中每个元素为一个标签,包含该标签的子规则和已保存的匹配条件。列表项与详情接口中的单个标签结构一致,可作为后续编辑的数据来源,无需固定再查询一次详情。提交修改时需按修改接口选取字段,不能将整个列表项原样作为修改请求。
URL
https://aiob-open.baidu.com/api/v1/robot/label/rule/list
HTTP Method
GET
请求参数
HEADER
| 参数名称 | 是否必须 | 说明 | 示例 |
|---|---|---|---|
| Authorization | 是 | 参考“生成认证Token”文档获取完整的 OpenAPI Token,原样传入,不加 Bearer 前缀。 | cc-api-auth-v2/your_token |
PARAM
以下参数通过 URL 查询参数传入,无需请求体。
| 参数名称 | 是否必须 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| robotId | 是 | String | 当前租户的机器人 ID,不能为空。按传入 ID 查询该机器人已保存的标签配置。 | 11111111-1111-4111-8111-111111111111 |
| name | 否 | String | 标签名称,支持模糊匹配。不传、空字符串或全空白时,不按名称筛选;中文需进行 URL 编码。 | 通话 |
| pn | 否 | int | 页码,默认 1,最小值为 1。 | 1 |
| ps | 否 | int | 每页标签数量,默认 100,范围为 1~100。子规则数量不计入每页标签数量。 | 100 |
说明:
- 查询范围由 Authorization 所属租户和 robotId 共同确定。机器人不存在、已删除或不属于当前租户时,返回失败。
- 查询使用传入 robotId 的实际配置,不自动转换草稿或线上 ID。需要修改草稿规则时,应使用草稿 ID 查询相应配置。
- 同时返回启用和禁用的标签及其子规则;结果按标签创建时间倒序排列。本接口只读取配置,不执行规则匹配。
- pn、ps 均须为正整数,本接口不支持传 0 仅查询总数;页码导致的分页偏移超出支持范围时,返回失败。
- 查询成功但没有匹配标签时,data.total 为 0,data.list 为空数组。
- 当前页没有记录时,data.list 也为空数组,但 data.total 可能大于 0。total 始终表示符合查询条件的标签总数,不能仅凭空列表判断没有匹配标签。
响应参数
公共响应字段:
| 字段名称 | 数据类型 | 说明 |
|---|---|---|
| requestId | string | 请求标识,用于定位请求。 |
| time | long | 响应时间戳,单位为毫秒。 |
| code | int | 业务结果码,200 表示成功。 |
| msg | string | 处理结果说明。 |
| data | object | 分页查询结果,字段见下表。 |
data 字段:
| 字段名称 | 数据类型 | 说明 |
|---|---|---|
| pn | int | 本次请求的页码。 |
| ps | int | 本次请求的每页标签数量。 |
| total | long | 符合查询条件的标签总数,按标签计数,不按子规则计数。 |
| list | array<object> |
本页标签列表,每个标签的字段见下表。 |
标签对象字段(data.list 中的每个元素):
| 字段名称 | 数据类型 | 说明 |
|---|---|---|
| id | string | 标签 ID,后续修改、启用、禁用或删除该标签时使用。 |
| name | string | 标签名称。 |
| remark | string | 标签备注,可能为空。 |
| status | int | 标签启用状态:0 禁用,1 启用。标签启停使用专用接口操作。 |
| version | int | 标签配置版本号。修改该标签时原样带回,用于防止旧配置覆盖他人的修改;不是机器人发布版本。 |
| rules | array<object> |
该标签下的子规则列表,无子规则时为空数组。每个子规则的字段见下表。 |
子规则对象字段(rules 中的每个元素):
| 字段名称 | 数据类型 | 说明 |
|---|---|---|
| id | string | 子规则 ID,修改已有子规则时使用。 |
| status | int | 本条子规则的启用状态:0 禁用,1 启用。 |
| version | int | 本条子规则的配置版本号,修改已有子规则时原样带回;与标签自身的 version 分别使用。 |
| labelRuleVO | object | 本条子规则保存的匹配条件,业务字段见下表。 |
标签和子规则均为启用状态时,该子规则才参与匹配。同一标签下多条启用子规则中,任意一条满足即可命中该标签;relation 只控制单条子规则内部各条件的组合关系。
labelRuleVO 字段:
| 字段名称 | 数据类型 | 说明 |
|---|---|---|
| relation | string | 本条子规则内各条件的组合关系:AND 表示全部满足,OR 表示任一满足。 |
| durationExpress | object | 通话时长条件,单位为秒,比较值为整数。 |
| talkingTurnExpress | object | 机器人回复次数条件,比较值为十进制整数字符串。 |
| voiceTalkingTurnExpress | object | 用户回复次数条件,比较值为十进制整数字符串。 |
| callTimesExpress | object | 拨打次数条件,比较值为十进制整数字符串。 |
| connectedTimesExpress | object | 接通次数条件,比较值为十进制整数字符串。 |
| callStatusExpress | object | 接听状态条件,比较值为整数:0 未接听,1 已接听。 |
| callStatusDetailExpress | object | 最终通话状态条件,compareValues 保存状态编码,例如 answered 表示已接听。 |
| hangupExpress | object | 挂断方条件,比较值为整数:0 机器人挂断,1 管理员挂断,2 用户挂断,3 振铃挂断。 |
| artificialExpress | object | 转人工结果条件,比较值为整数:0 未发起,1 成功,-1 失败。 |
| collectInfoExpresses | array<object> |
采集内容匹配条件,每项通过 compareValues 保存比较文本。 |
| modelLabelExpresses | array<object> |
模型标签匹配条件,每项通过 compareValues 保存比较文本,例如“意向:高”。 |
上述条件对象中的主要业务字段:
| 字段名称 | 数据类型 | 说明 |
|---|---|---|
| operator | string | 已保存的比较方式,例如 EQUALS、GTE、BETWEEN、IN、NOT_IN,适用方式由条件类型决定。 |
| compareValue | int 或 string | 单值比较的目标值;BETWEEN 时为区间下界。数值类型见对应条件的说明。 |
| compareValueMax | int 或 string | BETWEEN 区间的上界,区间包含上下界;类型与 compareValue 一致,其他比较方式下可能为空。 |
| compareValues | array<string> |
最终通话状态、采集内容和模型标签等多值条件使用的比较值列表。 |
未配置的条件字段可能为空。只做查询时可忽略 version;修改标签或已有子规则时,分别带回对应版本号,不自行递增。编辑间隔较长或发生版本冲突时,重新查询当前配置后再提交。
查询返回的父标签 status 用于读取当前启用状态。调用修改接口时,父标签 status 需省略或传 null;标签启停请使用启用或禁用接口。调用方需保留本次请求中的 robotId,后续操作仍需使用。
请求示例
1GET https://aiob-open.baidu.com/api/v1/robot/label/rule/list?robotId=11111111-1111-4111-8111-111111111111&pn=1&ps=100
示例中的 robotId 需替换为当前租户实际机器人的 ID。按名称筛选时,追加 name 查询参数。请求头中的 your_token 需替换为实际 Token。
返回示例
以下示例中的标签包含一条启用的子规则,条件为“通话时长不少于 30 秒”。条件对象仅展示已配置的主要业务字段。
1{
2 "requestId": "example-request-id",
3 "time": 1794787200000,
4 "code": 200,
5 "msg": "OK",
6 "data": {
7 "pn": 1,
8 "ps": 100,
9 "total": 1,
10 "list": [
11 {
12 "id": "22222222-2222-4222-8222-222222222222",
13 "name": "通话时长达标",
14 "remark": "通话时长不少于30秒",
15 "status": 1,
16 "version": 0,
17 "rules": [
18 {
19 "id": "33333333-3333-4333-8333-333333333333",
20 "status": 1,
21 "version": 0,
22 "labelRuleVO": {
23 "relation": "AND",
24 "durationExpress": {
25 "operator": "GTE",
26 "compareValue": 30
27 }
28 }
29 }
30 ]
31 }
32 ]
33 }
34}
评价此篇文章
