Interface OauthLinkInfo

Information about the OAuth authorization.

interface OauthLinkInfo {
    @type: "oauthLinkInfo";
    bot_user_id: number;
    browser: string;
    domain: string;
    from_app?: boolean;
    ip_address: string;
    location: string;
    match_code_first?: boolean;
    match_codes: string[];
    platform: string;
    request_phone_number_access?: boolean;
    request_write_access?: boolean;
    url: string;
    user_id: number;
    verified_app_name: string;
}

Properties

@type: "oauthLinkInfo"
bot_user_id: number

User identifier of a bot linked with the website.

browser: string

The version of a browser used for the authorization.

domain: string

A domain of the URL.

from_app?: boolean

True, if the authorization originates from an application.

ip_address: string

IP address from which the authorization is performed, in human-readable format.

location: string

Human-readable description of a country and a region from which the authorization is performed, based on the IP address.

match_code_first?: boolean

True, if code matching dialog must be shown first and checkOauthRequestMatchCode must be called before acceptOauthRequest. Otherwise, checkOauthRequestMatchCode must not be called.

match_codes: string[]

The list of codes to match; may be empty if irrelevant.

platform: string

Operating system the browser is running on.

request_phone_number_access?: boolean

True, if the user must be asked for the permission to share their phone number.

request_write_access?: boolean

True, if the user must be asked for the permission to the bot to send them messages.

url: string

An HTTP URL where the user authorizes.

user_id: number

Identifier of the user for which the link was generated; may be 0 if unknown. The corresponding user may be unknown. If the user is logged in the application, then they must be chosen for authorization by default.

verified_app_name: string

Verified name of the application; if empty, then "Unverified App" must be shown instead.