Lobbies

Lobbies are groups of users that can communicate with each other via text and voice. Users can be in multiple lobbies at once. A lobby can also have metadata (an arbitrary JSON blob) associated with the lobby and each user.

Lobbies have a text chat channel that all members can use to communicate. Messages are sent to all members of the lobby. Lobbies support also voice calls. Although a lobby is allowed to have 1,000 members, you should not start voice calls in lobbies that large (around 25 is a good number).

Lobby Object

A game lobby within Discord.

Lobby Structure

Lobby Flags

Example Lobby Object

{
  "id": "1350184413060661332",
  "application_id": "891436243903728565",
  "metadata": {
    "topic": "balls"
  },
  "members": [
    {
      "id": "852892297661906993",
      "metadata": null,
      "flags": 1
    }
  ]
}

Lobby Member Object

Represents a member of a lobby.

Lobby Member Structure

¹ Not included when returned over the Gateway.

² Only included in lobby objects returned over the Gateway.

Lobby Member Flags

Endpoints

Creates a new lobby. Returns a lobby object on success. Fires a Lobby Create Gateway event.

JSON Params

Joins an existing lobby or creates a new lobby. Returns a lobby object on success. May fire a Lobby Create or Lobby Member Add Gateway event.

JSON Params

¹ Secret values expire after 30 days. After this time period, the lobby will still exist, but new users won't be able to join.

Returns a lobby object for the given lobby ID. User must be a member of the lobby.

Modifies a lobby's settings. Application must be the creator of the lobby. Returns the updated lobby object on success. Fires a Lobby Update Gateway event.

JSON Params

Deletes a lobby. Application must be the creator of the lobby. Returns a 204 empty response on success. Fires a Lobby Delete Gateway event.

Adds a member to the lobby. Returns the lobby member object. Fires a Lobby Member Add or Lobby Member Update Gateway event.

JSON Params

Removes a member from the lobby. Returns a 204 empty response on success. Fires a Lobby Member Remove Gateway event.

Removes the current user from the lobby. Returns a 204 empty response on success. Fires a Lobby Delete and Lobby Member Remove Gateway event.

Modifies multiple members in a lobby in a single request. Accepts a list of 1 to 25 update lobby member objects. Returns a list of lobby member objects on success. May fire multiple Lobby Member Add, and/or Lobby Member Remove Gateway events.

Update Lobby Member Structure

Creates an invite for the channel linked to the lobby that can only be accepted by the current user. Fires an Invite Create Gateway event.

Response Body

Creates an invite for the channel linked to the lobby that can only be accepted by the specified user. Fires an Invite Create Gateway event.

Response Body

Links or unlinks a channel to the lobby. Returns a lobby object on success. Fires a Lobby Update and Channel Update Gateway event.

The application must be the creator of the lobby or the member must have the CAN_LINK_LOBBY flag. Requires the MANAGE_CHANNELS permission in the target channel.

JSON Params

Returns a list of partial message objects in the lobby in reverse chronological order.

Query String Params

Posts a message to a lobby. Returns a partial message object on success. Fires a Lobby Message Create and Message Create Gateway event. Functionally identical to the Create Message endpoint, but is used for lobbies in an OAuth2 context and has some additional parameters. Check there for more information.

Extra JSON Params

Updates a lobby message's moderation metadata. Accepts a moderation metadata mapping, up to 5 keys, max 2000 characters per value. Returns a 204 empty response. Fires a Lobby Message Update or Message Update Gateway event.