Leave Game Room

Remove players from a game room

Removes one or more players from an existing game room using their session JWTs.

Endpoint: /game/leave Method: POST

Request Parameters

{
    roomId: string; // The ID of the room to leave
    sessionJwts: string[]; // Array of session JWTs for players leaving the room
    sync?: boolean; // When true, returns direct response. When false/undefined, returns a task ID for polling status
}

Success Response (200)

When sync=false (default):

{
    task: {
        id: string; // Task ID for checking status
    }
}

When sync=true:

{
    roomId: string;
    plyrIds: string[]; // Array of player IDs that left
}

Error Response (400)

{
    error: string;
}

Example Usage

// Sync=true usage
const timestamp = Date.now().toString();
const body = {
    roomId: '123',
    sessionJwts: ['playerJwt1', 'playerJwt2'], // Multiple players can leave at once
    sync: true // or omit for task-based response
};

const hmac = generateHmacSignature(timestamp, body, secretKey);

const response = await axios.post(apiEndpoint + '/game/leave', body, {
    headers: {
        apikey: apiKey,
        signature: hmac,
        timestamp: timestamp
    }
});