Guild Member
Definitions
GuildMember
| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| user | User? | user object |
| nick | string? | user's nickname in the guild |
| avatar | string? | user's avatar in the guild |
| joined_at | number? | join time |
API
Get Guild Member
POST /guild.member.get| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| user_id | string | user id |
Get guild member information. Returns a GuildMember object.
Get Guild Member List
POST /guild.member.list| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| next | string? | pagination token |
Get all the members in a guild. Returns a paginated list of GuildMember objects.
Kick Guild Member
POST /guild.member.kick| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| user_id | string | user id |
| permanent | boolean? | whether to permanently ban the user (preventing rejoin) |
Kick a user from the guild.
Mute Guild Member experimental
POST /guild.member.mute| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| user_id | string | user id |
| duration | number | mute duration (in milliseconds) |
Mute a user. If the duration is set to 0, it will unmute the user.
Approve Guild Member Request
POST /guild.member.approve| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| message_id | string | request id |
| approve | boolean | whether to approve the request |
| comment | string? | comment |
Handle a guild join request.
Events
guild-member-added
Triggered when a guild member is added. Required resources: guild, member, user.
guild-member-updated
Triggered when guild member information is updated. Required resources: guild, member, user.
guild-member-removed
Triggered when a guild member is removed. Required resources: guild, member, user.
guild-member-request
Triggered when a new guild join request is received. Required resources: guild, member, user.