Presence Resource

A user's presence is their current status and activity. Presences are usually per-guild, but user accounts also receive overall user presences for friends and implicit relationships (depending on the NO_AFFINE_USER_IDS Gateway capability).

¹ invisible can only be sent and never received. offline can only be received and never sent.

² This value can only be sent, and is used when the user's initial presence is unknown and should be assigned by the Gateway.

Active sessions are indicated with a status per platform. If a user is offline or invisible, the corresponding field is not present.

¹ Used as the default when the platform is not known.

¹ The name of a CUSTOM activity should always be "Custom Status". The name of a HANG activity should always be "Hang Status".

² The STREAMING type currently only supports Twitch and YouTube. Only https://twitch.tv/ and https://youtube.com/ URLs will work.

³ This field is not commonly used for traditional presences (i.e. presences sent by regular clients over the Gateway) and is instead used to differentiate between various headless and embedded activities.

⁴ In the case of the HANG type, this field should be one of the hang status types. If set to custom, the details field should be used to specify the custom text, and the emoji field should be used to specify the custom emoji.

⁵ These fields are send-only. For retrieving rich presence metadata, see Get Activity Metadata. For retrieving secrets, see Get Activity Secret.

¹ This type is only displayed if the user has an active voice state.

² See activity hang status type for more information.

When a HANG activity's state is set to one of these values, a built-in corresponding emoji will be used instead of the custom emoji field.

¹ Spectating has been removed from official clients and is no longer supported.

² Activities no longer need to be explicitly flagged as join requestable.

¹ These rich presence invites can be used with the Get Activity Secret endpoint to join/spectate the activity.

² Spectating has been removed from official clients and is no longer supported.

³ This action type is special in that instead of inviting others to a party, it asks existing party members to invite the user to join their party. Inviting users is done by sending a message back with a rich presence invite.

Activity asset images are arbitrary strings which usually contain snowflake IDs or prefixed image IDs. Treat data within this field carefully, as it is user-specifiable and not sanitized.

To use an external image via media proxy, specify the URL as the field's value when sending. You will only receive the mp:-prefixed value via the Gateway.

¹ Spectating has been removed from official clients and is no longer supported.

{
  "id": "d11307d8c0abb136",
  "created_at": "1695164784863",
  "details": "24H RL Stream for Charity",
  "state": "Rocket League",
  "name": "Twitch",
  "type": 1,
  "url": "https://www.twitch.tv/discord",
  "assets": {
    "large_image": "twitch:discord"
  }
}

{
  "id": "d11307d8c0abb135",
  "name": "Rocket League",
  "type": 0,
  "created_at": "1695164784863",
  "session_id": "30f32c5d54ae86130fc4a215c7474263",
  "application_id": "379286085710381999",
  "state": "In a Match",
  "details": "Ranked Duos: 2-1",
  "platform": "xbox",
  "flags": 0,
  "timestamps": {
    "start": "1695164482423"
  },
  "party": {
    "id": "9dd6594e-81b3-49f6-a6b5-a679e6a060d3",
    "size": [2, 2]
  },
  "assets": {
    "large_image": "351371005538729000",
    "large_text": "DFH Stadium",
    "small_image": "351371005538729111",
    "small_text": "Silver III"
  },
  "secrets": {
    "join": "025ed05c71f639de8bfaa0d679d7c94b2fdce12f"
  }
}

Returns the overall user presence for all of the user's non-offline friends and implicit relationships.

Updates the current user's mobile game activity. Returns a 204 empty response on success. Fires a Sessions Replace Gateway event.

Returns the activity metadata for a given activity, or a 204 empty response if no metadata is found.

Returns an activity secret that can be used to join or spectate the game. Only supports the JOIN and SPECTATE action types.

{ "secret": "025ed05c71f639de8bfaa0d679d7c94b2fdce12f" }