Lobby - Join Lobby

  • Reference
Service:
Multiplayer
API Version:
240412

Join a lobby.

POST https://titleId.playfabapi.com/Lobby/JoinLobby

Request Header

Name Required Type Description
X-EntityToken True

string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Type Description
ConnectionString

string

A field which indicates which lobby the user will be joining. This field is opaque to everyone except the Lobby service.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
MemberData

object

The private key-value pairs used by the member to communicate information to other members and the owner. Visible to all entities in the lobby. At most 30 key-value pairs may be stored here, keys are limited to 30 characters and values to 1000. The total size of all memberData values may not exceed 4096 bytes.Keys are case sensitive.
MemberEntity

EntityKey

The member entity who is joining the lobby.

Responses

Name Type Description
200 OK

JoinLobbyResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.
JoinLobbyRequest

Request to join a lobby. Only a client can join a lobby.
JoinLobbyResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

Numerical PlayFab error code
errorDetails

object

Detailed description of individual issues with the request object
errorMessage

string

Description for the PlayFab errorCode
status

string

String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id

string

Unique ID of the entity.
Type

string

Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

JoinLobbyRequest

Request to join a lobby. Only a client can join a lobby.

Name Type Description
ConnectionString

string

A field which indicates which lobby the user will be joining. This field is opaque to everyone except the Lobby service.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
MemberData

object

The private key-value pairs used by the member to communicate information to other members and the owner. Visible to all entities in the lobby. At most 30 key-value pairs may be stored here, keys are limited to 30 characters and values to 1000. The total size of all memberData values may not exceed 4096 bytes.Keys are case sensitive.
MemberEntity

EntityKey

The member entity who is joining the lobby.

JoinLobbyResult

Name Type Description
LobbyId

string

Successfully joined lobby's id.

Error Codes

Name Code
LobbyBadRequest 13007
LobbyDoesNotExist 13000
LobbyMemberCannotRejoin 13004
LobbyNotJoinable 13003
LobbyPlayerAlreadyJoined 13002
LobbyPlayerMaxLobbyLimitExceeded 13008
LobbyRateLimitExceeded 13001