telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface TelegramWebAppData

    Parsed Telegram Mini App initData payload.

    interface TelegramWebAppData {
        auth_date: number;
        can_send_after?: number;
        chat?: {
            id: number;
            photo_url?: string;
            title: string;
            type: string;
            username?: string;
            [key: string]: unknown;
        };
        chat_instance?: string;
        chat_type?: string;
        hash: string;
        query_id?: string;
        raw: Record<string, string>;
        receiver?: {
            first_name: string;
            id: number;
            is_bot?: boolean;
            last_name?: string;
            username?: string;
            [key: string]: unknown;
        };
        start_param?: string;
        user?: {
            allows_write_to_pm?: boolean;
            first_name: string;
            id: number;
            is_bot?: boolean;
            is_premium?: boolean;
            language_code?: string;
            last_name?: string;
            photo_url?: string;
            username?: string;
            [key: string]: unknown;
        };
    }
    Index
    auth_date can_send_after? chat? chat_instance? chat_type? hash query_id? raw receiver? start_param? user?
    auth_date: number

    Unix timestamp of when the Web App data was generated.

    can_send_after?: number

    Time in seconds after which a message can be sent via answerWebAppQuery.

    chat?: {
        id: number;
        photo_url?: string;
        title: string;
        type: string;
        username?: string;
        [key: string]: unknown;
    }

    Information about the chat from which the Web App was opened.

    chat_instance?: string

    Global identifier for the chat instance.

    chat_type?: string

    Type of the chat from which the Web App was opened.

    hash: string

    Signature hash for data integrity verification.

    query_id?: string

    Unique identifier for the Web App session.

    raw: Record<string, string>

    Raw key-value string dictionary from URLSearchParams.

    receiver?: {
        first_name: string;
        id: number;
        is_bot?: boolean;
        last_name?: string;
        username?: string;
        [key: string]: unknown;
    }

    Information about the user or bot who opened the Web App in direct chat.

    start_param?: string

    Start parameter passed in the deep link.

    user?: {
        allows_write_to_pm?: boolean;
        first_name: string;
        id: number;
        is_bot?: boolean;
        is_premium?: boolean;
        language_code?: string;
        last_name?: string;
        photo_url?: string;
        username?: string;
        [key: string]: unknown;
    }

    Information about the current user.

    Settings
    Member Visibility

    On This Page
    Properties