Channel
Definitions
Channel
| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| id | string | channel id |
| type | ChannelType | channel type |
| name | string? | channel name |
| parent_id | string? | parent channel id |
ChannelType
| TYPE | VALUE | DESCRIPTION |
|---|---|---|
| TEXT | 0 | text channel |
| DIRECT | 1 | direct message channel |
| CATEGORY | 2 | category channel |
| VOICE | 3 | voice channel |
API
Get Guild Channel
POST /channel.get| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| channel_id | string | channel id |
Get a channel by id. Returns a Channel object.
Get Guild Channel List
POST /channel.list| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| next | string | pagination token |
Get all channels in a guild. Returns a paginated list of Channel objects.
Create Guild Channel
POST /channel.create| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| data | Channel | channel data |
Create a guild channel. Returns a Channel object.
Update Guild Channel
POST /channel.update| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| channel_id | string | channel id |
| data | Channel | channel data |
Update a guild channel.
Delete Guild Channel
POST /channel.delete| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| channel_id | string | channel id |
Delete a guild channel.
Mute Guild Channel Experimental
POST /channel.mute| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| channel_id | string | channel id |
| duration | number | mute duration (in milliseconds) |
Mute a guild channel. If the duration is set to 0, it will unmute the channel.
Create Direct Message Channel
POST /user.channel.create| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| user_id | string | user id |
| guild_id | string? | guild id |
Create a direct message channel. Returns a Channel object.