Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify if sessions are resumable for each gateway close code #7172

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Clarify if sessions are resumable for each gateway close code #7172

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6d90ebd
Clarify if sessions are resumable for each gateway close
Zoddo Sep 24, 2024
052fa43
Fix table formatting
Zoddo Sep 24, 2024
b6ee5ad
Use 2 seperate 'Reconnect' & 'Resume' columns instead of a single 'Ac…
Zoddo Sep 25, 2024
275e100
Merge branch 'main' into patch-1
Zoddo Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/topics/Opcodes_and_Status_Codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,25 @@ All gateway events in Discord are tagged with an opcode that denotes the payload

###### Gateway Close Event Codes

In order to prevent broken reconnect loops, you should consider some close codes as a signal to stop reconnecting. This can be because your token expired, or your identification is invalid. This table explains what the application defined close codes for the gateway are, and which close codes you should not attempt to reconnect.
In order to prevent broken reconnect loops, you should consider some close codes as a signal to stop reconnecting. This can be because your token expired, or your identification is invalid. This table explains what the application-defined close codes for the gateway are, which close codes you should not attempt to reconnect, and which ones require you to start a new session.


| Code | Description | Explanation | Reconnect |
|------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
| 4000 | Unknown error | We're not sure what went wrong. Try reconnecting? | true |
| 4001 | Unknown opcode | You sent an invalid [Gateway opcode](#DOCS_TOPICS_OPCODES_AND_STATUS_CODES/gateway-gateway-opcodes) or an invalid payload for an opcode. Don't do that! | true |
| 4002 | Decode error | You sent an invalid [payload](#DOCS_EVENTS_GATEWAY/sending-events) to Discord. Don't do that! | true |
| 4003 | Not authenticated | You sent us a payload prior to [identifying](#DOCS_EVENTS_GATEWAY/identifying), or this session has been invalidated. | true |
| 4004 | Authentication failed | The account token sent with your [identify payload](#DOCS_EVENTS_GATEWAY_EVENTS/identify) is incorrect. | false |
| 4005 | Already authenticated | You sent more than one identify payload. Don't do that! | true |
| 4007 | Invalid `seq` | The sequence sent when [resuming](#DOCS_EVENTS_GATEWAY_EVENTS/resume) the session was invalid. Reconnect and start a new session. | true |
| 4008 | Rate limited | Woah nelly! You're sending payloads to us too quickly. Slow it down! You will be disconnected on receiving this. | true |
| 4009 | Session timed out | Your session timed out. Reconnect and start a new one. | true |
| 4010 | Invalid shard | You sent us an invalid [shard when identifying](#DOCS_EVENTS_GATEWAY/sharding). | false |
| 4011 | Sharding required | The session would have handled too many guilds - you are required to [shard](#DOCS_EVENTS_GATEWAY/sharding) your connection in order to connect. | false |
| 4012 | Invalid API version | You sent an invalid version for the gateway. | false |
| 4013 | Invalid intent(s) | You sent an invalid intent for a [Gateway Intent](#DOCS_EVENTS_GATEWAY/gateway-intents). You may have incorrectly calculated the bitwise value. | false |
| 4014 | Disallowed intent(s) | You sent a disallowed intent for a [Gateway Intent](#DOCS_EVENTS_GATEWAY/gateway-intents). You may have tried to specify an intent that you [have not enabled or are not approved for](#DOCS_EVENTS_GATEWAY/privileged-intents). | false |
| Code | Description | Explanation | Reconnect | Resume |
|------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|--------|
| 4000 | Unknown error | We're not sure what went wrong. Try reconnecting? | true | true |
| 4001 | Unknown opcode | You sent an invalid [Gateway opcode](#DOCS_TOPICS_OPCODES_AND_STATUS_CODES/gateway-gateway-opcodes) or an invalid payload for an opcode. Don't do that! | true | false |
| 4002 | Decode error | You sent an invalid [payload](#DOCS_EVENTS_GATEWAY/sending-events) to Discord. Don't do that! | true | true |
| 4003 | Not authenticated | You sent us a payload prior to [identifying](#DOCS_EVENTS_GATEWAY/identifying), or this session has been invalidated. | true | false |
| 4004 | Authentication failed | The account token sent with your [identify payload](#DOCS_EVENTS_GATEWAY_EVENTS/identify) is incorrect. | false | false |
| 4005 | Already authenticated | You sent more than one identify payload. Don't do that! | true | false |
| 4007 | Invalid `seq` | The sequence sent when [resuming](#DOCS_EVENTS_GATEWAY_EVENTS/resume) the session was invalid. | true | false |
| 4008 | Rate limited | Woah nelly! You're sending payloads to us too quickly. Slow it down! You will be disconnected on receiving this. | true | true |
| 4009 | Session timed out | Your session timed out. | true | false |
| 4010 | Invalid shard | You sent us an invalid [shard when identifying](#DOCS_EVENTS_GATEWAY/sharding). | false | false |
| 4011 | Sharding required | The session would have handled too many guilds - you are required to [shard](#DOCS_EVENTS_GATEWAY/sharding) your connection in order to connect. | false | false |
| 4012 | Invalid API version | You sent an invalid version for the gateway. | false | false |
| 4013 | Invalid intent(s) | You sent an invalid intent for a [Gateway Intent](#DOCS_EVENTS_GATEWAY/gateway-intents). You may have incorrectly calculated the bitwise value. | false | false |
| 4014 | Disallowed intent(s) | You sent a disallowed intent for a [Gateway Intent](#DOCS_EVENTS_GATEWAY/gateway-intents). You may have tried to specify an intent that you [have not enabled or are not approved for](#DOCS_EVENTS_GATEWAY/privileged-intents). | false | false |

## Voice

Expand Down