diff --git a/docs/develop/pythonsdk/api/member/get_guild_role_members.md b/docs/develop/pythonsdk/api/member/get_guild_role_members.md new file mode 100644 index 00000000..50d2e945 --- /dev/null +++ b/docs/develop/pythonsdk/api/member/get_guild_role_members.md @@ -0,0 +1,68 @@ +# 获取频道身份组的成员列表 + +获取频道下指定身份组的成员列表。 + + + +## 使用示例 + +```python +import botpy +from botpy.message import Message + +class MyClient(botpy.Client): + async def on_at_message_create(self, message: Message): + await self.api.get_guild_role_member(guild_id="xxxx", role_id="xxxx") + +intents = botpy.Intents(public_guild_messages=True) +client = MyClient(intents=intents) +client.run(appid={appid}, token={token}) + +``` + +## 参数说明 + +| 字段名 | 必填 | 类型 | 描述 | +| ----------- | ---- | --------------------------- | -------- | +| guild_id | 是 | string | 频道 ID | +| role_id | 是 | string | 身份组 ID | +| start_index | 否 | string | 上一次回包中 next, 如果是第一次请求填 0,默认为 0 | +| limit | 否 | number | 分页大小,1-400,默认是 1 | + +## 返回说明 + +| 字段名 | 类型 | 描述 | +| -------- | ------- | ------------ | +| data | [Member](#Member) | 一组用户信息对象 | +| next | string | 下一次请求的分页标识 | + + +## Member + +| 字段名 | 类型 | 描述 | +| --------- | ------------- | -------------------------------------------------------------------------------------------- | +| user | [User](#user) | 用户的频道基础信息,只有成员相关接口中会填充此信息 | +| nick | string | 用户在频道内的昵称 | +| joined_at | string | 用户加入频道的时间,是个 `ISO8601 timestamp` 字符串,例:"2021-11-23T15:16:48+08:00" | + +## 返回示例 + +`data`: + +```json +{ + "data": [ + { + "user": { + "id": "用户 ID", + "username": "用户名", + "avatar": "用户头像地址", + "bot": false + }, + "nick": "", + "joined_at": "2021-11-23T15:16:48+08:00" + } + ] + "next": "0" +} +``` diff --git a/docs/develop/pythonsdk/changelog/README.md b/docs/develop/pythonsdk/changelog/README.md index a311da41..dca5c088 100644 --- a/docs/develop/pythonsdk/changelog/README.md +++ b/docs/develop/pythonsdk/changelog/README.md @@ -1,5 +1,9 @@ # PythonSDK更新日志 +## 2023-05-02 + +* feat: pythonsdk 添加获取频道身份组的成员列表的接口 ([582c2b1](https://github.com/tencent-connect/botpy/pull/135/commits/582c2b185a3264c0b6dcbfb91128f127559dff7d)) + ## 2022-06-17 * feat: 完善ws事件中Message数据的构建 ([9564cb2](https://github.com/tencent-connect/botpy/pull/103/commits/9564cb2858833fb8de442123226fe7a46f743fe6)) @@ -69,4 +73,4 @@ ## 2021-12-25 * fix: 修改import规范 ([37099b3](https://github.com/tencent-connect/botpy/commit/37099b37fb0047bae2136f1944c6f12ae860ba68)) -* [init]初始化框架代码 ([4413bd5](https://github.com/tencent-connect/botpy/commit/4413bd5152da1e51fba0551f86d4560c55afecf8)) \ No newline at end of file +* [init]初始化框架代码 ([4413bd5](https://github.com/tencent-connect/botpy/commit/4413bd5152da1e51fba0551f86d4560c55afecf8))