外观
群与成员
创建群、读取群资料和成员,以及修改群设置。每次操作都要以服务器返回的 permissions 为准。
每个接口独立列出请求参数、返回字段和示例。点击下方接口名称即可查看。
接口列表
| 接口 | 方法 | 路径 |
|---|---|---|
| 读取群目录 | GET | /app/sdk/groups |
| 读取群详情 | GET | /app/sdk/groups/detail |
| 读取群成员 | GET | /app/sdk/groups/members |
| 创建群 | POST | /app/sdk/groups/create |
| 修改群名称 | POST | /app/sdk/groups/name |
| 修改个人群备注 | POST | /app/sdk/groups/remark |
| 修改群公告 | POST | /app/sdk/groups/announcement |
| 设置全员禁言 | POST | /app/sdk/groups/all-muted |
| 设置入群审批 | POST | /app/sdk/groups/join-approval |
| 上传群头像 | POST | /app/sdk/groups/avatar |
| 直接添加群成员 | POST | /app/sdk/groups/add-members |
| 移出群成员 | POST | /app/sdk/groups/remove-members |
| 发送群邀请 | POST | /app/sdk/groups/invitations |
| 设置群管理员 | POST | /app/sdk/groups/admins |
| 设置成员禁言 | POST | /app/sdk/groups/member-mute |
| 生成群邀请信息 | POST | /app/sdk/groups/invite-qr |
| 预览群邀请 | POST | /app/sdk/groups/invite-preview |
| 通过邀请加入群 | POST | /app/sdk/groups/invite-join |
| 退出群 | POST | /app/sdk/groups/leave |
| 解散群 | POST | /app/sdk/groups/dissolve |
群目录与详情
群目录用于列表,详情给出本人状态与权限,完整成员使用分页接口读取。
创建群
当前用户成为群主,初始成员选自有效双向好友。重试保持原 request_id。
修改群资料
群名称、头像和公告对所有成员可见;个人群备注只对本人可见。
增减成员
直接添加会改变群成员;需要被邀请人确认时,改用群邀请。批量操作可能有部分用户未处理。
邀请好友入群
这里只发出邀请,对方同意申请后才成为成员。
群管理
管理员设置、全员禁言、成员禁言和入群审批各有独立接口,先检查群详情中的 permissions。
群二维码邀请
生成邀请信息后,把 payload 做成二维码。扫码先预览;需要审批的群,提交成功后仍需等待同意。
退群与解散
普通成员可以退出;群主可解散群。两种操作影响范围不同,提交后使用服务器返回的状态。
