Rejoindre un lobby en tant que serveur

Preview: Join a lobby as a server entity. This is restricted to client lobbies which are using connections.

Allowed entity token types: game_server

Error codes

This operation may return the following PlayFab errors:

Error	Code
LobbyBadRequest	13007
LobbyDifferentServerAlreadyJoined	13014
LobbyDoesNotExist	13000
LobbyDoesNotUseConnections	13017
LobbyIsNotClientOwned	13016
LobbyRateLimitExceeded	13001
LobbyServerAlreadyJoined	13015

POST

Lobby

JoinLobbyAsServer

Join Lobby As Server

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "ServerEntity": {
    "Id": "1234",
    "Type": "game_server",
    "TypeString": "game_server"
  },
  "ConnectionString": "connString",
  "ServerData": {
    "MyDataKey": "MyDataKey value"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer"

payload = {
    "ServerEntity": {
        "Id": "1234",
        "Type": "game_server",
        "TypeString": "game_server"
    },
    "ConnectionString": "connString",
    "ServerData": { "MyDataKey": "MyDataKey value" }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ServerEntity: {Id: '1234', Type: 'game_server', TypeString: 'game_server'},
    ConnectionString: 'connString',
    ServerData: {MyDataKey: 'MyDataKey value'}
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ServerEntity' => [
        'Id' => '1234',
        'Type' => 'game_server',
        'TypeString' => 'game_server'
    ],
    'ConnectionString' => 'connString',
    'ServerData' => [
        'MyDataKey' => 'MyDataKey value'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer"

	payload := strings.NewReader("{\n  \"ServerEntity\": {\n    \"Id\": \"1234\",\n    \"Type\": \"game_server\",\n    \"TypeString\": \"game_server\"\n  },\n  \"ConnectionString\": \"connString\",\n  \"ServerData\": {\n    \"MyDataKey\": \"MyDataKey value\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ServerEntity\": {\n    \"Id\": \"1234\",\n    \"Type\": \"game_server\",\n    \"TypeString\": \"game_server\"\n  },\n  \"ConnectionString\": \"connString\",\n  \"ServerData\": {\n    \"MyDataKey\": \"MyDataKey value\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ServerEntity\": {\n    \"Id\": \"1234\",\n    \"Type\": \"game_server\",\n    \"TypeString\": \"game_server\"\n  },\n  \"ConnectionString\": \"connString\",\n  \"ServerData\": {\n    \"MyDataKey\": \"MyDataKey value\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {
    "LobbyId": "<string>"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorisations

X-EntityToken

string

header

requis

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

Corps

application/json

Preview: Request to join a lobby as a server. Only callable by a game_server entity and this is restricted to client owned lobbies which are using connections.

ConnectionString

string

requis

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

ServerEntity

object

requis

The game_server entity which is joining the Lobby. If a different game_server entity has already joined the request will fail unless the joined entity is disconnected, in which case the incoming game_server entity will replace the disconnected entity.

Show child attributes

CustomTags

object

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

ServerData

object

The private key-value pairs which are visible to all entities in the lobby but can only be modified by the joined server.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 serverData values may not exceed 4096 bytes.

Réponse

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Dernière modification le 6 octobre 2026

Sujets connexes

Quitter un lobby en tant que serveur Mettre à jour un lobby en tant que serveur Rejoindre des lobbies Méthode PlayFabMultiplayerServer.JoinLobbyAsServer Lobby

⌘I

Join Lobby As Server

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "ServerEntity": {
    "Id": "1234",
    "Type": "game_server",
    "TypeString": "game_server"
  },
  "ConnectionString": "connString",
  "ServerData": {
    "MyDataKey": "MyDataKey value"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer"

payload = {
    "ServerEntity": {
        "Id": "1234",
        "Type": "game_server",
        "TypeString": "game_server"
    },
    "ConnectionString": "connString",
    "ServerData": { "MyDataKey": "MyDataKey value" }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ServerEntity: {Id: '1234', Type: 'game_server', TypeString: 'game_server'},
    ConnectionString: 'connString',
    ServerData: {MyDataKey: 'MyDataKey value'}
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ServerEntity' => [
        'Id' => '1234',
        'Type' => 'game_server',
        'TypeString' => 'game_server'
    ],
    'ConnectionString' => 'connString',
    'ServerData' => [
        'MyDataKey' => 'MyDataKey value'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer"

	payload := strings.NewReader("{\n  \"ServerEntity\": {\n    \"Id\": \"1234\",\n    \"Type\": \"game_server\",\n    \"TypeString\": \"game_server\"\n  },\n  \"ConnectionString\": \"connString\",\n  \"ServerData\": {\n    \"MyDataKey\": \"MyDataKey value\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ServerEntity\": {\n    \"Id\": \"1234\",\n    \"Type\": \"game_server\",\n    \"TypeString\": \"game_server\"\n  },\n  \"ConnectionString\": \"connString\",\n  \"ServerData\": {\n    \"MyDataKey\": \"MyDataKey value\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Lobby/JoinLobbyAsServer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ServerEntity\": {\n    \"Id\": \"1234\",\n    \"Type\": \"game_server\",\n    \"TypeString\": \"game_server\"\n  },\n  \"ConnectionString\": \"connString\",\n  \"ServerData\": {\n    \"MyDataKey\": \"MyDataKey value\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {
    "LobbyId": "<string>"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Rejoindre un lobby en tant que serveur

Error codes

Autorisations

Corps

Réponse