Quitter un lobby en tant que serveur

Preview: Request for server to leave a lobby. This is restricted to client owned 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
LobbyDoesNotExist	13000
LobbyDoesNotUseConnections	13017
LobbyIsNotClientOwned	13016
LobbyRateLimitExceeded	13001
LobbyServerMismatch	13012
LobbyServerNotFound	13013

POST

Lobby

LeaveLobbyAsServer

Leave Lobby As Server

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/LeaveLobbyAsServer \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "ServerEntity": {
    "Id": "1234",
    "Type": "game_server",
    "TypeString": "game_server"
  },
  "LobbyId": "12345678-1234-1234-1234-123456789ABC"
}
'

import requests

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

payload = {
    "ServerEntity": {
        "Id": "1234",
        "Type": "game_server",
        "TypeString": "game_server"
    },
    "LobbyId": "12345678-1234-1234-1234-123456789ABC"
}
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'},
    LobbyId: '12345678-1234-1234-1234-123456789ABC'
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/LeaveLobbyAsServer', 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/LeaveLobbyAsServer",
  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'
    ],
    'LobbyId' => '12345678-1234-1234-1234-123456789ABC'
  ]),
  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/LeaveLobbyAsServer"

	payload := strings.NewReader("{\n  \"ServerEntity\": {\n    \"Id\": \"1234\",\n    \"Type\": \"game_server\",\n    \"TypeString\": \"game_server\"\n  },\n  \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\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/LeaveLobbyAsServer")
  .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  \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}"

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

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

{
  "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 for server to leave a lobby. Only a game_server entity can leave and this is restricted to client owned lobbies which are using connections.

LobbyId

string

requis

The id of the lobby.

ServerEntity

object

requis

The game_server entity leaving the lobby. If the game_server was subscribed to notifications, it will be unsubscribed. If a the given game_server entity is not in the lobby, it will fail.

Show child attributes

CustomTags

object

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

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

Dernière modification le 6 octobre 2026

Sujets connexes

Rejoindre un lobby en tant que serveur Mettre à jour un lobby en tant que serveur Serveurs Créer un lobby PFMultiplayerJoinLobbyAsServer

⌘I

Leave Lobby As Server

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/LeaveLobbyAsServer \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "ServerEntity": {
    "Id": "1234",
    "Type": "game_server",
    "TypeString": "game_server"
  },
  "LobbyId": "12345678-1234-1234-1234-123456789ABC"
}
'

import requests

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

payload = {
    "ServerEntity": {
        "Id": "1234",
        "Type": "game_server",
        "TypeString": "game_server"
    },
    "LobbyId": "12345678-1234-1234-1234-123456789ABC"
}
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'},
    LobbyId: '12345678-1234-1234-1234-123456789ABC'
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/LeaveLobbyAsServer', 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/LeaveLobbyAsServer",
  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'
    ],
    'LobbyId' => '12345678-1234-1234-1234-123456789ABC'
  ]),
  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/LeaveLobbyAsServer"

	payload := strings.NewReader("{\n  \"ServerEntity\": {\n    \"Id\": \"1234\",\n    \"Type\": \"game_server\",\n    \"TypeString\": \"game_server\"\n  },\n  \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\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/LeaveLobbyAsServer")
  .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  \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}"

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

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

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

PlayFab API

PlayFab REST API References

Quitter un lobby en tant que serveur

Error codes

Autorisations

Corps

Réponse