Matchmaking - Player Joined

Informs the PlayFab game server hosting service that the indicated user has joined the Game Server Instance specified

POST https://titleId.playfabapi.com/Matchmaker/PlayerJoined

Request Body

Name Required Type Description
LobbyId True
  • string

Unique identifier of the Game Server Instance the user is joining. This must be a Game Server Instance started with the Matchmaker/StartGame API.

PlayFabId True
  • string

PlayFab unique identifier for the player joining.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

PlayerJoinedRequest
PlayerJoinedResponse

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

PlayerJoinedRequest

Name Type Description
LobbyId
  • string

Unique identifier of the Game Server Instance the user is joining. This must be a Game Server Instance started with the Matchmaker/StartGame API.

PlayFabId
  • string

PlayFab unique identifier for the player joining.

PlayerJoinedResponse