Get Task Message Status

Get the status of a task message

Check the status of an asynchronous task message.

Endpoint: /task/status/{taskId} Method: GET

Request Parameters

{
    taskId: string; // The task's unique identifier
}

Success Response (200)

{
    taskId: string;
    taskData: {
        '0': string;
        '1': {
            gameId: string;
            plyrIds?: string[];
            roomId?: string;
            expiresIn?: number; // in seconds and only for createGameRoom
        };
        result?: {
            gameId: string;
            roomId: string;
            roomAddress: string;
        };
    };
    status: 'SUCCESS' | 'PENDING' | 'FAILED' | 'TIMEOUT';
    hash: string;
    errorMessage?: string;
    completedAt: string;
}

Error Response (404)

{
    error: string;
}

Example Usage

// Setup request parameters
const timestamp = Date.now().toString();
const taskId = 'task_abc123xyz789';

// Generate HMAC signature (empty body for GET request)
const hmac = generateHmacSignature(timestamp, {}, secretKey);

// Make the API request
const response = await axios.get(apiEndpoint + '/task/status/' + taskId, {
    headers: {
        apikey: apiKey,
        signature: hmac,
        timestamp: timestamp
    }
});

Tasks are asynchronous operations that may take some time to complete. Use this endpoint to check their status.

Task status should be polled at reasonable intervals (e.g., every 1-2 seconds) to avoid rate limiting.