# 获取频道成员列表

获取频道下的成员列表。

注意

  • 公域机器人暂不支持申请,仅私域机器人可用,选择私域机器人后默认开通。
  • 注意: 开通后需要先将机器人从频道移除,然后重新添加,方可生效。

# 使用示例

import qqbot

token = qqbot.Token({appid}, {token})
api = qqbot.GuildMemberAPI(token, False)
members = api.get_guild_members(guild_id, query_params)
1
2
3
4
5

# 参数说明

字段名 必填 类型 描述
guild_id string 频道 ID
after string 上一次回包中最大的用户 ID, 如果是第一次请求填 0,默认为 0
limit number 分页大小,1-1000,默认是 1

# 返回说明

返回 Member 对象。

# Member

字段名 类型 描述
user User 用户的频道基础信息,只有成员相关接口中会填充此信息
nick string 用户在频道内的昵称
roles string[] 用户在频道内的身份组 ID,默认值可参考DefaultRoleIDs
joined_at string 用户加入频道的时间,是个 ISO8601 timestamp 字符串,例:"2021-11-23T15:16:48+08:00"

# User

字段名 类型 描述
id string 用户 ID
username string 用户名
avatar string 用户头像地址
bot boolean 是否是机器人

# 返回示例

data

[
  {
    "user": {
      "id": "用户 ID",
      "username": "用户名",
      "avatar": "用户头像地址",
      "bot": false,
      "public_flags": 0,
      "system": false
    },
    "nick": "",
    "roles": [
      "4"
    ],
    "joined_at": "2021-11-23T15:16:48+08:00",
    "deaf": false,
    "mute": false,
    "pending": false
  }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
手机QQ扫码
开发者社区
加入官方频道开发者社区