Module

x/grammy/types.web.ts>LoginUrl

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Go to Latest
interface LoginUrl
import { type LoginUrl } from "https://dotland.deno.dev/x/grammy@v1.15.0/types.web.ts";

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in. Telegram apps support these buttons as of version 5.7.

Properties

url: string

An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.

NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.

optional
forward_text: string

New text of the button in forwarded messages.

optional
bot_username: string

Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.

optional
request_write_access: boolean

Pass True to request the permission for your bot to send messages to the user.