diff --git a/docs/guild.md b/docs/guild.md index 69c6f0d..b3d2d1a 100644 --- a/docs/guild.md +++ b/docs/guild.md @@ -30,7 +30,7 @@ API以及字段相关命名均为参考QQ官方命名或相似产品命名规则 - 所有事件的 `self_id` 均为 BOT 的QQ号. `tiny_id` 将放在 `self_tiny_id` 字段 - 遵循我们一贯的原则, 将不会支持主动加频道/主动拉人/红包相关消息类型 - 频道相关的API仅能在 `Android Phone` 和 `iPad` 协议上使用. -- 由于频道相关ID的数据类型均为 `uint64` , 为保证不超过某些语言的安全值范围, 在 `v1.0.0-beta8-fix3` 以后, 所有ID相关数据均转换为 `string` 类型, API调用两种类型均可接受. +- 由于频道相关ID的数据类型均为 `uint64` , 为保证不超过某些语言的安全值范围, 在 `v1.0.0-beta8-fix3` 以后, 所有ID相关数据将转换为 `string` 类型, API调用 `uint64` 或 `string` 均可接受. - 为保证一致性, 所有频道接口返回的 `用户ID` 均命名为 `tiny_id`, 所有频道相关接口的 `用户ID` 入参均命名为 `user_id` ## API @@ -140,6 +140,8 @@ SlowModeInfo: 终结点: `/get_guild_member_list` > 由于频道人数较多(数万), 请尽量不要全量拉取成员列表, 这将会导致严重的性能问题 +> +> 尽量使用 `get_guild_member_profile` 接口代替全量拉取 **参数** @@ -169,6 +171,36 @@ GuildMemberInfo: | `role_name` | string | 所在权限组名称 | > 默认情况下频道管理员的权限组ID为 `2`, 部分频道可能会另行创建, 需手动判断 +> +> 此接口仅展现最新的权限组, 获取用户加入的所有权限组请使用 `get_guild_member_profile` 接口 + +### 单独获取频道成员信息 + +终结点: `/get_guild_member_profile` + +**参数** + +| 字段 | 类型 | 说明 | +| ---------- | ----- | ---- | +| `guild_id` | string | 频道ID | +| `user_id` | string | 用户ID | + +**响应数据** + +| 字段 | 类型 | 说明 | +| ------------- | ----- | ---------- | +| `tiny_id` | string | 用户ID | +| `nickname` | string | 用户昵称 | +| `avatar_url` | string | 头像地址 | +| `join_time` | int64 | 加入时间 | +| `roles` | []RoleInfo | 加入的所有权限组 | + +RoleInfo: + +| 字段 | 类型 | 说明 | +| ------------- | ----- | ---------- | +| `role_id` | string | 权限组ID | +| `role_name` | string | 权限组名称 | ### 发送信息到子频道