@agentunion/fastaun-browser 0.2.19 → 0.2.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/_packed_docs/CHANGELOG.md +26 -0
- package/_packed_docs/agent.md/SCHEMA.md +173 -0
- package/_packed_docs/agent.md/examples/codeagent-claudecode.md +61 -0
- package/_packed_docs/agent.md/examples/human-developer.md +60 -0
- package/_packed_docs/agent.md/examples/openclaw-lobster.md +52 -0
- package/_packed_docs/agent.md/examples/signed-openclaw-lobster.md +43 -0
- package/_packed_docs/protocol/00-/346/200/273/350/247/210/344/270/216/345/210/206/345/261/202.md +205 -0
- package/_packed_docs/protocol/00A-/350/256/276/350/256/241/345/216/237/345/210/231-/344/270/272Agent/350/200/214/347/224/237.md +197 -0
- package/_packed_docs/protocol/01-/350/272/253/344/273/275/344/270/216/345/207/255/350/257/201/345/215/217/350/256/256-auth.md +549 -0
- package/_packed_docs/protocol/02-/350/257/201/344/271/246/344/270/216/344/277/241/344/273/273/344/275/223/347/263/273.md +810 -0
- package/_packed_docs/protocol/03-Gateway-/350/277/236/346/216/245/346/250/241/345/274/217.md +262 -0
- package/_packed_docs/protocol/04-Peer-/345/255/220/345/215/217/350/256/256.md +180 -0
- package/_packed_docs/protocol/05-Relay-/345/255/220/345/215/217/350/256/256.md +164 -0
- package/_packed_docs/protocol/06-/346/234/215/345/212/241/345/215/217/350/256/256.md +1135 -0
- package/_packed_docs/protocol/07-/351/224/231/350/257/257/347/240/201/344/270/216/347/212/266/346/200/201/346/234/272.md +234 -0
- package/_packed_docs/protocol/08-AUN-E2EE-Group.md +900 -0
- package/_packed_docs/protocol/08-AUN-E2EE.md +413 -0
- package/_packed_docs/protocol/09-/345/256/211/345/205/250/350/200/203/350/231/221.md +316 -0
- package/_packed_docs/protocol/10-Group-/345/255/220/345/215/217/350/256/256.md +804 -0
- package/_packed_docs/protocol/11-Storage-/345/255/220/345/215/217/350/256/256.md +271 -0
- package/_packed_docs/protocol/12-Stream-/345/255/220/345/215/217/350/256/256.md +329 -0
- package/_packed_docs/protocol/13-Agent/350/241/214/344/270/272/350/247/204/350/214/203.md +141 -0
- package/_packed_docs/protocol/14-/344/272/244/344/272/222/346/234/272/345/210/266-/345/223/215/345/272/224/346/250/241/345/274/217/344/270/216/350/207/252/344/270/273/346/250/241/345/274/217.md +170 -0
- package/_packed_docs/protocol/README.md +71 -0
- package/_packed_docs/protocol/agent.md/SCHEMA.md +118 -0
- package/_packed_docs/protocol/agent.md/examples/codeagent-claudecode.md +61 -0
- package/_packed_docs/protocol/agent.md/examples/human-developer.md +60 -0
- package/_packed_docs/protocol/agent.md/examples/openclaw-lobster.md +52 -0
- package/_packed_docs/protocol/aun-docs-guide.md +49 -0
- package/_packed_docs/protocol/index.md +114 -0
- package/_packed_docs/protocol//350/215/211/346/241/210-agent.md/347/255/276/345/220/215/345/215/217/350/256/256.md +205 -0
- package/_packed_docs/protocol//350/215/211/346/241/210-/346/213/222/347/273/235/344/277/241/345/217/267/345/215/217/350/256/256.md +249 -0
- package/_packed_docs/protocol//351/231/204/345/275/225A-/346/234/257/350/257/255/350/241/250.md +337 -0
- package/_packed_docs/protocol//351/231/204/345/275/225B-/346/211/251/345/261/225/346/200/247/346/214/207/345/215/227.md +80 -0
- package/_packed_docs/protocol//351/231/204/345/275/225C-/347/247/201/351/222/245/347/256/241/347/220/206/344/270/216/350/272/253/344/273/275/346/201/242/345/244/215.md +704 -0
- package/_packed_docs/protocol//351/231/204/345/275/225D-Root_CA_/346/262/273/347/220/206/346/234/272/345/210/266.md +620 -0
- package/_packed_docs/protocol//351/231/204/345/275/225E-Root_CA_/345/207/206/345/205/245/346/265/201/347/250/213.md +605 -0
- package/_packed_docs/protocol//351/231/204/345/275/225F-Issuer_CA_/347/224/263/350/257/267/346/265/201/347/250/213.md +548 -0
- package/_packed_docs/protocol//351/231/204/345/275/225G-AID_/345/255/244/345/204/277/351/242/204/351/230/262/344/270/216/346/225/221/346/217/264/346/234/272/345/210/266.md +513 -0
- package/_packed_docs/protocol//351/231/204/345/275/225H-Identity/346/234/215/345/212/241/345/256/236/347/216/260/346/214/207/345/215/227.md +619 -0
- package/_packed_docs/protocol//351/231/204/345/275/225I-/350/267/250/345/237/237/346/266/210/346/201/257/350/267/257/347/224/261/345/256/236/347/216/260/346/214/207/345/215/227.md +492 -0
- package/_packed_docs/protocol//351/231/204/345/275/225J-/345/256/242/346/210/267/347/253/257/346/216/245/345/205/245/347/244/272/344/276/213.md +402 -0
- package/_packed_docs/protocol//351/231/204/345/275/225K-Agent_Web/345/217/221/347/216/260/345/215/217/350/256/256.md +130 -0
- package/_packed_docs/protocol//351/231/204/345/275/225L-E2EE/345/256/236/347/216/260/346/214/207/345/215/227.md +267 -0
- package/_packed_docs/protocol//351/231/204/345/275/225M-JWT/350/256/244/350/257/201/345/256/236/347/216/260/346/214/207/345/215/227.md +367 -0
- package/_packed_docs/sdk/01-/345/277/253/351/200/237/345/274/200/345/247/213.md +223 -0
- package/_packed_docs/sdk/02-WebSocket/345/215/217/350/256/256.md +354 -0
- package/_packed_docs/sdk/03-/346/240/270/345/277/203/346/246/202/345/277/265.md +172 -0
- package/_packed_docs/sdk/04-/350/277/236/346/216/245/344/270/216/350/256/244/350/257/201.md +373 -0
- package/_packed_docs/sdk/05-E2EE/345/212/240/345/257/206/351/200/232/344/277/241.md +611 -0
- package/_packed_docs/sdk/06-API/346/211/213/345/206/214.md +1152 -0
- package/_packed_docs/sdk/07-/351/224/231/350/257/257/345/244/204/347/220/206.md +150 -0
- package/_packed_docs/sdk/08-/346/234/200/344/275/263/345/256/236/350/267/265.md +89 -0
- package/_packed_docs/sdk/09-custody-api-manual.md +445 -0
- package/_packed_docs/sdk/09-group-rpc-manual.md +1895 -0
- package/_packed_docs/sdk/09-message-rpc-manual.md +597 -0
- package/_packed_docs/sdk/09-meta-rpc-manual.md +142 -0
- package/_packed_docs/sdk/09-payload-reference.md +702 -0
- package/_packed_docs/sdk/09-storage-rpc-manual.md +408 -0
- package/_packed_docs/sdk/09-stream-rpc-manual.md +275 -0
- package/_packed_docs/sdk/AUN_DOCS_GUIDE.md +72 -0
- package/_packed_docs/sdk/INDEX.md +131 -0
- package/_packed_docs/sdk/README.md +307 -0
- package/dist/auth.d.ts +2 -1
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +13 -11
- package/dist/auth.js.map +1 -1
- package/dist/client.d.ts +38 -8
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +179 -97
- package/dist/client.js.map +1 -1
- package/dist/namespaces/auth.d.ts +1 -0
- package/dist/namespaces/auth.d.ts.map +1 -1
- package/dist/namespaces/auth.js +20 -6
- package/dist/namespaces/auth.js.map +1 -1
- package/dist/transport.d.ts +9 -1
- package/dist/transport.d.ts.map +1 -1
- package/dist/transport.js +24 -0
- package/dist/transport.js.map +1 -1
- package/package.json +40 -37
|
@@ -0,0 +1,1895 @@
|
|
|
1
|
+
# 群组 — RPC Manual
|
|
2
|
+
|
|
3
|
+
## 权限层级
|
|
4
|
+
|
|
5
|
+
| 角色 | 说明 |
|
|
6
|
+
|------|------|
|
|
7
|
+
| `owner` | 群主,最高权限,可转让 |
|
|
8
|
+
| `admin` | 管理员,可管理成员和群设置 |
|
|
9
|
+
| `member` | 普通成员,可收发消息 |
|
|
10
|
+
| `observer` | 只读成员,仅可接收消息(预留,当前未实现) |
|
|
11
|
+
|
|
12
|
+
## 方法索引
|
|
13
|
+
|
|
14
|
+
### 群组生命周期
|
|
15
|
+
|
|
16
|
+
| 方法 | 说明 |
|
|
17
|
+
|------|------|
|
|
18
|
+
| [group.create](#groupcreate) | 创建群组 |
|
|
19
|
+
| [group.bind_aid](#groupbind_aid) | 为普通群绑定命名 AID |
|
|
20
|
+
| [group.get](#groupget) | 查询群组信息 |
|
|
21
|
+
| [group.update](#groupupdate) | 更新群组资料 |
|
|
22
|
+
| [group.list_my](#grouplist_my) | 列出我的群组 |
|
|
23
|
+
| [group.search](#groupsearch) | 搜索公开群 |
|
|
24
|
+
| [group.get_public_info](#groupget_public_info) | 查询公开群信息 |
|
|
25
|
+
| [group.suspend](#groupsuspend) | 暂停群组 |
|
|
26
|
+
| [group.resume](#groupresume) | 恢复群组 |
|
|
27
|
+
| [group.dissolve](#groupdissolve) | 解散群组 |
|
|
28
|
+
| [group.get_stats](#groupget_stats) | 获取统计信息 |
|
|
29
|
+
|
|
30
|
+
### 成员管理
|
|
31
|
+
|
|
32
|
+
| 方法 | 说明 |
|
|
33
|
+
|------|------|
|
|
34
|
+
| [group.add_member](#groupadd_member) | 添加成员 |
|
|
35
|
+
| [group.get_members](#groupget_members) | 获取成员列表 |
|
|
36
|
+
| [group.kick](#groupkick) | 踢出成员 |
|
|
37
|
+
| [group.leave](#groupleave) | 主动退群 |
|
|
38
|
+
| [group.set_role](#groupset_role) | 设置角色 |
|
|
39
|
+
| [group.transfer_owner](#grouptransfer_owner) | 转让群主 |
|
|
40
|
+
| [group.ban](#groupban) | 封禁成员 |
|
|
41
|
+
| [group.unban](#groupunban) | 解封成员 |
|
|
42
|
+
| [group.get_banlist](#groupget_banlist) | 获取封禁列表 |
|
|
43
|
+
|
|
44
|
+
### 入群流程
|
|
45
|
+
|
|
46
|
+
| 方法 | 说明 |
|
|
47
|
+
|------|------|
|
|
48
|
+
| [group.request_join](#grouprequest_join) | 申请加入 |
|
|
49
|
+
| [group.list_join_requests](#grouplist_join_requests) | 列出待审批申请 |
|
|
50
|
+
| [group.review_join_request](#groupreview_join_request) | 审批申请 |
|
|
51
|
+
| [group.batch_review_join_request](#groupbatch_review_join_request) | 批量审批 |
|
|
52
|
+
| [group.create_invite_code](#groupcreate_invite_code) | 创建邀请码 |
|
|
53
|
+
| [group.list_invite_codes](#grouplist_invite_codes) | 列出邀请码 |
|
|
54
|
+
| [group.use_invite_code](#groupuse_invite_code) | 使用邀请码 |
|
|
55
|
+
| [group.revoke_invite_code](#grouprevoke_invite_code) | 撤销邀请码 |
|
|
56
|
+
|
|
57
|
+
### 设置与分发
|
|
58
|
+
|
|
59
|
+
| 方法 | 说明 |
|
|
60
|
+
|------|------|
|
|
61
|
+
| [group.set_settings](#groupset_settings) | 统一设置群参数,含 `dispatch_mode` |
|
|
62
|
+
| [group.get_settings](#groupget_settings) | 统一读取群参数 |
|
|
63
|
+
| [group.get_dispatch_log](#groupget_dispatch_log) | 查看值班分发日志 |
|
|
64
|
+
|
|
65
|
+
### 消息
|
|
66
|
+
|
|
67
|
+
| 方法 | 说明 |
|
|
68
|
+
|------|------|
|
|
69
|
+
| [group.send](#groupsend) | 发送群消息 |
|
|
70
|
+
| [group.thought.put](#groupthoughtput) | 写入某个群上下文的思考内容 |
|
|
71
|
+
| [group.thought.get](#groupthoughtget) | 获取某个群上下文的思考内容 |
|
|
72
|
+
| [group.pull](#grouppull) | 增量拉取消息 |
|
|
73
|
+
| [group.pull_events](#grouppull_events) | 增量拉取事件 |
|
|
74
|
+
| [group.ack](#groupack) | 确认已读(旧接口,等同 ack_messages) |
|
|
75
|
+
| [group.ack_messages](#groupack_messages) | 确认消息游标 |
|
|
76
|
+
| [group.ack_events](#groupack_events) | 确认事件游标 |
|
|
77
|
+
|
|
78
|
+
### 多设备管理
|
|
79
|
+
|
|
80
|
+
| 方法 | 说明 |
|
|
81
|
+
|------|------|
|
|
82
|
+
| [group.list_devices](#grouplist_devices) | 列出设备列表 |
|
|
83
|
+
| [group.unregister_device](#groupunregister_device) | 注销设备 |
|
|
84
|
+
|
|
85
|
+
### 管理员与成员类型
|
|
86
|
+
|
|
87
|
+
| 方法 | 说明 |
|
|
88
|
+
|------|------|
|
|
89
|
+
| [group.get_admins](#groupget_admins) | 获取管理员列表 |
|
|
90
|
+
| [group.get_master](#groupget_master) | 获取群主信息 |
|
|
91
|
+
| [group.refresh_member_types](#grouprefresh_member_types) | 刷新成员类型统计 |
|
|
92
|
+
|
|
93
|
+
### 统计与指标
|
|
94
|
+
|
|
95
|
+
| 方法 | 说明 |
|
|
96
|
+
|------|------|
|
|
97
|
+
| [group.get_summary](#groupget_summary) | 获取群组摘要 |
|
|
98
|
+
| [group.get_metrics](#groupget_metrics) | 获取性能指标 |
|
|
99
|
+
|
|
100
|
+
### E2EE
|
|
101
|
+
|
|
102
|
+
| 方法 | 说明 |
|
|
103
|
+
|------|------|
|
|
104
|
+
| [group.e2ee.rotate_epoch](#groupe2eerotate_epoch) | 轮换 E2EE 纪元 |
|
|
105
|
+
| [group.e2ee.get_epoch](#groupe2eeget_epoch) | 获取当前 E2EE 纪元 |
|
|
106
|
+
|
|
107
|
+
### 公告与规则
|
|
108
|
+
|
|
109
|
+
| 方法 | 说明 |
|
|
110
|
+
|------|------|
|
|
111
|
+
| [group.get_announcement](#groupget_announcement) | 获取公告 |
|
|
112
|
+
| [group.update_announcement](#groupupdate_announcement) | 更新公告 |
|
|
113
|
+
| [group.get_rules](#groupget_rules) | 获取群规则 |
|
|
114
|
+
| [group.update_rules](#groupupdate_rules) | 更新群规则 |
|
|
115
|
+
| [group.get_join_requirements](#groupget_join_requirements) | 获取入群要求 |
|
|
116
|
+
| [group.update_join_requirements](#groupupdate_join_requirements) | 更新入群要求 |
|
|
117
|
+
|
|
118
|
+
### 资源管理
|
|
119
|
+
|
|
120
|
+
| 方法 | 说明 |
|
|
121
|
+
|------|------|
|
|
122
|
+
| [group.resources.put](#groupresourcesput) | 分享资源 |
|
|
123
|
+
| [group.resources.get](#groupresourcesget) | 查看资源 |
|
|
124
|
+
| [group.resources.list](#groupresourceslist) | 列出资源 |
|
|
125
|
+
| [group.resources.update](#groupresourcesupdate) | 更新资源元数据 |
|
|
126
|
+
| [group.resources.get_access](#groupresourcesget_access) | 获取下载票据 |
|
|
127
|
+
| [group.resources.resolve_access_ticket](#groupresourcesresolve_access_ticket) | 解析访问票据 |
|
|
128
|
+
| [group.resources.delete](#groupresourcesdelete) | 删除资源 |
|
|
129
|
+
| [group.resources.request_add](#groupresourcesrequest_add) | 申请分享 |
|
|
130
|
+
| [group.resources.direct_add](#groupresourcesdirect_add) | 直接添加 |
|
|
131
|
+
| [group.resources.list_pending](#groupresourceslist_pending) | 待审批列表 |
|
|
132
|
+
| [group.resources.approve_request](#groupresourcesapprove_request) | 批准申请 |
|
|
133
|
+
| [group.resources.reject_request](#groupresourcesreject_request) | 拒绝申请 |
|
|
134
|
+
|
|
135
|
+
### 在线状态
|
|
136
|
+
|
|
137
|
+
| 方法 | 说明 |
|
|
138
|
+
|------|------|
|
|
139
|
+
| [group.get_online_members](#groupget_online_members) | 在线成员 |
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## Group ID 规范
|
|
144
|
+
|
|
145
|
+
`group_id` 支持三种输入形式:`g-{slug}`、`g-{slug}@issuer-domain`、`g-{slug}.issuer-domain`。服务端接受输入后会统一规范化为 canonical group_id;本域内 `g-{slug}` 只是简写别名,响应、签名、E2EE AAD 和内部存储使用 canonical 形式。
|
|
146
|
+
|
|
147
|
+
短形式必须以 `g-` 开头,总长度 6 到 16 字符;`slug` 为 4 到 14 位,只能包含小写字母和数字。`group.create` 可以指定 `group_id`,但必须满足该规则且未被占用;如果已被占用会返回错误。不指定 `group_id` 时由服务端自动分配,服务端通过唯一约束兜底,发现碰撞会重新生成。
|
|
148
|
+
|
|
149
|
+
在 `https://group.issuer-domain/...` 这类群链接中,host 已携带 issuer,path 中的 `group_id` 使用本域简写形式,例如 `https://group.agentid.pub/g-abc123/invite/ic-xxx`。
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 群组生命周期
|
|
154
|
+
|
|
155
|
+
### group.create
|
|
156
|
+
|
|
157
|
+
创建群组。调用者自动成为 owner。支持创建命名群(传入 `group_name` + `public_key`)。
|
|
158
|
+
|
|
159
|
+
**参数**:
|
|
160
|
+
|
|
161
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
162
|
+
|------|------|------|------|
|
|
163
|
+
| `name` | string | 是 | 群组显示名称 |
|
|
164
|
+
| `group_id` | string | 否 | 自定义群 ID;不提供则服务端自动生成 |
|
|
165
|
+
| `group_name` | string | 否 | 命名群标识,4-64 字符,`[a-z0-9_-]+`,不以 `guest`/`g-` 开头。与 `public_key` 同时提供时创建命名群 |
|
|
166
|
+
| `public_key` | string | 否 | 命名群公钥(base64 编码),与 `group_name` 同时提供 |
|
|
167
|
+
| `curve` | string | 否 | 密钥曲线,默认 `"P-256"` |
|
|
168
|
+
| `visibility` | string | 否 | `"public"` / `"private"`,默认由配置决定 |
|
|
169
|
+
| `description` | string | 否 | 群组描述 |
|
|
170
|
+
| `metadata` | object | 否 | 自定义元数据 |
|
|
171
|
+
| `avatar_ref` | string | 否 | 头像存储引用 |
|
|
172
|
+
| `join_mode` | string | 否 | `"open"` / `"approval"` / `"invite_only"` / `"closed"`,回退到 visibility 映射 |
|
|
173
|
+
| `join_question` | string | 否 | 入群问题 |
|
|
174
|
+
| `auto_approve_patterns` | array | 否 | 自动批准正则列表 |
|
|
175
|
+
| `max_pending` | integer | 否 | 最大待审批数,默认 100 |
|
|
176
|
+
|
|
177
|
+
**响应**:
|
|
178
|
+
|
|
179
|
+
```json
|
|
180
|
+
{
|
|
181
|
+
"group": {
|
|
182
|
+
"group_id": "group.agentid.pub/10001",
|
|
183
|
+
"name": "测试群",
|
|
184
|
+
"owner_aid": "alice.agentid.pub",
|
|
185
|
+
"creator_aid": "alice.agentid.pub",
|
|
186
|
+
"visibility": "private",
|
|
187
|
+
"status": "active",
|
|
188
|
+
"description": "",
|
|
189
|
+
"metadata": {},
|
|
190
|
+
"member_count": 1,
|
|
191
|
+
"message_seq": 0,
|
|
192
|
+
"event_seq": 0,
|
|
193
|
+
"group_url": "https://group.agentid.pub/10001",
|
|
194
|
+
"group_aid": "my-team.agentid.pub",
|
|
195
|
+
"created_at": 1234567890,
|
|
196
|
+
"updated_at": 1234567890
|
|
197
|
+
},
|
|
198
|
+
"aid_cert": {
|
|
199
|
+
"cert": "-----BEGIN CERTIFICATE-----...",
|
|
200
|
+
"ca_cert": "-----BEGIN CERTIFICATE-----...",
|
|
201
|
+
"ca_chain": [],
|
|
202
|
+
"cert_sn": "abc123",
|
|
203
|
+
"curve": "P-256"
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
> `aid_cert` 仅在命名群创建时返回。`group_aid` 和 `group_url` 仅在命名群时存在。
|
|
209
|
+
|
|
210
|
+
**Group ID 格式**:新格式 `group.{issuer}/{group_no_or_name}`,旧格式 `{digits}.{issuer}` API 返回时自动转换。
|
|
211
|
+
|
|
212
|
+
### group.bind_aid
|
|
213
|
+
|
|
214
|
+
为已有普通群绑定命名 AID(升级为命名群)。仅群主可操作。
|
|
215
|
+
|
|
216
|
+
**参数**:
|
|
217
|
+
|
|
218
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
219
|
+
|------|------|------|------|
|
|
220
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
221
|
+
| `group_name` | string | 是 | 命名群标识,4-64 字符,`[a-z0-9_-]+` |
|
|
222
|
+
| `public_key` | string | 是 | 群公钥(base64 编码) |
|
|
223
|
+
| `curve` | string | 否 | 密钥曲线,默认 `"P-256"` |
|
|
224
|
+
|
|
225
|
+
**响应**:
|
|
226
|
+
|
|
227
|
+
```json
|
|
228
|
+
{
|
|
229
|
+
"group": { "group_id": "...", "group_aid": "my-team.agentid.pub", ... },
|
|
230
|
+
"aid_cert": { "cert": "...", "ca_cert": "...", "ca_chain": [], "cert_sn": "...", "curve": "P-256" }
|
|
231
|
+
}
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### group.get
|
|
235
|
+
|
|
236
|
+
查询群组信息。
|
|
237
|
+
|
|
238
|
+
**参数**:
|
|
239
|
+
|
|
240
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
241
|
+
|------|------|------|------|
|
|
242
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
243
|
+
|
|
244
|
+
**响应**:
|
|
245
|
+
|
|
246
|
+
```json
|
|
247
|
+
{
|
|
248
|
+
"found": true,
|
|
249
|
+
"group_id": "g-abc123.agentid.pub",
|
|
250
|
+
"group": { ... }
|
|
251
|
+
}
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
> 若群组不存在,`found` 为 `false`,`group` 为 `null`。
|
|
255
|
+
|
|
256
|
+
### group.update
|
|
257
|
+
|
|
258
|
+
更新群组资料。需要 admin 及以上权限。
|
|
259
|
+
|
|
260
|
+
**参数**:
|
|
261
|
+
|
|
262
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
263
|
+
|------|------|------|------|
|
|
264
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
265
|
+
| `name` | string | 否 | 新名称 |
|
|
266
|
+
| `visibility` | string | 否 | 新可见性 |
|
|
267
|
+
| `description` | string | 否 | 新描述 |
|
|
268
|
+
| `metadata` | object | 否 | 新元数据 |
|
|
269
|
+
| `avatar_ref` | string | 否 | 新头像存储引用 |
|
|
270
|
+
|
|
271
|
+
### group.list_my
|
|
272
|
+
|
|
273
|
+
列出当前用户加入的群组。`group.list` 是此方法的别名,两者等价。
|
|
274
|
+
|
|
275
|
+
**参数**:
|
|
276
|
+
|
|
277
|
+
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|
|
278
|
+
|------|------|------|--------|------|
|
|
279
|
+
| `size` | integer | 否 | 50 | 返回数量上限(最大 200,受 max_limit 配置限制) |
|
|
280
|
+
|
|
281
|
+
> 也接受 `limit` 作为 `size` 的别名。
|
|
282
|
+
|
|
283
|
+
**响应**:
|
|
284
|
+
|
|
285
|
+
```json
|
|
286
|
+
{
|
|
287
|
+
"items": [
|
|
288
|
+
{
|
|
289
|
+
"group_id": "g-abc123.agentid.pub",
|
|
290
|
+
"name": "项目讨论",
|
|
291
|
+
"visibility": "private",
|
|
292
|
+
"member_count": 5,
|
|
293
|
+
"updated_at": 1234567890,
|
|
294
|
+
"role": "owner"
|
|
295
|
+
}
|
|
296
|
+
],
|
|
297
|
+
"total": 1,
|
|
298
|
+
"page": 1,
|
|
299
|
+
"size": 200,
|
|
300
|
+
"aid": "alice.agentid.pub"
|
|
301
|
+
}
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
> **注意**:当前 `page` 固定为 1,不支持翻页。
|
|
305
|
+
|
|
306
|
+
### group.search
|
|
307
|
+
|
|
308
|
+
搜索公开群组。
|
|
309
|
+
|
|
310
|
+
**参数**:
|
|
311
|
+
|
|
312
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
313
|
+
|------|------|------|------|
|
|
314
|
+
| `query` | string | 否 | 搜索关键词(也接受 `q`) |
|
|
315
|
+
| `size` | integer | 否 | 返回数量上限(也接受 `limit`) |
|
|
316
|
+
|
|
317
|
+
**响应**:
|
|
318
|
+
|
|
319
|
+
```json
|
|
320
|
+
{
|
|
321
|
+
"query": "项目",
|
|
322
|
+
"page": 1,
|
|
323
|
+
"size": 50,
|
|
324
|
+
"items": [ ... ],
|
|
325
|
+
"total": 3
|
|
326
|
+
}
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
> **注意**:当前 `page` 固定为 1,不支持翻页。仅返回公开群组。
|
|
330
|
+
|
|
331
|
+
### group.get_public_info
|
|
332
|
+
|
|
333
|
+
查询公开群组信息。仅限 `visibility=public` 的群组可查询。
|
|
334
|
+
|
|
335
|
+
**参数**:`group_id` (string, 必填)
|
|
336
|
+
|
|
337
|
+
**响应**:
|
|
338
|
+
|
|
339
|
+
```json
|
|
340
|
+
{
|
|
341
|
+
"group_id": "g-abc123.agentid.pub",
|
|
342
|
+
"group": { ... }
|
|
343
|
+
}
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### group.suspend
|
|
347
|
+
|
|
348
|
+
暂停群组。暂停期间不能发送消息。需要 **admin 及以上**权限。
|
|
349
|
+
|
|
350
|
+
**参数**:`group_id` (string, 必填)
|
|
351
|
+
|
|
352
|
+
**响应**:
|
|
353
|
+
|
|
354
|
+
```json
|
|
355
|
+
{
|
|
356
|
+
"group": { ... },
|
|
357
|
+
"status": "suspended"
|
|
358
|
+
}
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
> 若群组已处于暂停状态,`status` 为 `"unchanged"`。
|
|
362
|
+
|
|
363
|
+
### group.resume
|
|
364
|
+
|
|
365
|
+
恢复暂停的群组。需要 **admin 及以上**权限。
|
|
366
|
+
|
|
367
|
+
**参数**:`group_id` (string, 必填)
|
|
368
|
+
|
|
369
|
+
**响应**:
|
|
370
|
+
|
|
371
|
+
```json
|
|
372
|
+
{
|
|
373
|
+
"group": { ... },
|
|
374
|
+
"status": "active"
|
|
375
|
+
}
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
> 若群组已处于活跃状态,`status` 为 `"unchanged"`。
|
|
379
|
+
|
|
380
|
+
### group.dissolve
|
|
381
|
+
|
|
382
|
+
永久解散群组。不可恢复。需要 **owner** 权限。
|
|
383
|
+
|
|
384
|
+
**参数**:`group_id` (string, 必填)
|
|
385
|
+
|
|
386
|
+
**响应**:
|
|
387
|
+
|
|
388
|
+
```json
|
|
389
|
+
{
|
|
390
|
+
"group_id": "g-abc123.agentid.pub",
|
|
391
|
+
"status": "dissolved"
|
|
392
|
+
}
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
### group.get_stats
|
|
396
|
+
|
|
397
|
+
获取群组统计信息。需要 **admin 及以上**权限。
|
|
398
|
+
|
|
399
|
+
**参数**:`group_id` (string, 必填)
|
|
400
|
+
|
|
401
|
+
**响应**:
|
|
402
|
+
|
|
403
|
+
```json
|
|
404
|
+
{
|
|
405
|
+
"group_id": "g-abc123.agentid.pub",
|
|
406
|
+
"status": "active",
|
|
407
|
+
"member_count": 42,
|
|
408
|
+
"message_seq": 1000,
|
|
409
|
+
"event_seq": 500,
|
|
410
|
+
"pending_join_request_count": 3,
|
|
411
|
+
"active_invite_code_count": 2,
|
|
412
|
+
"ban_count": 1,
|
|
413
|
+
"online_count": 10,
|
|
414
|
+
"runtime_stats": { ... },
|
|
415
|
+
"cleanup": { ... }
|
|
416
|
+
}
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
---
|
|
420
|
+
|
|
421
|
+
## 成员管理
|
|
422
|
+
|
|
423
|
+
### group.add_member
|
|
424
|
+
|
|
425
|
+
添加成员。需要 admin 及以上权限。若设置 `role=admin`,需要 owner 权限。
|
|
426
|
+
|
|
427
|
+
**参数**:
|
|
428
|
+
|
|
429
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
430
|
+
|------|------|------|------|
|
|
431
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
432
|
+
| `aid` | string | 是 | 要添加的 AID |
|
|
433
|
+
| `role` | string | 否 | `"admin"` / `"member"`,默认 `"member"` |
|
|
434
|
+
| `member_type` | string | 否 | `"human"` / `"ai"`,默认 `"human"` |
|
|
435
|
+
|
|
436
|
+
**响应**:
|
|
437
|
+
|
|
438
|
+
```json
|
|
439
|
+
{
|
|
440
|
+
"group": { ... },
|
|
441
|
+
"member": {
|
|
442
|
+
"aid": "bob.agentid.pub",
|
|
443
|
+
"role": "member",
|
|
444
|
+
"member_type": "human",
|
|
445
|
+
"joined_at": 1234567890
|
|
446
|
+
}
|
|
447
|
+
}
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
### group.get_members
|
|
451
|
+
|
|
452
|
+
获取成员列表。支持分页和角色过滤。
|
|
453
|
+
|
|
454
|
+
**参数**:
|
|
455
|
+
|
|
456
|
+
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|
|
457
|
+
|------|------|------|--------|------|
|
|
458
|
+
| `group_id` | string | 是 | — | 群组 ID |
|
|
459
|
+
| `page` | integer | 否 | 1 | 页码 |
|
|
460
|
+
| `size` | integer | 否 | 50 | 每页条数(最大 200) |
|
|
461
|
+
| `role` | string | 否 | — | 按角色过滤(owner/admin/member) |
|
|
462
|
+
|
|
463
|
+
**响应**:
|
|
464
|
+
|
|
465
|
+
```json
|
|
466
|
+
{
|
|
467
|
+
"group_id": "g-abc123.agentid.pub",
|
|
468
|
+
"members": [
|
|
469
|
+
{
|
|
470
|
+
"group_id": "g-abc123.agentid.pub",
|
|
471
|
+
"aid": "alice.agentid.pub",
|
|
472
|
+
"role": "owner",
|
|
473
|
+
"member_type": "human",
|
|
474
|
+
"joined_at": 1234567890,
|
|
475
|
+
"last_ack_seq": 100,
|
|
476
|
+
"last_pull_at": 1234567890
|
|
477
|
+
}
|
|
478
|
+
],
|
|
479
|
+
"total": 1,
|
|
480
|
+
"count": 1,
|
|
481
|
+
"page": 1,
|
|
482
|
+
"size": 50
|
|
483
|
+
}
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
### group.kick
|
|
487
|
+
|
|
488
|
+
踢出成员。需要 admin 及以上权限,不能踢 owner。
|
|
489
|
+
|
|
490
|
+
**参数**:
|
|
491
|
+
|
|
492
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
493
|
+
|------|------|------|------|
|
|
494
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
495
|
+
| `aid` | string | 是 | 要踢出的 AID |
|
|
496
|
+
|
|
497
|
+
**响应**:
|
|
498
|
+
|
|
499
|
+
```json
|
|
500
|
+
{
|
|
501
|
+
"group": { ... },
|
|
502
|
+
"removed_aid": "bob.agentid.pub"
|
|
503
|
+
}
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
### group.leave
|
|
507
|
+
|
|
508
|
+
主动退出群组。owner 不能直接退群,需先转让群主。
|
|
509
|
+
|
|
510
|
+
**参数**:`group_id` (string, 必填)
|
|
511
|
+
|
|
512
|
+
**响应**:
|
|
513
|
+
|
|
514
|
+
```json
|
|
515
|
+
{
|
|
516
|
+
"group": { ... },
|
|
517
|
+
"left_aid": "bob.agentid.pub"
|
|
518
|
+
}
|
|
519
|
+
```
|
|
520
|
+
|
|
521
|
+
### group.set_role
|
|
522
|
+
|
|
523
|
+
设置成员角色。需要 **owner** 权限。不能改变 owner 角色。
|
|
524
|
+
|
|
525
|
+
**参数**:
|
|
526
|
+
|
|
527
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
528
|
+
|------|------|------|------|
|
|
529
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
530
|
+
| `aid` | string | 是 | 目标 AID |
|
|
531
|
+
| `role` | string | 是 | `"admin"` / `"member"` |
|
|
532
|
+
|
|
533
|
+
**响应**:
|
|
534
|
+
|
|
535
|
+
```json
|
|
536
|
+
{
|
|
537
|
+
"group_id": "g-abc123.agentid.pub",
|
|
538
|
+
"member": {
|
|
539
|
+
"group_id": "g-abc123.agentid.pub",
|
|
540
|
+
"aid": "bob.agentid.pub",
|
|
541
|
+
"role": "admin",
|
|
542
|
+
"member_type": "human",
|
|
543
|
+
"joined_at": 1234567890,
|
|
544
|
+
"last_ack_seq": 0,
|
|
545
|
+
"last_pull_at": 0
|
|
546
|
+
}
|
|
547
|
+
}
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
### group.transfer_owner
|
|
551
|
+
|
|
552
|
+
转让群主。需要 owner 权限。原 owner 转为 admin。
|
|
553
|
+
|
|
554
|
+
**参数**:
|
|
555
|
+
|
|
556
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
557
|
+
|------|------|------|------|
|
|
558
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
559
|
+
| `new_owner` | string | 是 | 新群主 AID(也接受 `aid`) |
|
|
560
|
+
|
|
561
|
+
**响应**:
|
|
562
|
+
|
|
563
|
+
```json
|
|
564
|
+
{
|
|
565
|
+
"group": { ... },
|
|
566
|
+
"old_owner": "alice.agentid.pub",
|
|
567
|
+
"new_owner": "bob.agentid.pub"
|
|
568
|
+
}
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
### group.ban
|
|
572
|
+
|
|
573
|
+
封禁成员。被封禁者禁止发消息但保留成员身份,且不能重新加入(如先被移除再封禁)。需要 **admin 及以上**权限。
|
|
574
|
+
|
|
575
|
+
**参数**:
|
|
576
|
+
|
|
577
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
578
|
+
|------|------|------|------|
|
|
579
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
580
|
+
| `subject` | string | 是 | 要封禁的 AID(也接受 `aid`) |
|
|
581
|
+
| `reason` | string | 否 | 封禁原因 |
|
|
582
|
+
| `expires_at` | integer | 否 | 过期时间戳(0 = 永久) |
|
|
583
|
+
| `expires_in_seconds` | integer | 否 | 相对过期秒数(0 = 永久) |
|
|
584
|
+
|
|
585
|
+
**响应**:
|
|
586
|
+
|
|
587
|
+
```json
|
|
588
|
+
{
|
|
589
|
+
"group_id": "g-abc123.agentid.pub",
|
|
590
|
+
"ban": {
|
|
591
|
+
"group_id": "g-abc123.agentid.pub",
|
|
592
|
+
"subject": "spammer.agentid.pub",
|
|
593
|
+
"banned_by": "alice.agentid.pub",
|
|
594
|
+
"reason": "垃圾消息",
|
|
595
|
+
"expires_at": 0,
|
|
596
|
+
"created_at": 1234567890
|
|
597
|
+
}
|
|
598
|
+
}
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
### group.unban
|
|
602
|
+
|
|
603
|
+
解除封禁。需要 **admin 及以上**权限。
|
|
604
|
+
|
|
605
|
+
**参数**:`group_id` (string), `subject` 或 `aid` (string)
|
|
606
|
+
|
|
607
|
+
**响应**:
|
|
608
|
+
|
|
609
|
+
```json
|
|
610
|
+
{
|
|
611
|
+
"group_id": "g-abc123.agentid.pub",
|
|
612
|
+
"subject": "spammer.agentid.pub",
|
|
613
|
+
"status": "removed"
|
|
614
|
+
}
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
### group.get_banlist
|
|
618
|
+
|
|
619
|
+
获取封禁列表。需要 **admin 及以上**权限。
|
|
620
|
+
|
|
621
|
+
**参数**:`group_id` (string, 必填)
|
|
622
|
+
|
|
623
|
+
**响应**:
|
|
624
|
+
|
|
625
|
+
```json
|
|
626
|
+
{
|
|
627
|
+
"group_id": "g-abc123.agentid.pub",
|
|
628
|
+
"items": [
|
|
629
|
+
{
|
|
630
|
+
"group_id": "g-abc123.agentid.pub",
|
|
631
|
+
"subject": "spammer.agentid.pub",
|
|
632
|
+
"banned_by": "alice.agentid.pub",
|
|
633
|
+
"reason": "垃圾消息",
|
|
634
|
+
"expires_at": 0,
|
|
635
|
+
"created_at": 1234567890
|
|
636
|
+
}
|
|
637
|
+
],
|
|
638
|
+
"total": 1,
|
|
639
|
+
"page": 1,
|
|
640
|
+
"size": 200
|
|
641
|
+
}
|
|
642
|
+
```
|
|
643
|
+
|
|
644
|
+
---
|
|
645
|
+
|
|
646
|
+
## 入群流程
|
|
647
|
+
|
|
648
|
+
### group.request_join
|
|
649
|
+
|
|
650
|
+
申请加入群组。根据群组 join_mode 设置,有三种结果分支。
|
|
651
|
+
|
|
652
|
+
**参数**:
|
|
653
|
+
|
|
654
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
655
|
+
|------|------|------|------|
|
|
656
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
657
|
+
| `message` | string | 否 | 申请留言 |
|
|
658
|
+
| `answer` | string | 否 | 入群问题的答案 |
|
|
659
|
+
|
|
660
|
+
**响应**(三种分支):
|
|
661
|
+
|
|
662
|
+
**1. 自动加入**(open 模式或匹配自动批准规则):
|
|
663
|
+
|
|
664
|
+
```json
|
|
665
|
+
{
|
|
666
|
+
"status": "joined",
|
|
667
|
+
"group": { ... },
|
|
668
|
+
"member": { ... }
|
|
669
|
+
}
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
**2. 需要回答问题**(approval 模式但未提供答案):
|
|
673
|
+
|
|
674
|
+
```json
|
|
675
|
+
{
|
|
676
|
+
"status": "question_required",
|
|
677
|
+
"question": "请描述你的用途"
|
|
678
|
+
}
|
|
679
|
+
```
|
|
680
|
+
|
|
681
|
+
**3. 待审批**(approval 模式且已提供答案):
|
|
682
|
+
|
|
683
|
+
```json
|
|
684
|
+
{
|
|
685
|
+
"status": "pending",
|
|
686
|
+
"request": {
|
|
687
|
+
"group_id": "g-abc123.agentid.pub",
|
|
688
|
+
"aid": "carol.agentid.pub",
|
|
689
|
+
"message": "请加我",
|
|
690
|
+
"answer": "...",
|
|
691
|
+
"status": "pending",
|
|
692
|
+
"created_at": 1234567890,
|
|
693
|
+
"updated_at": 1234567890,
|
|
694
|
+
"expires_at": 1234654290,
|
|
695
|
+
"reviewed_by": null,
|
|
696
|
+
"rejection_reason": null
|
|
697
|
+
}
|
|
698
|
+
}
|
|
699
|
+
```
|
|
700
|
+
|
|
701
|
+
### group.list_join_requests
|
|
702
|
+
|
|
703
|
+
列出待审批申请。需要 admin 权限。
|
|
704
|
+
|
|
705
|
+
**参数**:
|
|
706
|
+
|
|
707
|
+
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|
|
708
|
+
|------|------|------|--------|------|
|
|
709
|
+
| `group_id` | string | 是 | — | 群组 ID |
|
|
710
|
+
| `status` | string | 否 | `"pending"` | `"pending"` / `"approved"` / `"rejected"` |
|
|
711
|
+
| `page` | integer | 否 | 1 | 页码 |
|
|
712
|
+
| `size` | integer | 否 | — | 每页数量 |
|
|
713
|
+
|
|
714
|
+
**响应**:
|
|
715
|
+
|
|
716
|
+
```json
|
|
717
|
+
{
|
|
718
|
+
"group_id": "g-abc123.agentid.pub",
|
|
719
|
+
"items": [
|
|
720
|
+
{
|
|
721
|
+
"group_id": "g-abc123.agentid.pub",
|
|
722
|
+
"aid": "carol.agentid.pub",
|
|
723
|
+
"message": "请加我",
|
|
724
|
+
"status": "pending",
|
|
725
|
+
"created_at": 1234567890,
|
|
726
|
+
"updated_at": 1234567890
|
|
727
|
+
}
|
|
728
|
+
],
|
|
729
|
+
"total": 1,
|
|
730
|
+
"page": 1,
|
|
731
|
+
"size": 50
|
|
732
|
+
}
|
|
733
|
+
```
|
|
734
|
+
|
|
735
|
+
### group.review_join_request
|
|
736
|
+
|
|
737
|
+
审批单个申请。需要 admin 权限。**使用 `aid` 定位申请**(非 request_id)。
|
|
738
|
+
|
|
739
|
+
**参数**:
|
|
740
|
+
|
|
741
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
742
|
+
|------|------|------|------|
|
|
743
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
744
|
+
| `aid` | string | 是 | 申请人 AID |
|
|
745
|
+
| `approve` | boolean | 否 | 批准或拒绝,默认 `true` |
|
|
746
|
+
| `reason` | string | 否 | 拒绝原因 |
|
|
747
|
+
|
|
748
|
+
**响应**(批准时):
|
|
749
|
+
|
|
750
|
+
```json
|
|
751
|
+
{
|
|
752
|
+
"status": "approved",
|
|
753
|
+
"request": { ... },
|
|
754
|
+
"group": { ... }
|
|
755
|
+
}
|
|
756
|
+
```
|
|
757
|
+
|
|
758
|
+
**响应**(拒绝时):
|
|
759
|
+
|
|
760
|
+
```json
|
|
761
|
+
{
|
|
762
|
+
"status": "rejected",
|
|
763
|
+
"request": {
|
|
764
|
+
"group_id": "g-abc123.agentid.pub",
|
|
765
|
+
"aid": "carol.agentid.pub",
|
|
766
|
+
"status": "rejected",
|
|
767
|
+
"reviewed_by": "alice.agentid.pub",
|
|
768
|
+
"rejection_reason": "不符合条件"
|
|
769
|
+
}
|
|
770
|
+
}
|
|
771
|
+
```
|
|
772
|
+
|
|
773
|
+
### group.batch_review_join_request
|
|
774
|
+
|
|
775
|
+
批量审批入群申请。需要 admin 权限。
|
|
776
|
+
|
|
777
|
+
**参数**:
|
|
778
|
+
|
|
779
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
780
|
+
|------|------|------|------|
|
|
781
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
782
|
+
| `requests` | array | 是 | 审批列表 |
|
|
783
|
+
|
|
784
|
+
`requests` 数组每项:
|
|
785
|
+
|
|
786
|
+
| 字段 | 类型 | 必填 | 说明 |
|
|
787
|
+
|------|------|------|------|
|
|
788
|
+
| `aid` | string | 是 | 申请人 AID |
|
|
789
|
+
| `approve` | boolean | 是 | 批准或拒绝 |
|
|
790
|
+
| `reason` | string | 否 | 拒绝原因 |
|
|
791
|
+
|
|
792
|
+
**响应**:
|
|
793
|
+
|
|
794
|
+
```json
|
|
795
|
+
{
|
|
796
|
+
"results": [
|
|
797
|
+
{"aid": "carol.agentid.pub", "ok": true, "status": "approved", "request": { ... }},
|
|
798
|
+
{"aid": "dave.agentid.pub", "ok": false, "error": "not found"}
|
|
799
|
+
],
|
|
800
|
+
"success_count": 1,
|
|
801
|
+
"fail_count": 1
|
|
802
|
+
}
|
|
803
|
+
```
|
|
804
|
+
|
|
805
|
+
### group.create_invite_code
|
|
806
|
+
|
|
807
|
+
创建邀请码。需要 owner/admin 权限,或群规则允许成员邀请。
|
|
808
|
+
|
|
809
|
+
**参数**:
|
|
810
|
+
|
|
811
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
812
|
+
|------|------|------|------|
|
|
813
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
814
|
+
| `code` | string | 否 | 自定义邀请码(不提供则自动生成) |
|
|
815
|
+
| `max_uses` | integer | 否 | 最大使用次数,默认 1,必须 > 0 |
|
|
816
|
+
| `expires_in_seconds` | integer | 否 | 有效期(秒),默认由 invite_code_ttl_days 配置(7 天) |
|
|
817
|
+
|
|
818
|
+
**响应**:
|
|
819
|
+
|
|
820
|
+
```json
|
|
821
|
+
{
|
|
822
|
+
"group_id": "g-abc123.agentid.pub",
|
|
823
|
+
"invite_code": {
|
|
824
|
+
"group_id": "g-abc123.agentid.pub",
|
|
825
|
+
"code": "ic-a1b2c3d4e5",
|
|
826
|
+
"created_by": "alice.agentid.pub",
|
|
827
|
+
"expires_at": 1235172690,
|
|
828
|
+
"max_uses": 10,
|
|
829
|
+
"used_count": 0,
|
|
830
|
+
"status": "active",
|
|
831
|
+
"created_at": 1234567890
|
|
832
|
+
}
|
|
833
|
+
}
|
|
834
|
+
```
|
|
835
|
+
|
|
836
|
+
### group.use_invite_code
|
|
837
|
+
|
|
838
|
+
使用邀请码加入群组。
|
|
839
|
+
|
|
840
|
+
**参数**:`code` (string, 必填,自动转为小写)
|
|
841
|
+
|
|
842
|
+
**响应**:
|
|
843
|
+
|
|
844
|
+
```json
|
|
845
|
+
{
|
|
846
|
+
"status": "joined",
|
|
847
|
+
"group": { ... },
|
|
848
|
+
"invite_code": { ... }
|
|
849
|
+
}
|
|
850
|
+
```
|
|
851
|
+
|
|
852
|
+
### group.list_invite_codes
|
|
853
|
+
|
|
854
|
+
列出群组的邀请码。需要 admin 权限。
|
|
855
|
+
|
|
856
|
+
**参数**:`group_id` (string, 必填)
|
|
857
|
+
|
|
858
|
+
### group.revoke_invite_code
|
|
859
|
+
|
|
860
|
+
撤销邀请码。需要 admin 权限。
|
|
861
|
+
|
|
862
|
+
**参数**:`group_id` (string), `code` (string)
|
|
863
|
+
|
|
864
|
+
---
|
|
865
|
+
|
|
866
|
+
## 设置与分发
|
|
867
|
+
|
|
868
|
+
### group.set_settings
|
|
869
|
+
|
|
870
|
+
统一写入群参数。需要 admin 及以上权限。`dispatch_mode` 是群消息的应用层分发模式标签,会随 `group.send` 生成的消息持久化,并由 SDK 在解密后注入到消息顶层和 `payload.dispatch_mode`。
|
|
871
|
+
|
|
872
|
+
`dispatch_mode` 不是 `group.send` 的单次入参;要修改后续消息的模式,请通过 `group.set_settings` 更新群设置。
|
|
873
|
+
|
|
874
|
+
**参数**:
|
|
875
|
+
|
|
876
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
877
|
+
|------|------|------|------|
|
|
878
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
879
|
+
| `settings` | object | 是 | 要写入的设置键值 |
|
|
880
|
+
| `settings["dispatch_mode"]` | string | 否 | `"broadcast"` / `"mention"`,默认 `"broadcast"` |
|
|
881
|
+
| `settings["rules.content"]` | string | 否 | 群规则正文 |
|
|
882
|
+
| `settings["announcement.content"]` | string | 否 | 群公告正文 |
|
|
883
|
+
|
|
884
|
+
**预定义群级参数**:
|
|
885
|
+
|
|
886
|
+
| key | 类型 | 默认值 / 初始化逻辑 | 说明 |
|
|
887
|
+
|-----|------|-------------------|------|
|
|
888
|
+
| `name` | string | 创建群时传入;兼容路径可能用 `group_id` 补齐 | 群名称 |
|
|
889
|
+
| `description` | string | `""` | 群描述 |
|
|
890
|
+
| `visibility` | string | `"private"` | 群可见性:`"public"` / `"private"`;旧值 `"invite_only"` 会映射为 `"private"` |
|
|
891
|
+
| `rules.content` | string | `""` | 群规则正文 |
|
|
892
|
+
| `rules.attachments` | array | `[]` | 群规则附件 |
|
|
893
|
+
| `announcement.content` | string | `""` | 群公告正文 |
|
|
894
|
+
| `announcement.attachments` | array | `[]` | 群公告附件 |
|
|
895
|
+
| `join.mode` | string | 按 `visibility` 推导:`public -> open`,`private -> approval` | 入群模式:`"open"` / `"approval"` / `"invite_only"` / `"closed"` |
|
|
896
|
+
| `join.question` | string | `""` | 入群问题 |
|
|
897
|
+
| `join.auto_approve_patterns` | array | `[]` | 自动批准 AID 匹配规则 |
|
|
898
|
+
| `join.max_pending` | integer | `100` | 最大待审批入群申请数 |
|
|
899
|
+
| `dispatch_mode` | string | `"broadcast"` | 群消息分发标签:`"broadcast"` / `"mention"`;未显式设置时 `get_settings` 仍返回默认值 |
|
|
900
|
+
|
|
901
|
+
```python
|
|
902
|
+
await client.call("group.set_settings", {
|
|
903
|
+
"group_id": "g-abc123.agentid.pub",
|
|
904
|
+
"settings": {"dispatch_mode": "mention"},
|
|
905
|
+
})
|
|
906
|
+
```
|
|
907
|
+
|
|
908
|
+
**响应**:
|
|
909
|
+
|
|
910
|
+
```json
|
|
911
|
+
{
|
|
912
|
+
"group_id": "g-abc123.agentid.pub",
|
|
913
|
+
"updated_keys": ["dispatch_mode"]
|
|
914
|
+
}
|
|
915
|
+
```
|
|
916
|
+
|
|
917
|
+
### group.get_settings
|
|
918
|
+
|
|
919
|
+
统一读取群参数。成员可读;不传 `keys` 时返回核心群资料和 settings 表中的全部设置。未显式设置 `dispatch_mode` 时,服务端仍返回默认值 `"broadcast"`。
|
|
920
|
+
|
|
921
|
+
**参数**:
|
|
922
|
+
|
|
923
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
924
|
+
|------|------|------|------|
|
|
925
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
926
|
+
| `keys` | array | 否 | 只读取指定 key,如 `["dispatch_mode", "rules.content"]` |
|
|
927
|
+
|
|
928
|
+
**响应**:
|
|
929
|
+
|
|
930
|
+
```json
|
|
931
|
+
{
|
|
932
|
+
"group_id": "g-abc123.agentid.pub",
|
|
933
|
+
"settings": [
|
|
934
|
+
{"key": "dispatch_mode", "value": "broadcast", "updated_at": 1234567890000}
|
|
935
|
+
]
|
|
936
|
+
}
|
|
937
|
+
```
|
|
938
|
+
|
|
939
|
+
### group.get_dispatch_log
|
|
940
|
+
|
|
941
|
+
读取值班分发日志。成员可读,主要用于诊断 `dispatch.mode=duty`、超时回退、批量分发等运行时行为。
|
|
942
|
+
|
|
943
|
+
**参数**:
|
|
944
|
+
|
|
945
|
+
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|
|
946
|
+
|------|------|------|--------|------|
|
|
947
|
+
| `group_id` | string | 是 | — | 群组 ID |
|
|
948
|
+
| `date` | string | 否 | 当天 | 日志日期,格式由服务端日志文件名解析 |
|
|
949
|
+
| `size` / `limit` | integer | 否 | 100 | 返回最后 N 条,最大 500 |
|
|
950
|
+
|
|
951
|
+
**响应**:
|
|
952
|
+
|
|
953
|
+
```json
|
|
954
|
+
{
|
|
955
|
+
"group_id": "g-abc123.agentid.pub",
|
|
956
|
+
"items": [],
|
|
957
|
+
"total": 0,
|
|
958
|
+
"page": 1,
|
|
959
|
+
"size": 100
|
|
960
|
+
}
|
|
961
|
+
```
|
|
962
|
+
|
|
963
|
+
---
|
|
964
|
+
|
|
965
|
+
## 消息
|
|
966
|
+
|
|
967
|
+
### group.send
|
|
968
|
+
|
|
969
|
+
发送群消息。需要 member 权限。
|
|
970
|
+
|
|
971
|
+
群消息的持久化 `dispatch_mode` 来自群设置,取值为 `"broadcast"` / `"mention"`;服务端会写入消息对象并在 pull / push 中返回。运行时是否广播全员或分发给值班 Agent,由响应中的 `dispatch` / `message_dispatch` 描述。
|
|
972
|
+
|
|
973
|
+
**参数**:
|
|
974
|
+
|
|
975
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
976
|
+
|------|------|------|------|
|
|
977
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
978
|
+
| `payload` | object | 否 | 消息内容 |
|
|
979
|
+
| `type` | string | 否 | 信封/封装类型,普通业务消息无需填写;SDK 加密群消息时自动使用 `e2ee.group_encrypted` |
|
|
980
|
+
| `attachments` | array | 否 | 兼容旧接口的顶层附件元数据;推荐把业务附件放入 `payload.attachments` |
|
|
981
|
+
| `protected_headers` / `headers` | object | 否 | SDK 加密前读取的 E2EE 信封元数据,类似 HTTP headers;服务端不解释,接收端验 `_auth` 后在 `e2ee.protected_headers` 暴露 |
|
|
982
|
+
|
|
983
|
+
### Payload 参考约定
|
|
984
|
+
|
|
985
|
+
`group.send.params.payload` 的统一业务负载格式见 [09-payload-reference](09-payload-reference.md)。完整群消息请求仍在 `payload` 同级传入 `group_id`;业务类型放在 `payload.type`,不要与 `group.send.params.type` 信封/封装类型混用。
|
|
986
|
+
|
|
987
|
+
`protected_headers` 只在 SDK 加密路径生效;裸 RPC 发送明文或已加密信封时,调用方需自行遵守 [05-E2EE加密通信](05-E2EE加密通信.md#protectedheaders-与可验证上下文) 的格式和校验规则。
|
|
988
|
+
|
|
989
|
+
**响应**:
|
|
990
|
+
|
|
991
|
+
```json
|
|
992
|
+
{
|
|
993
|
+
"group_id": "g-abc123.agentid.pub",
|
|
994
|
+
"message": {
|
|
995
|
+
"group_id": "g-abc123.agentid.pub",
|
|
996
|
+
"seq": 42,
|
|
997
|
+
"message_id": "uuid",
|
|
998
|
+
"sender_aid": "alice.agentid.pub",
|
|
999
|
+
"message_type": "e2ee.group_encrypted",
|
|
1000
|
+
"dispatch_mode": "broadcast",
|
|
1001
|
+
"payload": {"type": "e2ee.group_encrypted", "...": "..."},
|
|
1002
|
+
"attachments": [],
|
|
1003
|
+
"created_at": 1234567890000
|
|
1004
|
+
},
|
|
1005
|
+
"event": { ... },
|
|
1006
|
+
"dispatch_mode": "broadcast",
|
|
1007
|
+
"dispatch": {"mode": "broadcast", "reason": "duty_disabled"},
|
|
1008
|
+
"message_dispatch": { ... }
|
|
1009
|
+
}
|
|
1010
|
+
```
|
|
1011
|
+
|
|
1012
|
+
| 字段 | 类型 | 说明 |
|
|
1013
|
+
|------|------|------|
|
|
1014
|
+
| `group_id` | string | 群组 ID |
|
|
1015
|
+
| `message` | object | 消息对象(含 seq、message_id、sender_aid 等) |
|
|
1016
|
+
| `event` | object | 关联的群事件对象 |
|
|
1017
|
+
| `dispatch_mode` | string | 群消息持久化分发模式标签:`"broadcast"` / `"mention"`;SDK 解密后也会注入到 `payload.dispatch_mode` |
|
|
1018
|
+
| `dispatch` | object | 分发策略:`mode` 为 `"broadcast"`(广播全员)或 `"duty"`(值班分发);`reason` 说明原因(如 `"duty_disabled"` / `"active_duty"` / `"no_duty_candidate"` 等) |
|
|
1019
|
+
| `duty_state` | object | 可选,值班模式下的当前状态 |
|
|
1020
|
+
| `message_dispatch` | object | 运行时分发结果;常见 `status` 包括 `"broadcast"`、`"sent"`、`"queued_batch"`、`"debounced"`、`"skipped"`、`"failed"` |
|
|
1021
|
+
|
|
1022
|
+
### group.thought.put
|
|
1023
|
+
|
|
1024
|
+
写入某个发送者针对一个群上下文的思考内容。该内容不是普通群消息:服务端不分配消息 `seq`,不广播,不进入 `group.pull`,不需要 ack,也不持久化;只在内存中保留当前 head。
|
|
1025
|
+
|
|
1026
|
+
SDK 调用时必须走群组 E2EE。应用层传入明文 `payload`,SDK 会加密成 `e2ee.group_encrypted` 信封、补齐 `thought_id` / `timestamp`,并附加 `client_signature`。裸 WebSocket 客户端若绕过 SDK,则必须自行完成同等加密和签名。
|
|
1027
|
+
|
|
1028
|
+
存储键为 `group_id + sender_aid + context.type + context.id`。其中 `sender_aid` 由服务端认证态派生,不能由客户端指定;`context` 是 thought head 的唯一 selector,推荐使用 `{"type": "run", "id": "run-xxx"}`。同一 `(group_id, sender_aid)` 保留最近 N 个 context 对应的 head,N 由群服务配置 `max_thought_heads_per_sender` 控制,当前默认值为 5;同一个 head 下可追加多条 thought item。
|
|
1029
|
+
|
|
1030
|
+
**参数**:
|
|
1031
|
+
|
|
1032
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1033
|
+
|------|------|------|------|
|
|
1034
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1035
|
+
| `context.type` | string | 是 | 思考的上下文类型,推荐 `run` |
|
|
1036
|
+
| `context.id` | string | 是 | 思考的上下文 ID,如 `run_id` |
|
|
1037
|
+
| `payload` | object | 是 | SDK 加密前的思考内容;推荐格式见 [09-payload-reference](09-payload-reference.md#thought思考内容) |
|
|
1038
|
+
| `encrypt` | boolean | 否 | SDK 侧固定按 `true` 处理;`false` 会被拒绝 |
|
|
1039
|
+
| `thought_id` | string | 否 | thought item ID;不传时 SDK 生成 `gt-*` |
|
|
1040
|
+
| `timestamp` | integer | 否 | 客户端时间戳;不传时 SDK 生成 |
|
|
1041
|
+
| `protected_headers` / `headers` | object | 否 | SDK 加密前读取的 E2EE 信封元数据;`context` 会被 SDK 复制进信封并单独验 `_auth` |
|
|
1042
|
+
|
|
1043
|
+
**SDK 调用示例**:
|
|
1044
|
+
|
|
1045
|
+
```python
|
|
1046
|
+
await client.call("group.thought.put", {
|
|
1047
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1048
|
+
"context": {"type": "run", "id": "run-xxx"},
|
|
1049
|
+
"payload": {"type": "thought", "text": "这是 Agent 自己的 run 级思考"},
|
|
1050
|
+
})
|
|
1051
|
+
```
|
|
1052
|
+
|
|
1053
|
+
**裸 RPC 加密后形态**:
|
|
1054
|
+
|
|
1055
|
+
```json
|
|
1056
|
+
{
|
|
1057
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1058
|
+
"context": {"type": "run", "id": "run-xxx"},
|
|
1059
|
+
"thought_id": "gt-...",
|
|
1060
|
+
"type": "e2ee.group_encrypted",
|
|
1061
|
+
"encrypted": true,
|
|
1062
|
+
"payload": {"type": "e2ee.group_encrypted", "...": "..."},
|
|
1063
|
+
"client_signature": { "...": "..." }
|
|
1064
|
+
}
|
|
1065
|
+
```
|
|
1066
|
+
|
|
1067
|
+
**响应**:
|
|
1068
|
+
|
|
1069
|
+
```json
|
|
1070
|
+
{
|
|
1071
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1072
|
+
"sender_aid": "alice.agentid.pub",
|
|
1073
|
+
"context": {"type": "run", "id": "run-xxx"},
|
|
1074
|
+
"thought_id": "gt-...",
|
|
1075
|
+
"stored_count": 1,
|
|
1076
|
+
"updated_at": 1234567890000
|
|
1077
|
+
}
|
|
1078
|
+
```
|
|
1079
|
+
|
|
1080
|
+
### group.thought.get
|
|
1081
|
+
|
|
1082
|
+
读取指定发送者针对指定群上下文的当前思考内容。SDK 会在返回应用层前自动解密。`get` 是查询操作,可重复调用;它不触发 push/pull、ack 或 replay 消费。
|
|
1083
|
+
|
|
1084
|
+
**参数**:
|
|
1085
|
+
|
|
1086
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1087
|
+
|------|------|------|------|
|
|
1088
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1089
|
+
| `sender_aid` | string | 是 | thought 作者 AID |
|
|
1090
|
+
| `context.type` | string | 是 | 思考的上下文类型,推荐 `run` |
|
|
1091
|
+
| `context.id` | string | 是 | 思考的上下文 ID,如 `run_id` |
|
|
1092
|
+
|
|
1093
|
+
**SDK 调用示例**:
|
|
1094
|
+
|
|
1095
|
+
```python
|
|
1096
|
+
result = await client.call("group.thought.get", {
|
|
1097
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1098
|
+
"sender_aid": "alice.agentid.pub",
|
|
1099
|
+
"context": {"type": "run", "id": "run-xxx"},
|
|
1100
|
+
})
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
**SDK 返回**:
|
|
1104
|
+
|
|
1105
|
+
响应会原样包含本次查询使用的 selector(`context`)。
|
|
1106
|
+
|
|
1107
|
+
```json
|
|
1108
|
+
{
|
|
1109
|
+
"found": true,
|
|
1110
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1111
|
+
"sender_aid": "alice.agentid.pub",
|
|
1112
|
+
"context": {"type": "run", "id": "run-xxx"},
|
|
1113
|
+
"thoughts": [
|
|
1114
|
+
{
|
|
1115
|
+
"thought_id": "gt-...",
|
|
1116
|
+
"message_id": "gt-...",
|
|
1117
|
+
"context": {"type": "run", "id": "run-xxx"},
|
|
1118
|
+
"payload": {"type": "thought", "text": "正在比较两个候选方案"},
|
|
1119
|
+
"created_at": 1234567890000,
|
|
1120
|
+
"e2ee": {"encryption_mode": "epoch_group_key"}
|
|
1121
|
+
}
|
|
1122
|
+
],
|
|
1123
|
+
"updated_at": 1234567890000
|
|
1124
|
+
}
|
|
1125
|
+
```
|
|
1126
|
+
|
|
1127
|
+
未找到当前 head 时,SDK 返回 `found=false` 且 `thoughts=[]`。
|
|
1128
|
+
|
|
1129
|
+
### group.pull
|
|
1130
|
+
|
|
1131
|
+
增量拉取群消息。事件请用 `group.pull_events` 单独拉取。
|
|
1132
|
+
|
|
1133
|
+
**参数**:
|
|
1134
|
+
|
|
1135
|
+
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|
|
1136
|
+
|------|------|------|--------|------|
|
|
1137
|
+
| `group_id` | string | 是 | — | 群组 ID |
|
|
1138
|
+
| `after_message_seq` | integer | 否 | 0 | 从该消息 seq 之后拉取 |
|
|
1139
|
+
| `limit` | integer | 否 | 100 | 最大条数 |
|
|
1140
|
+
| `device_id` | string | 否 | — | 设备 ID(多设备模式) |
|
|
1141
|
+
|
|
1142
|
+
**响应**:
|
|
1143
|
+
|
|
1144
|
+
```json
|
|
1145
|
+
{
|
|
1146
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1147
|
+
"messages": [ ... ],
|
|
1148
|
+
"latest_message_seq": 42,
|
|
1149
|
+
"has_more": false,
|
|
1150
|
+
"limit": 100
|
|
1151
|
+
}
|
|
1152
|
+
```
|
|
1153
|
+
|
|
1154
|
+
多设备模式时额外返回 `cursor` 对象(含 `current_seq`、`join_seq`、`latest_seq`、`unread_count`)。
|
|
1155
|
+
|
|
1156
|
+
返回的每条群消息包含 `dispatch_mode`。Python / Go / TS / JS SDK 在解密后会保留顶层 `dispatch_mode`,并把同一值注入到 `payload.dispatch_mode`,方便应用层按 `"broadcast"` / `"mention"` 做 UI 或通知策略。
|
|
1157
|
+
|
|
1158
|
+
### group.ack
|
|
1159
|
+
|
|
1160
|
+
提交群消息已读游标。等同于 `group.ack_messages`,需要 `device_id`。
|
|
1161
|
+
|
|
1162
|
+
**参数**:
|
|
1163
|
+
|
|
1164
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1165
|
+
|------|------|------|------|
|
|
1166
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1167
|
+
| `device_id` | string | 是 | 设备 ID |
|
|
1168
|
+
| `msg_seq` | integer | 是 | 确认到的消息序号 |
|
|
1169
|
+
|
|
1170
|
+
**响应**:
|
|
1171
|
+
|
|
1172
|
+
```json
|
|
1173
|
+
{"cursor": 42}
|
|
1174
|
+
```
|
|
1175
|
+
|
|
1176
|
+
---
|
|
1177
|
+
|
|
1178
|
+
## 公告与规则
|
|
1179
|
+
|
|
1180
|
+
### group.get_announcement
|
|
1181
|
+
|
|
1182
|
+
获取群公告。
|
|
1183
|
+
|
|
1184
|
+
**参数**:`group_id` (string, 必填)
|
|
1185
|
+
|
|
1186
|
+
**响应**:
|
|
1187
|
+
|
|
1188
|
+
```json
|
|
1189
|
+
{
|
|
1190
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1191
|
+
"announcement": { ... }
|
|
1192
|
+
}
|
|
1193
|
+
```
|
|
1194
|
+
|
|
1195
|
+
### group.update_announcement
|
|
1196
|
+
|
|
1197
|
+
更新群公告。需要 **admin 及以上**权限。
|
|
1198
|
+
|
|
1199
|
+
**参数**:
|
|
1200
|
+
|
|
1201
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1202
|
+
|------|------|------|------|
|
|
1203
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1204
|
+
| `content` | string | 是 | 公告内容(上限由 announcement_max_length 配置,默认 4000) |
|
|
1205
|
+
| `attachments` | array | 否 | 存储引用数组 |
|
|
1206
|
+
|
|
1207
|
+
**响应**:
|
|
1208
|
+
|
|
1209
|
+
```json
|
|
1210
|
+
{
|
|
1211
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1212
|
+
"announcement": { ... }
|
|
1213
|
+
}
|
|
1214
|
+
```
|
|
1215
|
+
|
|
1216
|
+
### group.get_rules
|
|
1217
|
+
|
|
1218
|
+
获取群规则。
|
|
1219
|
+
|
|
1220
|
+
**参数**:`group_id` (string, 必填)
|
|
1221
|
+
|
|
1222
|
+
**响应**:
|
|
1223
|
+
|
|
1224
|
+
```json
|
|
1225
|
+
{
|
|
1226
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1227
|
+
"rules": { ... }
|
|
1228
|
+
}
|
|
1229
|
+
```
|
|
1230
|
+
|
|
1231
|
+
### group.update_rules
|
|
1232
|
+
|
|
1233
|
+
更新群规则。需要 **admin 及以上**权限。
|
|
1234
|
+
|
|
1235
|
+
**参数**:`group_id` (string) + 规则字段(max_members, allow_member_invite 等,均可选)
|
|
1236
|
+
|
|
1237
|
+
### group.get_join_requirements
|
|
1238
|
+
|
|
1239
|
+
获取入群要求。
|
|
1240
|
+
|
|
1241
|
+
**参数**:`group_id` (string, 必填)
|
|
1242
|
+
|
|
1243
|
+
**响应**:
|
|
1244
|
+
|
|
1245
|
+
```json
|
|
1246
|
+
{
|
|
1247
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1248
|
+
"join_requirements": {
|
|
1249
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1250
|
+
"mode": "approval",
|
|
1251
|
+
"question": "请描述你的用途",
|
|
1252
|
+
"auto_approve_patterns": [],
|
|
1253
|
+
"max_pending": 100,
|
|
1254
|
+
"updated_by": "alice.agentid.pub",
|
|
1255
|
+
"updated_at": 1234567890
|
|
1256
|
+
}
|
|
1257
|
+
}
|
|
1258
|
+
```
|
|
1259
|
+
|
|
1260
|
+
### group.update_join_requirements
|
|
1261
|
+
|
|
1262
|
+
更新入群要求。需要 **admin 及以上**权限。
|
|
1263
|
+
|
|
1264
|
+
**参数**:
|
|
1265
|
+
|
|
1266
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1267
|
+
|------|------|------|------|
|
|
1268
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1269
|
+
| `mode` | string | 否 | `"open"` / `"approval"` / `"invite_only"` / `"closed"` |
|
|
1270
|
+
| `question` | string | 否 | 入群问题 |
|
|
1271
|
+
| `auto_approve_patterns` | array | 否 | 自动批准正则列表 |
|
|
1272
|
+
| `max_pending` | integer | 否 | 最大待审批数 |
|
|
1273
|
+
|
|
1274
|
+
---
|
|
1275
|
+
|
|
1276
|
+
## 资源管理
|
|
1277
|
+
|
|
1278
|
+
### group.resources.put
|
|
1279
|
+
|
|
1280
|
+
分享资源链接到群组。需要 **member 及以上**权限。
|
|
1281
|
+
|
|
1282
|
+
**参数**:
|
|
1283
|
+
|
|
1284
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1285
|
+
|------|------|------|------|
|
|
1286
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1287
|
+
| `resource_path` | string | 是 | 资源路径 |
|
|
1288
|
+
| `resource_type` | string | 否 | `"file"` / `"folder"` / `"link"`,默认 `"file"` |
|
|
1289
|
+
| `title` | string | 是 | 资源标题 |
|
|
1290
|
+
| `storage_ref` | object | 否 | 存储引用对象 |
|
|
1291
|
+
| `metadata` | object | 否 | 自定义元数据 |
|
|
1292
|
+
| `visibility` | string | 否 | `"members_only"` / `"public"`,默认 `"members_only"` |
|
|
1293
|
+
| `tags` | array | 否 | 标签数组 |
|
|
1294
|
+
|
|
1295
|
+
**响应**:
|
|
1296
|
+
|
|
1297
|
+
```json
|
|
1298
|
+
{
|
|
1299
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1300
|
+
"resource": { ... },
|
|
1301
|
+
"created": true
|
|
1302
|
+
}
|
|
1303
|
+
```
|
|
1304
|
+
|
|
1305
|
+
> `created` 为 `true` 表示新建,`false` 表示更新已有资源。
|
|
1306
|
+
|
|
1307
|
+
### group.resources.get
|
|
1308
|
+
|
|
1309
|
+
查看资源详情。
|
|
1310
|
+
|
|
1311
|
+
**参数**:`group_id` (string), `resource_path` (string)
|
|
1312
|
+
|
|
1313
|
+
### group.resources.list
|
|
1314
|
+
|
|
1315
|
+
列出群资源。
|
|
1316
|
+
|
|
1317
|
+
**参数**:
|
|
1318
|
+
|
|
1319
|
+
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|
|
1320
|
+
|------|------|------|--------|------|
|
|
1321
|
+
| `group_id` | string | 是 | — | 群组 ID |
|
|
1322
|
+
| `prefix` | string | 否 | — | 资源路径前缀 |
|
|
1323
|
+
| `owner_aid` | string | 否 | — | 筛选创建者 |
|
|
1324
|
+
| `visibility` | string | 否 | — | 筛选可见性 |
|
|
1325
|
+
| `tags` | array | 否 | — | 筛选标签 |
|
|
1326
|
+
| `sort_by` | string | 否 | `"resource_path"` | 排序字段 |
|
|
1327
|
+
| `order` | string | 否 | `"asc"` | `"asc"` / `"desc"` |
|
|
1328
|
+
| `size` | integer | 否 | 50 | 每页数量(也接受 `limit`) |
|
|
1329
|
+
| `page` | integer | 否 | 1 | 页码(也接受 `offset`) |
|
|
1330
|
+
|
|
1331
|
+
**响应**:
|
|
1332
|
+
|
|
1333
|
+
```json
|
|
1334
|
+
{
|
|
1335
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1336
|
+
"prefix": "",
|
|
1337
|
+
"owner_aid": null,
|
|
1338
|
+
"visibility": null,
|
|
1339
|
+
"tags": [],
|
|
1340
|
+
"limit": 50,
|
|
1341
|
+
"size": 50,
|
|
1342
|
+
"offset": 0,
|
|
1343
|
+
"page": 1,
|
|
1344
|
+
"items": [ ... ],
|
|
1345
|
+
"count": 3,
|
|
1346
|
+
"total": 3
|
|
1347
|
+
}
|
|
1348
|
+
```
|
|
1349
|
+
|
|
1350
|
+
### group.resources.get_access
|
|
1351
|
+
|
|
1352
|
+
获取资源下载票据。
|
|
1353
|
+
|
|
1354
|
+
**参数**:`group_id` (string), `resource_path` (string)
|
|
1355
|
+
|
|
1356
|
+
**响应**:
|
|
1357
|
+
|
|
1358
|
+
```json
|
|
1359
|
+
{
|
|
1360
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1361
|
+
"resource_path": "/docs/guide.pdf",
|
|
1362
|
+
"resource_link": "storage://...",
|
|
1363
|
+
"resource": { ... },
|
|
1364
|
+
"access_ticket": {
|
|
1365
|
+
"ticket": "tk_...",
|
|
1366
|
+
"ticket_type": "group-resource-access",
|
|
1367
|
+
"issued_to": "alice.agentid.pub",
|
|
1368
|
+
"resource_link": "storage://...",
|
|
1369
|
+
"issued_at": 1234567890,
|
|
1370
|
+
"expire_at": 1234571490
|
|
1371
|
+
},
|
|
1372
|
+
"access_token": "tk_...",
|
|
1373
|
+
"token_type": "Bearer",
|
|
1374
|
+
"download": { ... }
|
|
1375
|
+
}
|
|
1376
|
+
```
|
|
1377
|
+
|
|
1378
|
+
### group.resources.delete
|
|
1379
|
+
|
|
1380
|
+
删除群资源链接。需要 admin 权限。
|
|
1381
|
+
|
|
1382
|
+
**参数**:`group_id` (string), `resource_path` (string)
|
|
1383
|
+
|
|
1384
|
+
**响应**:`{ "group_id": "g-abc123.agentid.pub", "resource_path": "/path/to/file" }`
|
|
1385
|
+
|
|
1386
|
+
### group.resources.update
|
|
1387
|
+
|
|
1388
|
+
更新资源元数据。需要 admin 及以上权限。
|
|
1389
|
+
|
|
1390
|
+
**参数**:`group_id` (必填), `resource_path` (必填), `title` / `metadata` / `tags` / `visibility` (可选)
|
|
1391
|
+
|
|
1392
|
+
**响应**:`{ "group_id": "g-abc123.agentid.pub", "resource": { ... } }`
|
|
1393
|
+
|
|
1394
|
+
### group.resources.resolve_access_ticket
|
|
1395
|
+
|
|
1396
|
+
使用访问票据换取下载令牌。
|
|
1397
|
+
|
|
1398
|
+
**参数**:`ticket` (string, 必填)
|
|
1399
|
+
|
|
1400
|
+
**响应**:`{ "resource": { ... }, "download": { ... } }`
|
|
1401
|
+
|
|
1402
|
+
### group.resources.request_add
|
|
1403
|
+
|
|
1404
|
+
成员申请分享资源(需审批)。
|
|
1405
|
+
|
|
1406
|
+
**参数**:同 `group.resources.put`(不需要 `storage_ref`)。
|
|
1407
|
+
|
|
1408
|
+
**响应**:
|
|
1409
|
+
|
|
1410
|
+
```json
|
|
1411
|
+
{
|
|
1412
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1413
|
+
"request": {
|
|
1414
|
+
"request_id": "req_...",
|
|
1415
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1416
|
+
"requester_aid": "bob.agentid.pub",
|
|
1417
|
+
"resource_path": "/docs/my-file.pdf",
|
|
1418
|
+
"resource_type": "file",
|
|
1419
|
+
"title": "我的文件",
|
|
1420
|
+
"status": "pending",
|
|
1421
|
+
"created_at": 1234567890,
|
|
1422
|
+
"updated_at": 1234567890,
|
|
1423
|
+
"visibility": "members_only",
|
|
1424
|
+
"tags": [],
|
|
1425
|
+
"reviewed_by": null,
|
|
1426
|
+
"review_note": null,
|
|
1427
|
+
"resource_created": false
|
|
1428
|
+
}
|
|
1429
|
+
}
|
|
1430
|
+
```
|
|
1431
|
+
|
|
1432
|
+
### group.resources.direct_add
|
|
1433
|
+
|
|
1434
|
+
Owner 直接添加资源(无需审批)。需要 **owner** 权限。
|
|
1435
|
+
|
|
1436
|
+
**参数**:同 `group.resources.put`(`resource_type` 不能是 `"folder"`)。
|
|
1437
|
+
|
|
1438
|
+
**响应**:同 `group.resources.put`。
|
|
1439
|
+
|
|
1440
|
+
### group.resources.list_pending
|
|
1441
|
+
|
|
1442
|
+
列出待审批的资源申请。需要 **owner** 权限。
|
|
1443
|
+
|
|
1444
|
+
**参数**:`group_id` (string)
|
|
1445
|
+
|
|
1446
|
+
### group.resources.approve_request
|
|
1447
|
+
|
|
1448
|
+
批准资源申请。需要 **owner** 权限。
|
|
1449
|
+
|
|
1450
|
+
**参数**:`request_id` (string, 必填), `note` (string, 可选)
|
|
1451
|
+
|
|
1452
|
+
**响应**:
|
|
1453
|
+
|
|
1454
|
+
```json
|
|
1455
|
+
{
|
|
1456
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1457
|
+
"request": { ... },
|
|
1458
|
+
"resource": { ... }
|
|
1459
|
+
}
|
|
1460
|
+
```
|
|
1461
|
+
|
|
1462
|
+
### group.resources.reject_request
|
|
1463
|
+
|
|
1464
|
+
拒绝资源申请。需要 **owner** 权限。
|
|
1465
|
+
|
|
1466
|
+
**参数**:`request_id` (string, 必填), `note` (string, 可选)
|
|
1467
|
+
|
|
1468
|
+
**响应**:
|
|
1469
|
+
|
|
1470
|
+
```json
|
|
1471
|
+
{
|
|
1472
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1473
|
+
"request": { ... }
|
|
1474
|
+
}
|
|
1475
|
+
```
|
|
1476
|
+
|
|
1477
|
+
---
|
|
1478
|
+
|
|
1479
|
+
## 在线状态
|
|
1480
|
+
|
|
1481
|
+
### group.get_online_members
|
|
1482
|
+
|
|
1483
|
+
获取当前在线成员列表。
|
|
1484
|
+
|
|
1485
|
+
**参数**:`group_id` (string, 必填)
|
|
1486
|
+
|
|
1487
|
+
**响应**:
|
|
1488
|
+
|
|
1489
|
+
```json
|
|
1490
|
+
{
|
|
1491
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1492
|
+
"total": 2,
|
|
1493
|
+
"page": 1,
|
|
1494
|
+
"size": 200,
|
|
1495
|
+
"online_count": 2,
|
|
1496
|
+
"members": [
|
|
1497
|
+
{
|
|
1498
|
+
"aid": "alice.agentid.pub",
|
|
1499
|
+
"role": "owner",
|
|
1500
|
+
"joined_at": 1234567890,
|
|
1501
|
+
"online": true,
|
|
1502
|
+
"session_id": "sess_123",
|
|
1503
|
+
"last_active_at": 1234567890,
|
|
1504
|
+
"expire_at": 1234571490
|
|
1505
|
+
}
|
|
1506
|
+
]
|
|
1507
|
+
}
|
|
1508
|
+
```
|
|
1509
|
+
|
|
1510
|
+
兼容字段:`items`、`online_members` 与 `members` 内容完全相同;新实现应优先读取 `members`。
|
|
1511
|
+
|
|
1512
|
+
---
|
|
1513
|
+
|
|
1514
|
+
## 多设备游标
|
|
1515
|
+
|
|
1516
|
+
### group.pull_events
|
|
1517
|
+
|
|
1518
|
+
增量拉取群事件,支持多设备独立游标。
|
|
1519
|
+
|
|
1520
|
+
**参数**:
|
|
1521
|
+
|
|
1522
|
+
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|
|
1523
|
+
|------|------|------|--------|------|
|
|
1524
|
+
| `group_id` | string | 是 | — | 群组 ID |
|
|
1525
|
+
| `device_id` | string | 否 | — | 设备 ID,多设备模式必填 |
|
|
1526
|
+
| `device_name` | string | 否 | — | 设备名称(首次注册时使用) |
|
|
1527
|
+
| `device_type` | string | 否 | — | 设备类型 |
|
|
1528
|
+
| `after_event_seq` | integer | 否 | 游标位置 | 从该事件 seq 之后拉取;多设备模式下默认使用设备游标 |
|
|
1529
|
+
| `limit` | integer | 否 | 100 | 最大条数(受 `pull_max_limit` 配置限制) |
|
|
1530
|
+
|
|
1531
|
+
**响应**:
|
|
1532
|
+
|
|
1533
|
+
```json
|
|
1534
|
+
{
|
|
1535
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1536
|
+
"events": [ ... ],
|
|
1537
|
+
"latest_event_seq": 100,
|
|
1538
|
+
"has_more": false,
|
|
1539
|
+
"limit": 100,
|
|
1540
|
+
"cursor": {
|
|
1541
|
+
"current_seq": 50,
|
|
1542
|
+
"join_seq": 0,
|
|
1543
|
+
"latest_seq": 100,
|
|
1544
|
+
"unread_count": 50
|
|
1545
|
+
}
|
|
1546
|
+
}
|
|
1547
|
+
```
|
|
1548
|
+
|
|
1549
|
+
> `cursor` 仅多设备模式(提供 `device_id`)时返回。响应大小受 `pull_max_response_bytes` 配置限制。包含 E2EE epoch 范围检查,不返回成员加入前的加密事件。
|
|
1550
|
+
|
|
1551
|
+
### group.ack_messages
|
|
1552
|
+
|
|
1553
|
+
确认消息游标(多设备模式)。
|
|
1554
|
+
|
|
1555
|
+
**参数**:
|
|
1556
|
+
|
|
1557
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1558
|
+
|------|------|------|------|
|
|
1559
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1560
|
+
| `device_id` | string | 是 | 设备 ID |
|
|
1561
|
+
| `msg_seq` | integer | 是 | 确认到的消息序号 |
|
|
1562
|
+
|
|
1563
|
+
**响应**:`{ "cursor": 123 }`
|
|
1564
|
+
|
|
1565
|
+
> 不能确认加入位置之前的消息;序号自动截断到群组当前最大消息序号。
|
|
1566
|
+
|
|
1567
|
+
### group.ack_events
|
|
1568
|
+
|
|
1569
|
+
确认事件游标(多设备模式)。
|
|
1570
|
+
|
|
1571
|
+
**参数**:
|
|
1572
|
+
|
|
1573
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1574
|
+
|------|------|------|------|
|
|
1575
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1576
|
+
| `device_id` | string | 是 | 设备 ID |
|
|
1577
|
+
| `event_seq` | integer | 是 | 确认到的事件序号 |
|
|
1578
|
+
|
|
1579
|
+
**响应**:`{ "cursor": 456 }`
|
|
1580
|
+
|
|
1581
|
+
### group.list_devices
|
|
1582
|
+
|
|
1583
|
+
列出当前用户在指定群组的所有设备及游标状态。
|
|
1584
|
+
|
|
1585
|
+
**参数**:`group_id` (必填)
|
|
1586
|
+
|
|
1587
|
+
**响应**:
|
|
1588
|
+
|
|
1589
|
+
```json
|
|
1590
|
+
{
|
|
1591
|
+
"devices": [
|
|
1592
|
+
{
|
|
1593
|
+
"device_id": "device-123",
|
|
1594
|
+
"device_name": "My Phone",
|
|
1595
|
+
"device_type": "mobile",
|
|
1596
|
+
"last_pull_at": 1234567890000,
|
|
1597
|
+
"msg_unread": 10,
|
|
1598
|
+
"event_unread": 5
|
|
1599
|
+
}
|
|
1600
|
+
]
|
|
1601
|
+
}
|
|
1602
|
+
```
|
|
1603
|
+
|
|
1604
|
+
### group.unregister_device
|
|
1605
|
+
|
|
1606
|
+
注销设备游标(清理不再使用的设备记录)。
|
|
1607
|
+
|
|
1608
|
+
**参数**:`group_id` (必填), `device_id` (必填)
|
|
1609
|
+
|
|
1610
|
+
**响应**:`{ "success": true }`
|
|
1611
|
+
|
|
1612
|
+
---
|
|
1613
|
+
|
|
1614
|
+
## 管理辅助
|
|
1615
|
+
|
|
1616
|
+
### group.get_admins
|
|
1617
|
+
|
|
1618
|
+
获取管理员列表(owner + admin 角色)。
|
|
1619
|
+
|
|
1620
|
+
**参数**:`group_id` (必填)
|
|
1621
|
+
|
|
1622
|
+
**响应**:
|
|
1623
|
+
|
|
1624
|
+
```json
|
|
1625
|
+
{
|
|
1626
|
+
"admins": [
|
|
1627
|
+
{
|
|
1628
|
+
"aid": "alice.agentid.pub",
|
|
1629
|
+
"role": "owner",
|
|
1630
|
+
"member_type": "human",
|
|
1631
|
+
"joined_at": 1234567890
|
|
1632
|
+
}
|
|
1633
|
+
]
|
|
1634
|
+
}
|
|
1635
|
+
```
|
|
1636
|
+
|
|
1637
|
+
### group.get_master
|
|
1638
|
+
|
|
1639
|
+
获取群主 AID。
|
|
1640
|
+
|
|
1641
|
+
**参数**:`group_id` (必填)
|
|
1642
|
+
|
|
1643
|
+
**响应**:`{ "group_id": "g-abc123.agentid.pub", "owner_aid": "alice.agentid.pub" }`
|
|
1644
|
+
|
|
1645
|
+
### group.get_summary
|
|
1646
|
+
|
|
1647
|
+
获取群组综合统计摘要。
|
|
1648
|
+
|
|
1649
|
+
**参数**:`group_id` (必填)
|
|
1650
|
+
|
|
1651
|
+
**响应**:
|
|
1652
|
+
|
|
1653
|
+
```json
|
|
1654
|
+
{
|
|
1655
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1656
|
+
"name": "My Group",
|
|
1657
|
+
"owner_aid": "alice.agentid.pub",
|
|
1658
|
+
"status": "active",
|
|
1659
|
+
"visibility": "private",
|
|
1660
|
+
"member_count": 10,
|
|
1661
|
+
"human_count": 7,
|
|
1662
|
+
"ai_count": 3,
|
|
1663
|
+
"admin_count": 2,
|
|
1664
|
+
"online_count": 5,
|
|
1665
|
+
"message_seq": 1000,
|
|
1666
|
+
"event_seq": 2000,
|
|
1667
|
+
"e2ee_epoch": 3,
|
|
1668
|
+
"created_at": 1234567890,
|
|
1669
|
+
"updated_at": 1234567890
|
|
1670
|
+
}
|
|
1671
|
+
```
|
|
1672
|
+
|
|
1673
|
+
### group.get_metrics
|
|
1674
|
+
|
|
1675
|
+
获取群组性能指标,包含 E2EE epoch 范围记录。需要 **admin 及以上**权限。
|
|
1676
|
+
|
|
1677
|
+
**参数**:`group_id` (必填)
|
|
1678
|
+
|
|
1679
|
+
**响应**:
|
|
1680
|
+
|
|
1681
|
+
```json
|
|
1682
|
+
{
|
|
1683
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1684
|
+
"message_seq": 1000,
|
|
1685
|
+
"event_seq": 2000,
|
|
1686
|
+
"member_count": 10,
|
|
1687
|
+
"online_count": 5,
|
|
1688
|
+
"e2ee_epoch": 3,
|
|
1689
|
+
"epoch_count": 4,
|
|
1690
|
+
"epoch_ranges": [
|
|
1691
|
+
{
|
|
1692
|
+
"epoch": 0,
|
|
1693
|
+
"start_msg_seq": 0,
|
|
1694
|
+
"start_event_seq": 0,
|
|
1695
|
+
"end_msg_seq": 100,
|
|
1696
|
+
"end_event_seq": 200,
|
|
1697
|
+
"rotated_by": "alice.agentid.pub",
|
|
1698
|
+
"rotated_at": 1234567890
|
|
1699
|
+
}
|
|
1700
|
+
]
|
|
1701
|
+
}
|
|
1702
|
+
```
|
|
1703
|
+
|
|
1704
|
+
### group.refresh_member_types
|
|
1705
|
+
|
|
1706
|
+
刷新成员类型分类统计。
|
|
1707
|
+
|
|
1708
|
+
**参数**:`group_id` (必填)
|
|
1709
|
+
|
|
1710
|
+
**响应**:
|
|
1711
|
+
|
|
1712
|
+
```json
|
|
1713
|
+
{
|
|
1714
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1715
|
+
"total": 10,
|
|
1716
|
+
"human_count": 7,
|
|
1717
|
+
"ai_count": 3,
|
|
1718
|
+
"members": [
|
|
1719
|
+
{ "aid": "alice.agentid.pub", "role": "owner", "member_type": "human" }
|
|
1720
|
+
]
|
|
1721
|
+
}
|
|
1722
|
+
```
|
|
1723
|
+
|
|
1724
|
+
---
|
|
1725
|
+
|
|
1726
|
+
## E2EE
|
|
1727
|
+
|
|
1728
|
+
### group.e2ee.rotate_epoch
|
|
1729
|
+
|
|
1730
|
+
CAS 轮换群组 E2EE Epoch。需要 **admin 及以上**权限。
|
|
1731
|
+
|
|
1732
|
+
**参数**:
|
|
1733
|
+
|
|
1734
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
1735
|
+
|------|------|------|------|
|
|
1736
|
+
| `group_id` | string | 是 | 群组 ID |
|
|
1737
|
+
| `current_epoch` | integer | 是 | 当前 epoch 值(CAS 校验) |
|
|
1738
|
+
| `rotation_signature` | string | 是 | 轮换签名(Base64,ECDSA SHA-256) |
|
|
1739
|
+
| `rotation_timestamp` | string | 是 | 轮换时间戳(秒) |
|
|
1740
|
+
|
|
1741
|
+
**响应**:`{ "group_id": "g-abc123.agentid.pub", "success": true, "epoch": 4 }`
|
|
1742
|
+
|
|
1743
|
+
> 签名格式:`{group_id}|{current_epoch}|{new_epoch}|{aid}|{rotation_timestamp}`。时间戳必须在 5 分钟窗口内。签名去重防止重放攻击(10 分钟窗口)。
|
|
1744
|
+
|
|
1745
|
+
### group.e2ee.get_epoch
|
|
1746
|
+
|
|
1747
|
+
获取当前 E2EE Epoch 值。
|
|
1748
|
+
|
|
1749
|
+
**参数**:`group_id` (必填)
|
|
1750
|
+
|
|
1751
|
+
**响应**:`{ "group_id": "g-abc123.agentid.pub", "epoch": 3 }`
|
|
1752
|
+
|
|
1753
|
+
---
|
|
1754
|
+
|
|
1755
|
+
---
|
|
1756
|
+
|
|
1757
|
+
## 事件
|
|
1758
|
+
|
|
1759
|
+
### event/group.created
|
|
1760
|
+
|
|
1761
|
+
群组创建时推送。
|
|
1762
|
+
|
|
1763
|
+
**Payload**:
|
|
1764
|
+
|
|
1765
|
+
```json
|
|
1766
|
+
{
|
|
1767
|
+
"module_id": "group",
|
|
1768
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1769
|
+
"owner_aid": "alice.agentid.pub",
|
|
1770
|
+
"visibility": "private"
|
|
1771
|
+
}
|
|
1772
|
+
```
|
|
1773
|
+
|
|
1774
|
+
### event/group.changed
|
|
1775
|
+
|
|
1776
|
+
群组状态变化时推送。
|
|
1777
|
+
|
|
1778
|
+
**Payload**:
|
|
1779
|
+
|
|
1780
|
+
```json
|
|
1781
|
+
{
|
|
1782
|
+
"module_id": "group",
|
|
1783
|
+
"action": "member_added",
|
|
1784
|
+
"group_id": "g-abc123.agentid.pub"
|
|
1785
|
+
}
|
|
1786
|
+
```
|
|
1787
|
+
|
|
1788
|
+
| 字段 | 类型 | 说明 |
|
|
1789
|
+
|------|------|------|
|
|
1790
|
+
| `module_id` | string | 固定 `"group"` |
|
|
1791
|
+
| `action` | string | 变更类型(见下表) |
|
|
1792
|
+
| `group_id` | string | 群组 ID |
|
|
1793
|
+
| `request_id` | string | 可选,仅资源审批相关 action |
|
|
1794
|
+
| `resource_path` | string | 可选,仅资源相关 action |
|
|
1795
|
+
|
|
1796
|
+
**action 取值**:
|
|
1797
|
+
|
|
1798
|
+
| action | 说明 |
|
|
1799
|
+
|--------|------|
|
|
1800
|
+
| `upsert` | 群组创建/更新 |
|
|
1801
|
+
| `update` | 群组信息更新 |
|
|
1802
|
+
| `member_added` | 成员加入 |
|
|
1803
|
+
| `member_left` | 成员退出 |
|
|
1804
|
+
| `member_removed` | 成员被踢出 |
|
|
1805
|
+
| `role_changed` | 角色变更 |
|
|
1806
|
+
| `owner_transferred` | 群主转让 |
|
|
1807
|
+
| `rules_updated` | 规则更新 |
|
|
1808
|
+
| `announcement_updated` | 公告更新 |
|
|
1809
|
+
| `join_requested` | 收到入群申请 |
|
|
1810
|
+
| `joined` | 成员加入(通过邀请码等) |
|
|
1811
|
+
| `join_approved` | 入群申请批准 |
|
|
1812
|
+
| `join_rejected` | 入群申请拒绝 |
|
|
1813
|
+
| `join_requirements_updated` | 入群要求更新 |
|
|
1814
|
+
| `invite_code_created` | 邀请码创建 |
|
|
1815
|
+
| `invite_code_used` | 邀请码使用 |
|
|
1816
|
+
| `invite_code_revoked` | 邀请码撤销 |
|
|
1817
|
+
| `member_banned` | 成员封禁 |
|
|
1818
|
+
| `member_unbanned` | 成员解封 |
|
|
1819
|
+
| `resource_put` | 资源上传 |
|
|
1820
|
+
| `resource_updated` | 资源更新 |
|
|
1821
|
+
| `resource_deleted` | 资源删除 |
|
|
1822
|
+
| `resource_request_created` | 资源申请创建 |
|
|
1823
|
+
| `resource_direct_added` | 资源直接添加 |
|
|
1824
|
+
| `resource_request_approved` | 资源申请批准 |
|
|
1825
|
+
| `resource_request_rejected` | 资源申请拒绝 |
|
|
1826
|
+
| `suspended` | 群组暂停 |
|
|
1827
|
+
| `resumed` | 群组恢复 |
|
|
1828
|
+
| `dissolved` | 群组解散 |
|
|
1829
|
+
|
|
1830
|
+
**订阅**:
|
|
1831
|
+
|
|
1832
|
+
```python
|
|
1833
|
+
client.on("group.changed", lambda ev: print(ev["action"]))
|
|
1834
|
+
```
|
|
1835
|
+
|
|
1836
|
+
### event/group.message_created
|
|
1837
|
+
|
|
1838
|
+
群消息创建时推送给所有在线成员。支持两种模式:
|
|
1839
|
+
|
|
1840
|
+
**消息推送模式**(带 `payload`):
|
|
1841
|
+
|
|
1842
|
+
```json
|
|
1843
|
+
{
|
|
1844
|
+
"module_id": "group",
|
|
1845
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1846
|
+
"seq": 42,
|
|
1847
|
+
"message_id": "uuid",
|
|
1848
|
+
"sender_aid": "alice.agentid.pub",
|
|
1849
|
+
"type": "e2ee.group_encrypted",
|
|
1850
|
+
"dispatch_mode": "broadcast",
|
|
1851
|
+
"payload": { "type": "e2ee.group_encrypted", "..." : "..." },
|
|
1852
|
+
"dispatch": {"mode": "broadcast", "reason": "duty_disabled"},
|
|
1853
|
+
"kind": "group.broadcast",
|
|
1854
|
+
"member_aids": ["bob.agentid.pub"]
|
|
1855
|
+
}
|
|
1856
|
+
```
|
|
1857
|
+
|
|
1858
|
+
SDK 收到后自动解密 `payload`,解密后的明文消息直接交付用户回调。
|
|
1859
|
+
|
|
1860
|
+
**通知模式**(不带 `payload`):
|
|
1861
|
+
|
|
1862
|
+
```json
|
|
1863
|
+
{
|
|
1864
|
+
"module_id": "group",
|
|
1865
|
+
"group_id": "g-abc123.agentid.pub",
|
|
1866
|
+
"seq": 42,
|
|
1867
|
+
"message_id": "uuid",
|
|
1868
|
+
"sender_aid": "alice.agentid.pub",
|
|
1869
|
+
"type": "e2ee.group_encrypted",
|
|
1870
|
+
"dispatch_mode": "broadcast",
|
|
1871
|
+
"dispatch": {"mode": "broadcast", "reason": "duty_disabled"}
|
|
1872
|
+
}
|
|
1873
|
+
```
|
|
1874
|
+
|
|
1875
|
+
SDK 收到后自动调用 `group.pull` 拉取最新消息并逐条解密后交付用户回调。
|
|
1876
|
+
|
|
1877
|
+
---
|
|
1878
|
+
|
|
1879
|
+
## 错误码
|
|
1880
|
+
|
|
1881
|
+
Group 服务定义了以下专用错误码(-33xxx 段):
|
|
1882
|
+
|
|
1883
|
+
| 错误码 | 含义 | 客户端处理建议 |
|
|
1884
|
+
|--------|------|---------------|
|
|
1885
|
+
| -33001 | Group not found | 检查 group_id 是否正确 |
|
|
1886
|
+
| -33002 | Group suspended | 等待恢复或联系管理员 |
|
|
1887
|
+
| -33003 | Group closed | 不重试,群已解散 |
|
|
1888
|
+
| -33004 | Already a member | 无需处理 |
|
|
1889
|
+
| -33005 | Not a member | 需先加入群组 |
|
|
1890
|
+
| -33006 | Invite code invalid or expired | 获取新邀请码 |
|
|
1891
|
+
| -33007 | Join request pending | 等待审批,勿重复提交 |
|
|
1892
|
+
| -33008 | Resource not found | 检查 resource_path |
|
|
1893
|
+
| -33009 | Resource request not found | 检查 request_id |
|
|
1894
|
+
|
|
1895
|
+
> SDK 客户端将 -33001 映射为 `GroupNotFoundError`,-33002~-33003 映射为 `GroupStateError`,其余映射为 `GroupError`。未识别的错误码 fallback 到 `AUNError`。
|