BulkDeleteMessagesRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| message_ids | SnowflakeType[] | Array of message IDs to delete |
CallEligibilityResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| ringable | boolean | Whether the current user can ring this call |
| silent | boolean | Whether the call should be joined silently |
CallRingBodySchema
Related endpoints| Field | Type | Description |
|---|---|---|
| recipients? | SnowflakeType[] | User IDs to ring for the call |
CallUpdateBodySchema
Related endpoints| Field | Type | Description |
|---|---|---|
| region? | ?string | The preferred voice region for the call (1-64 characters). Omit or set to null for automatic region selection. |
ChannelCreateCategoryRequest
| Field | Type | Description |
|---|---|---|
| bitrate? | ?integer (int32) | Voice channel bitrate in bits per second (8000-320000) |
| name | string | The name of the category |
| nsfw? | boolean | Whether the channel is marked as NSFW |
| parent_id? | ?SnowflakeType | ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteRequest[] | Permission overwrites for roles and members |
| topic? | ?string | The channel topic (1-1024 characters) |
| type | ChannelUpdateCategoryRequestType | |
| url? | ?string | External URL for link channels |
| user_limit? | ?integer (int32) | Maximum users allowed in voice channel (0-99, 0 means unlimited) |
ChannelCreateLinkRequest
| Field | Type | Description |
|---|---|---|
| bitrate? | ?integer (int32) | Voice channel bitrate in bits per second (8000-320000) |
| name | string | The name of the channel |
| nsfw? | boolean | Whether the channel is marked as NSFW |
| parent_id? | ?SnowflakeType | ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteRequest[] | Permission overwrites for roles and members |
| topic? | ?string | The channel topic (1-1024 characters) |
| type | ChannelUpdateLinkRequestType | |
| url? | ?string | External URL for link channels |
| user_limit? | ?integer (int32) | Maximum users allowed in voice channel (0-99, 0 means unlimited) |
ChannelCreateTextRequest
| Field | Type | Description |
|---|---|---|
| bitrate? | ?integer (int32) | Voice channel bitrate in bits per second (8000-320000) |
| name | string | The name of the channel |
| nsfw? | boolean | Whether the channel is marked as NSFW |
| parent_id? | ?SnowflakeType | ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteRequest[] | Permission overwrites for roles and members |
| topic? | ?string | The channel topic (1-1024 characters) |
| type | ChannelUpdateTextRequestType | |
| url? | ?string | External URL for link channels |
| user_limit? | ?integer (int32) | Maximum users allowed in voice channel (0-99, 0 means unlimited) |
ChannelCreateVoiceRequest
| Field | Type | Description |
|---|---|---|
| bitrate? | ?integer (int32) | Voice channel bitrate in bits per second (8000-320000) |
| name | string | The name of the channel |
| nsfw? | boolean | Whether the channel is marked as NSFW |
| parent_id? | ?SnowflakeType | ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteRequest[] | Permission overwrites for roles and members |
| topic? | ?string | The channel topic (1-1024 characters) |
| type | ChannelUpdateVoiceRequestType | |
| url? | ?string | External URL for link channels |
| user_limit? | ?integer (int32) | Maximum users allowed in voice channel (0-99, 0 means unlimited) |
ChannelNicknameOverrides
User nickname overrides (user ID to nickname mapping) Type: map<string, string | null>ChannelOverwriteRequest
| Field | Type | Description |
|---|---|---|
| allow? | UnsignedInt64Type | |
| deny? | UnsignedInt64Type | |
| id | SnowflakeType | |
| type | ChannelOverwriteRequestType | The type of overwrite (0 = role, 1 = member) |
ChannelOverwriteResponse
| Field | Type | Description |
|---|---|---|
| allow | string (int64) | The bitwise value of allowed permissions |
| deny | string (int64) | The bitwise value of denied permissions |
| id | SnowflakeType | The unique identifier for the role or user this overwrite applies to |
| type | enum<0, 1> | The type of entity the overwrite applies to |
ChannelPartialRecipientResponse
| Field | Type | Description |
|---|---|---|
| username | string | The username of the recipient |
ChannelPartialResponse
| Field | Type | Description |
|---|---|---|
| id | SnowflakeType | The unique identifier (snowflake) for this channel |
| name? | ?string | The name of the channel |
| recipients? | ChannelPartialRecipientResponse[] | The recipients of the DM channel |
| type | integer (int32) | The type of the channel |
ChannelPinMessageResponse
The pinned message| Field | Type | Description |
|---|---|---|
| attachments? | ?MessageAttachmentResponse[] | The files attached to the message |
| author | UserPartialResponse | |
| call? | ?MessageCallResponse | Call information if this message represents a call |
| channel_id | SnowflakeType | The ID of the channel this message was sent in |
| content | string | The text content of the message |
| edited_timestamp? | ?string (date-time) | The ISO 8601 timestamp of when the message was last edited |
| embeds? | ?MessageEmbedResponse[] | The embeds attached to the message |
| flags | MessageFlags | |
| id | SnowflakeType | The unique identifier (snowflake) for this message |
| mention_everyone | boolean | Whether the message mentions @everyone |
| mention_roles? | ?SnowflakeType[] | The role IDs mentioned in the message |
| mentions? | ?UserPartialResponse[] | The users mentioned in the message |
| message_reference? | ?MessageReferenceResponse | Reference data for replies or forwards |
| message_snapshots? | ?MessageSnapshotResponse[] | Snapshots of forwarded messages |
| nonce? | ?string | A client-provided value for message deduplication |
| pinned | boolean | Whether the message is pinned |
| stickers? | ?MessageStickerResponse[] | The stickers sent with the message |
| timestamp | string (date-time) | The ISO 8601 timestamp of when the message was created |
| tts? | boolean | Whether the message was sent as text-to-speech |
| type | MessageResponseSchemaType | The type of message |
| webhook_id? | ?SnowflakeType | The ID of the webhook that sent this message |
ChannelPinResponse
| Field | Type | Description |
|---|---|---|
| message | ChannelPinMessageResponse | |
| pinned_at | string (date-time) | The ISO 8601 timestamp of when the message was pinned |
ChannelPinsResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| has_more | boolean | Whether more pins can be fetched with pagination |
| items | ChannelPinResponse[] | Pinned messages in this channel |
ChannelResponse
Related endpointsGET /channels/{channel_id}GET /guilds/{guild_id}/channelsGET /users/@me/channelsPOST /guilds/{guild_id}/channelsPOST /users/@me/channelsPATCH /channels/{channel_id}
| Field | Type | Description |
|---|---|---|
| bitrate? | ?Int32Type | The bitrate of the voice channel in bits per second |
| guild_id? | SnowflakeType | |
| icon? | ?string | The icon hash of the channel (for group DMs) |
| id | SnowflakeType | The unique identifier (snowflake) for this channel |
| last_message_id? | ?SnowflakeType | The ID of the last message sent in this channel |
| last_pin_timestamp? | ?string (date-time) | The ISO 8601 timestamp of when the last pinned message was pinned |
| name? | string | The name of the channel |
| nicks? | map<string, string> | Custom nicknames for users in this channel (for group DMs) |
| nsfw? | boolean | Whether the channel is marked as NSFW |
| owner_id? | ?SnowflakeType | The ID of the owner of the channel (for group DMs) |
| parent_id? | ?SnowflakeType | The ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteResponse[] | The permission overwrites for this channel |
| position? | Int32Type | |
| rate_limit_per_user? | Int32Type | |
| recipients? | UserPartialResponse[] | The recipients of the DM channel |
| rtc_region? | ?SnowflakeType | The voice region ID for the voice channel |
| topic? | ?string | The topic of the channel |
| type | integer (int32) | The type of the channel |
| url? | ?string (uri) | The URL associated with the channel |
| user_limit? | ?Int32Type | The maximum number of users allowed in the voice channel |
ChannelUpdateCategoryRequest
| Field | Type | Description |
|---|---|---|
| bitrate? | ?integer (int32) | Voice channel bitrate in bits per second (8000-320000) |
| icon? | ?Base64ImageType | Base64-encoded icon image for group DM channels |
| name? | ?string | The name of the category |
| nicks? | ChannelNicknameOverrides | |
| nsfw? | ?boolean | Whether the channel is marked as NSFW |
| owner_id? | ?SnowflakeType | ID of the new owner for group DM channels |
| parent_id? | ?SnowflakeType | ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteRequest[] | Permission overwrites for roles and members |
| rate_limit_per_user? | ?integer (int32) | Slowmode delay in seconds (0-21600) |
| rtc_region? | ?SnowflakeType | Voice region ID for the voice channel (1-64 characters) |
| topic? | ?string | The channel topic (1-1024 characters) |
| type | ChannelUpdateCategoryRequestType | |
| url? | ?string | External URL for link channels |
| user_limit? | ?integer (int32) | Maximum users allowed in voice channel (0-99, 0 means unlimited) |
ChannelUpdateGroupDmRequest
| Field | Type | Description |
|---|---|---|
| icon? | ?Base64ImageType | Base64-encoded icon image for the group DM |
| name? | ?string | The name of the group DM |
| nicks? | ?ChannelNicknameOverrides | Custom nicknames for users in this group DM |
| owner_id? | ?SnowflakeType | ID of the new owner of the group DM |
| type | ChannelUpdateGroupDmRequestType |
ChannelUpdateLinkRequest
| Field | Type | Description |
|---|---|---|
| bitrate? | ?integer (int32) | Voice channel bitrate in bits per second (8000-320000) |
| icon? | ?Base64ImageType | Base64-encoded icon image for group DM channels |
| name? | ?string | The name of the channel |
| nicks? | ChannelNicknameOverrides | |
| nsfw? | ?boolean | Whether the channel is marked as NSFW |
| owner_id? | ?SnowflakeType | ID of the new owner for group DM channels |
| parent_id? | ?SnowflakeType | ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteRequest[] | Permission overwrites for roles and members |
| rate_limit_per_user? | ?integer (int32) | Slowmode delay in seconds (0-21600) |
| rtc_region? | ?SnowflakeType | Voice region ID for the voice channel (1-64 characters) |
| topic? | ?string | The channel topic (1-1024 characters) |
| type | ChannelUpdateLinkRequestType | |
| url? | ?string | External URL for link channels |
| user_limit? | ?integer (int32) | Maximum users allowed in voice channel (0-99, 0 means unlimited) |
ChannelUpdateRequest
Related endpoints Type: ChannelUpdateTextRequest | ChannelUpdateVoiceRequest | ChannelUpdateCategoryRequest | ChannelUpdateLinkRequest | ChannelUpdateGroupDmRequestChannelUpdateTextRequest
| Field | Type | Description |
|---|---|---|
| bitrate? | ?integer (int32) | Voice channel bitrate in bits per second (8000-320000) |
| icon? | ?Base64ImageType | Base64-encoded icon image for group DM channels |
| name? | ?string | The name of the channel |
| nicks? | ChannelNicknameOverrides | |
| nsfw? | ?boolean | Whether the channel is marked as NSFW |
| owner_id? | ?SnowflakeType | ID of the new owner for group DM channels |
| parent_id? | ?SnowflakeType | ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteRequest[] | Permission overwrites for roles and members |
| rate_limit_per_user? | ?integer (int32) | Slowmode delay in seconds (0-21600) |
| rtc_region? | ?SnowflakeType | Voice region ID for the voice channel (1-64 characters) |
| topic? | ?string | The channel topic (1-1024 characters) |
| type | ChannelUpdateTextRequestType | |
| url? | ?string | External URL for link channels |
| user_limit? | ?integer (int32) | Maximum users allowed in voice channel (0-99, 0 means unlimited) |
ChannelUpdateVoiceRequest
| Field | Type | Description |
|---|---|---|
| bitrate? | ?integer (int32) | Voice channel bitrate in bits per second (8000-320000) |
| icon? | ?Base64ImageType | Base64-encoded icon image for group DM channels |
| name? | ?string | The name of the channel |
| nicks? | ChannelNicknameOverrides | |
| nsfw? | ?boolean | Whether the channel is marked as NSFW |
| owner_id? | ?SnowflakeType | ID of the new owner for group DM channels |
| parent_id? | ?SnowflakeType | ID of the parent category for this channel |
| permission_overwrites? | ChannelOverwriteRequest[] | Permission overwrites for roles and members |
| rate_limit_per_user? | ?integer (int32) | Slowmode delay in seconds (0-21600) |
| rtc_region? | ?SnowflakeType | Voice region ID for the voice channel (1-64 characters) |
| topic? | ?string | The channel topic (1-1024 characters) |
| type | ChannelUpdateVoiceRequestType | |
| url? | ?string | External URL for link channels |
| user_limit? | ?integer (int32) | Maximum users allowed in voice channel (0-99, 0 means unlimited) |
EmbedAuthorResponse
| Field | Type | Description |
|---|---|---|
| icon_url? | ?string (uri) | The URL of the author icon |
| name | string | The name of the author |
| proxy_icon_url? | ?string (uri) | The proxied URL of the author icon |
| url? | ?string (uri) | The URL of the author |
EmbedFieldResponse
| Field | Type | Description |
|---|---|---|
| inline | boolean | Whether the field should be displayed inline |
| name | string | The name of the field |
| value | string | The value of the field |
EmbedFooterResponse
| Field | Type | Description |
|---|---|---|
| icon_url? | ?string (uri) | The URL of the footer icon |
| proxy_icon_url? | ?string (uri) | The proxied URL of the footer icon |
| text | string | The footer text |
EmbedMediaFlags
The bitwise flags for this media Type: Bitflags32| Flag | Value | Description |
|---|---|---|
| CONTAINS_EXPLICIT_MEDIA | 16 | Embed media contains explicit content |
| IS_ANIMATED | 32 | Embed media is animated |
EmbedMediaResponse
| Field | Type | Description |
|---|---|---|
| content_hash? | ?string | The hash of the media content |
| content_type? | ?string | The MIME type of the media |
| description? | ?string | The description of the media |
| duration? | ?Int32Type | The duration of the media in seconds |
| flags | EmbedMediaFlags | |
| height? | ?Int32Type | The height of the media in pixels |
| placeholder? | ?string | The base64 encoded placeholder image for lazy loading |
| proxy_url? | ?string (uri) | The proxied URL of the media |
| url | string | The URL of the media |
| width? | ?Int32Type | The width of the media in pixels |
GroupDmAddPermissionFlags
Group DM add permissions Type: Bitflags32| Flag | Value | Description |
|---|---|---|
| FRIENDS_OF_FRIENDS | 1 | Allow friends of friends to add user to group DMs |
| GUILD_MEMBERS | 2 | Allow guild members to add user to group DMs |
| EVERYONE | 4 | Allow everyone to add user to group DMs |
| FRIENDS_ONLY | 8 | Allow only friends to add user to group DMs |
| NOBODY | 16 | Block everyone from adding user to group DMs |
GroupDmInviteMetadataResponse
| Field | Type | Description |
|---|---|---|
| channel | ChannelPartialResponse | |
| code | string | The unique invite code |
| created_at | string (date-time) | ISO8601 timestamp of when the invite was created |
| expires_at? | ?string (date-time) | ISO8601 timestamp of when the invite expires |
| inviter? | ?UserPartialResponse | The user who created the invite |
| max_uses | integer (int32) | The maximum number of times this invite can be used |
| member_count | integer (int32) | The current member count of the group DM |
| temporary | boolean | Whether the invite grants temporary membership |
| type | enum<1> | The type of invite (group DM) |
| uses | integer (int32) | The number of times this invite has been used |
GroupDmInviteResponse
| Field | Type | Description |
|---|---|---|
| channel | ChannelPartialResponse | |
| code | string | The unique invite code |
| expires_at? | ?string (date-time) | ISO8601 timestamp of when the invite expires |
| inviter? | ?UserPartialResponse | The user who created the invite |
| member_count | integer (int32) | The current member count of the group DM |
| temporary | boolean | Whether the invite grants temporary membership |
| type | enum<1> | The type of invite (group DM) |
MessageAckRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| manual? | boolean | Whether this is a manual acknowledgement |
| mention_count? | Int32Type |
MessageAttachmentFlags
Attachment flags Type: Bitflags32| Flag | Value | Description |
|---|---|---|
| IS_SPOILER | 8 | Attachment is marked as a spoiler |
| CONTAINS_EXPLICIT_MEDIA | 16 | Attachment contains explicit media content |
| IS_ANIMATED | 32 | Attachment is animated |
MessageAttachmentResponse
| Field | Type | Description |
|---|---|---|
| content_hash? | ?string | The hash of the attachment content |
| content_type? | ?string | The MIME type of the attachment |
| description? | ?string | The description of the attachment |
| duration? | ?Int32Type | The duration of the media in seconds |
| expired? | ?boolean | Whether the attachment URL has expired |
| expires_at? | ?string | The ISO 8601 timestamp when the attachment URL expires |
| filename | string | The name of the attached file |
| flags | MessageAttachmentFlags | |
| height? | ?Int32Type | The height of the attachment in pixels (for images/videos) |
| id | SnowflakeType | The unique identifier for this attachment |
| nsfw? | ?boolean | Whether the attachment is flagged as NSFW |
| placeholder? | ?string | The base64 encoded placeholder image for lazy loading |
| proxy_url? | ?string | The proxied URL of the attachment |
| size | integer (int32) | The size of the attachment in bytes |
| title? | ?string | The title of the attachment |
| url? | ?string | The URL of the attachment |
| waveform? | ?string | The base64 encoded audio waveform data |
| width? | ?Int32Type | The width of the attachment in pixels (for images/videos) |
MessageAuthorType
The type of author who sent the message| Value | Description |
|---|---|
user | A regular user account |
bot | An automated bot account |
webhook | A webhook-generated message |
MessageBaseResponseSchema
| Field | Type | Description |
|---|---|---|
| attachments? | ?MessageAttachmentResponse[] | The files attached to the message |
| author | UserPartialResponse | |
| call? | ?MessageCallResponse | Call information if this message represents a call |
| channel_id | SnowflakeType | The ID of the channel this message was sent in |
| content | string | The text content of the message |
| edited_timestamp? | ?string (date-time) | The ISO 8601 timestamp of when the message was last edited |
| embeds? | ?MessageEmbedResponse[] | The embeds attached to the message |
| flags | MessageFlags | |
| id | SnowflakeType | The unique identifier (snowflake) for this message |
| mention_everyone | boolean | Whether the message mentions @everyone |
| mention_roles? | ?SnowflakeType[] | The role IDs mentioned in the message |
| mentions? | ?UserPartialResponse[] | The users mentioned in the message |
| message_reference? | ?MessageReferenceResponse | Reference data for replies or forwards |
| message_snapshots? | ?MessageSnapshotResponse[] | Snapshots of forwarded messages |
| nonce? | ?string | A client-provided value for message deduplication |
| pinned | boolean | Whether the message is pinned |
| reactions? | ?MessageReactionResponse[] | The reactions on the message |
| stickers? | ?MessageStickerResponse[] | The stickers sent with the message |
| timestamp | string (date-time) | The ISO 8601 timestamp of when the message was created |
| tts? | boolean | Whether the message was sent as text-to-speech |
| type | MessageResponseSchemaType | The type of message |
| webhook_id? | ?SnowflakeType | The ID of the webhook that sent this message |
MessageCallResponse
| Field | Type | Description |
|---|---|---|
| ended_timestamp? | ?string (date-time) | The ISO 8601 timestamp of when the call ended |
| participants | SnowflakeType[] | The user IDs of participants in the call |
MessageContentType
The type of content contained in a message| Value | Description |
|---|---|
image | Message contains an image attachment |
sound | Message contains an audio attachment |
video | Message contains a video attachment |
file | Message contains a file attachment |
sticker | Message contains a sticker |
embed | Message contains an embed |
link | Message contains a URL link |
poll | Message contains a poll |
snapshot | Message contains a forwarded message snapshot |
MessageEmbedChildResponse
| Field | Type | Description |
|---|---|---|
| audio? | ?EmbedMediaResponse | The audio of the embed |
| author? | ?EmbedAuthorResponse | The author information of the embed |
| color? | ?Int32Type | The color code of the embed sidebar |
| description? | ?string | The description of the embed |
| fields? | ?EmbedFieldResponse[] | The fields of the embed |
| footer? | ?EmbedFooterResponse | The footer of the embed |
| image? | ?EmbedMediaResponse | The image of the embed |
| nsfw? | ?boolean | Whether the embed is flagged as NSFW |
| provider? | ?EmbedAuthorResponse | The provider of the embed (e.g., YouTube, Twitter) |
| thumbnail? | ?EmbedMediaResponse | The thumbnail of the embed |
| timestamp? | ?string (date-time) | The ISO 8601 timestamp of the embed content |
| title? | ?string | The title of the embed |
| type | string | The type of embed (e.g., rich, image, video, gifv, article, link) |
| url? | ?string (uri) | The URL of the embed |
| video? | ?EmbedMediaResponse | The video of the embed |
MessageEmbedResponse
| Field | Type | Description |
|---|---|---|
| audio? | ?EmbedMediaResponse | The audio of the embed |
| author? | ?EmbedAuthorResponse | The author information of the embed |
| children? | ?MessageEmbedChildResponse[] | Internal nested embeds generated by unfurlers |
| color? | ?Int32Type | The color code of the embed sidebar |
| description? | ?string | The description of the embed |
| fields? | ?EmbedFieldResponse[] | The fields of the embed |
| footer? | ?EmbedFooterResponse | The footer of the embed |
| image? | ?EmbedMediaResponse | The image of the embed |
| nsfw? | ?boolean | Whether the embed is flagged as NSFW |
| provider? | ?EmbedAuthorResponse | The provider of the embed (e.g., YouTube, Twitter) |
| thumbnail? | ?EmbedMediaResponse | The thumbnail of the embed |
| timestamp? | ?string (date-time) | The ISO 8601 timestamp of the embed content |
| title? | ?string | The title of the embed |
| type | string | The type of embed (e.g., rich, image, video, gifv, article, link) |
| url? | ?string (uri) | The URL of the embed |
| video? | ?EmbedMediaResponse | The video of the embed |
MessageEmbedType
The type of embed content| Value | Description |
|---|---|
image | An image embed from a linked URL |
video | A video embed from a linked URL |
sound | An audio embed from a linked URL |
article | An article or webpage embed with metadata |
MessageFlags
Message flags bitfield Type: Bitflags32| Flag | Value | Description |
|---|---|---|
| SUPPRESS_EMBEDS | 4 | Do not include embeds when serialising this message |
| SUPPRESS_NOTIFICATIONS | 4096 | This message will not trigger push or desktop notifications |
| VOICE_MESSAGE | 8192 | This message is a voice message |
| COMPACT_ATTACHMENTS | 131072 | Display attachments in a compact format |
MessageReactionResponse
| Field | Type | Description |
|---|---|---|
| count | integer (int32) | The total number of times this reaction has been used |
| emoji | MessageReactionResponseEmoji | The emoji used for the reaction |
| me? | ?enum<true> | Whether the current user has reacted with this emoji |
MessageReferenceResponse
| Field | Type | Description |
|---|---|---|
| channel_id | SnowflakeType | The ID of the channel containing the referenced message |
| guild_id? | ?SnowflakeType | The ID of the guild containing the referenced message |
| message_id | SnowflakeType | The ID of the referenced message |
| type | MessageReferenceType |
MessageReferenceType
The type of message reference| Value | Description |
|---|---|
0 | Default reference (reply) |
1 | Forwarded message reference |
MessageReportCategoryEnum
Category of the message report| Value | Description |
|---|---|
harassment | Content that harasses, bullies, or intimidates users |
hate_speech | Content promoting hatred against protected groups |
violent_content | Content depicting or promoting violence |
spam | Unsolicited bulk messages or promotional content |
nsfw_violation | Adult content posted outside age-restricted channels |
illegal_activity | Content promoting or facilitating illegal activities |
doxxing | Content revealing private personal information |
self_harm | Content promoting self-harm or suicide |
child_safety | Content that endangers minors or depicts child abuse |
malicious_links | Links to malware, phishing, or other malicious sites |
impersonation | Content falsely claiming to be another person or entity |
other | Other violations not covered by specific categories |
MessageResponseSchema
Related endpointsGET /channels/{channel_id}/messagesGET /channels/{channel_id}/messages/{message_id}POST /channels/{channel_id}/messagesPOST /webhooks/{webhook_id}/{token}PATCH /channels/{channel_id}/messages/{message_id}
| Field | Type | Description |
|---|---|---|
| attachments? | ?MessageAttachmentResponse[] | The files attached to the message |
| author | UserPartialResponse | |
| call? | ?MessageCallResponse | Call information if this message represents a call |
| channel_id | SnowflakeType | The ID of the channel this message was sent in |
| content | string | The text content of the message |
| edited_timestamp? | ?string (date-time) | The ISO 8601 timestamp of when the message was last edited |
| embeds? | ?MessageEmbedResponse[] | The embeds attached to the message |
| flags | MessageFlags | |
| id | SnowflakeType | The unique identifier (snowflake) for this message |
| mention_everyone | boolean | Whether the message mentions @everyone |
| mention_roles? | ?SnowflakeType[] | The role IDs mentioned in the message |
| mentions? | ?UserPartialResponse[] | The users mentioned in the message |
| message_reference? | ?MessageReferenceResponse | Reference data for replies or forwards |
| message_snapshots? | ?MessageSnapshotResponse[] | Snapshots of forwarded messages |
| nonce? | ?string | A client-provided value for message deduplication |
| pinned | boolean | Whether the message is pinned |
| reactions? | ?MessageReactionResponse[] | The reactions on the message |
| referenced_message? | ?MessageBaseResponseSchema | The message that this message is replying to or forwarding |
| stickers? | ?MessageStickerResponse[] | The stickers sent with the message |
| timestamp | string (date-time) | The ISO 8601 timestamp of when the message was created |
| tts? | boolean | Whether the message was sent as text-to-speech |
| type | MessageResponseSchemaType | The type of message |
| webhook_id? | ?SnowflakeType | The ID of the webhook that sent this message |
MessageSearchIndexingResponse
| Field | Type | Description |
|---|---|---|
| indexing | enum<true> | Indicates that one or more channels are being indexed |
MessageSearchResultsResponse
| Field | Type | Description |
|---|---|---|
| hits_per_page | integer (int32) | The maximum number of messages returned per page |
| messages | MessageBaseResponseSchema[] | The messages matching the search query |
| page | integer (int32) | The current page number |
| total | integer (int32) | The total number of messages matching the search |
MessageSearchScope
Search scope for message searches| Value | Description |
|---|---|
current | Search only in the current channel or community context |
open_dms | Search across all DMs you currently have open |
all_dms | Search across all DMs you’ve ever been in |
all_guilds | Search across all Communities you’re currently in |
all | Search across all DMs you’ve ever been in and all Communities you’re currently in |
open_dms_and_all_guilds | Search across all DMs you currently have open and all Communities you’re currently in |
MessageShredStatusNotFoundResponse
| Field | Type | Description |
|---|---|---|
| status | enum<not_found> |
MessageShredStatusProgressResponse
| Field | Type | Description |
|---|---|---|
| completed_at? | string | |
| error? | string | |
| failed_at? | string | |
| processed | Int32Type | |
| requested | Int32Type | |
| skipped | Int32Type | |
| started_at? | string | |
| status | MessageShredStatusProgressResponseStatus | Current message shred job status |
| total | Int32Type |
MessageSnapshotResponse
| Field | Type | Description |
|---|---|---|
| attachments? | ?MessageAttachmentResponse[] | The attachments included in the snapshot |
| content? | ?string | The text content of the snapshot |
| edited_timestamp? | ?string (date-time) | The ISO 8601 timestamp of when the original message was last edited |
| embeds? | ?MessageEmbedResponse[] | The embeds included in the snapshot |
| flags | MessageFlags | |
| mention_roles? | ?SnowflakeType[] | The role IDs mentioned in the snapshot |
| mentions? | ?SnowflakeType[] | The user IDs mentioned in the snapshot |
| stickers? | ?MessageStickerResponse[] | The stickers included in the snapshot |
| timestamp | string (date-time) | The ISO 8601 timestamp of when the original message was created |
| type | MessageResponseSchemaType | The type of message |
MessageSortField
The field to sort search results by| Value | Description |
|---|---|
timestamp | Sort results by message timestamp |
relevance | Sort results by search relevance score |
MessageSortOrder
The order to sort search results| Value | Description |
|---|---|
asc | Sort in ascending order (oldest/lowest first) |
desc | Sort in descending order (newest/highest first) |
MessageStickerResponse
| Field | Type | Description |
|---|---|---|
| animated | boolean | Whether the sticker is animated |
| id | SnowflakeType | The unique identifier of the sticker |
| name | string | The name of the sticker |
PermissionOverwriteCreateRequest
Related endpoints| Field | Type | Description |
|---|---|---|
| allow? | UnsignedInt64Type | |
| deny? | UnsignedInt64Type | |
| type | enum<0, 1> | The type of overwrite (0 = role, 1 = member) |
ReactionUsersListResponse
Related endpoints Type: UserPartialResponse[]RtcRegionResponse
Related endpoints| Field | Type | Description |
|---|---|---|
| emoji | string | The emoji associated with this RTC region |
| id | SnowflakeType | The unique identifier for this RTC region |
| name | string | The display name of the RTC region |
ScheduledMessageAllowedMentionsSchema
| Field | Type | Description |
|---|---|---|
| parse? | ScheduledMessageAllowedMentionsSchemaParse[] | Types of mentions to parse from content |
| replied_user? | boolean | Whether to mention the author of the replied message |
| roles? | SnowflakeType[] | Array of role IDs to mention |
| users? | SnowflakeType[] | Array of user IDs to mention |
ScheduledMessageReferenceSchema
| Field | Type | Description |
|---|---|---|
| channel_id? | SnowflakeType | |
| guild_id? | SnowflakeType | |
| message_id | SnowflakeType | ID of the message being referenced |
| type? | MessageReferenceType | The type of message reference |
StreamPreviewUploadBodySchema
Related endpoints| Field | Type | Description |
|---|---|---|
| channel_id | SnowflakeType | |
| content_type? | string | MIME type of the thumbnail image |
| thumbnail | string | Base64-encoded thumbnail image data |
StreamUpdateBodySchema
Related endpoints| Field | Type | Description |
|---|---|---|
| region? | string | The preferred voice region for the stream (1-64 characters) |
VoiceRegionAdminResponse
| Field | Type | Description |
|---|---|---|
| allowed_guild_ids | SnowflakeType[] | Guild IDs explicitly allowed to use this region |
| allowed_user_ids | SnowflakeType[] | User IDs explicitly allowed to use this region |
| created_at | ?string | ISO 8601 timestamp when the region was created |
| emoji | string | Emoji representing the region |
| id | SnowflakeType | Unique identifier for the voice region |
| is_default | boolean | Whether this is the default region |
| latitude | number | Geographic latitude coordinate |
| longitude | number | Geographic longitude coordinate |
| name | string | Display name of the voice region |
| required_guild_features | string[] | Guild features required to use this region |
| updated_at | ?string | ISO 8601 timestamp when the region was last updated |
| vip_only | boolean | Whether this region is restricted to VIP users |
VoiceRegionWithServersResponse
| Field | Type | Description |
|---|---|---|
| allowed_guild_ids | SnowflakeType[] | Guild IDs explicitly allowed to use this region |
| allowed_user_ids | SnowflakeType[] | User IDs explicitly allowed to use this region |
| created_at | ?string | ISO 8601 timestamp when the region was created |
| emoji | string | Emoji representing the region |
| id | SnowflakeType | Unique identifier for the voice region |
| is_default | boolean | Whether this is the default region |
| latitude | number | Geographic latitude coordinate |
| longitude | number | Geographic longitude coordinate |
| name | string | Display name of the voice region |
| required_guild_features | string[] | Guild features required to use this region |
| servers? | VoiceServerAdminResponse[] | Voice servers in this region |
| updated_at | ?string | ISO 8601 timestamp when the region was last updated |
| vip_only | boolean | Whether this region is restricted to VIP users |
VoiceServerAdminResponse
| Field | Type | Description |
|---|---|---|
| allowed_guild_ids | SnowflakeType[] | Guild IDs explicitly allowed to use this server |
| allowed_user_ids | SnowflakeType[] | User IDs explicitly allowed to use this server |
| created_at | ?string | ISO 8601 timestamp when the server was created |
| endpoint | string (uri) | Client signal WebSocket endpoint URL for the voice server |
| is_active | boolean | Whether the server is currently active |
| region_id | SnowflakeType | ID of the region this server belongs to |
| required_guild_features | string[] | Guild features required to use this server |
| server_id | SnowflakeType | Unique identifier for the voice server |
| updated_at | ?string | ISO 8601 timestamp when the server was last updated |
| vip_only | boolean | Whether this server is restricted to VIP users |
MessageShredStatusProgressResponseStatus
Current message shred job status| Value | Description |
|---|---|
in_progress | Shredding is currently running |
completed | Shredding completed successfully |
failed | Shredding failed |
ChannelUpdateTextRequestType
| Value | Description |
|---|---|
0 | Channel type (text channel) |
ChannelOverwriteRequestType
The type of overwrite (0 = role, 1 = member)| Value | Description |
|---|---|
0 | - |
1 | - |
ChannelUpdateVoiceRequestType
| Value | Description |
|---|---|
2 | Channel type (voice channel) |
ChannelUpdateCategoryRequestType
| Value | Description |
|---|---|
4 | Channel type (category) |
ChannelUpdateLinkRequestType
| Value | Description |
|---|---|
998 | Channel type (link channel) |
ChannelUpdateGroupDmRequestType
| Value | Description |
|---|---|
3 | Channel type (group DM) |
MessageResponseSchemaType
The type of message| Value | Description |
|---|---|
0 | A regular message |
1 | A system message indicating a user was added to the conversation |
2 | A system message indicating a user was removed from the conversation |
3 | A message representing a call |
4 | A system message indicating the channel name changed |
5 | A system message indicating the channel icon changed |
6 | A system message indicating a message was pinned |
7 | A system message indicating a user joined |
19 | A reply message |
MessageReactionResponseEmoji
The emoji used for the reaction| Field | Type | Description |
|---|---|---|
| animated? | ?boolean | Whether the emoji is animated |
| id? | ?SnowflakeType | The ID of the custom emoji (null for Unicode emojis) |
| name | string | The name of the emoji (or Unicode character for standard emojis) |
ScheduledMessageAllowedMentionsSchemaParse
Types of mentions to parse from content| Value | Description |
|---|---|
users | Parse user mentions from the message content |
roles | Parse role mentions from the message content |
everyone | Parse @everyone and @here mentions from the message content |