teletypes
Version:
Half-machine parsed types for the Telegram Bot API
760 lines • 114 kB
TypeScript
/** This file was automatically generated by https://github.com/teletypes/js */
import { TelegramMethods as T } from './methods';
export namespace TelegramTypes {
/** This object represents a service message about a video chat started in the chat. Currently holds no information. */
type VideoChatStarted = any;
/** This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser. */
type InputFile = any;
/** A placeholder, currently holds no information. Use BotFather to set up your game. */
type CallbackGame = any;
/** This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported: */
type ChatMember = ChatMemberOwner | ChatMemberAdministrator | ChatMemberMember | ChatMemberRestricted | ChatMemberLeft | ChatMemberBanned;
/** This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: */
type BotCommandScope = BotCommandScopeDefault | BotCommandScopeAllPrivateChats | BotCommandScopeAllGroupChats | BotCommandScopeAllChatAdministrators | BotCommandScopeChat | BotCommandScopeChatAdministrators | BotCommandScopeChatMember;
/** This object describes the bot's menu button in a private chat. It should be one of */
type MenuButton = MenuButtonCommands | MenuButtonWebApp | MenuButtonDefault;
/** This object represents the content of a media message to be sent. It should be one of */
type InputMedia = InputMediaAnimation | InputMediaDocument | InputMediaAudio | InputMediaPhoto | InputMediaVideo;
/** This object represents one result of an inline query. Telegram clients currently support results of the following 20 types: */
type InlineQueryResult = InlineQueryResultCachedAudio | InlineQueryResultCachedDocument | InlineQueryResultCachedGif | InlineQueryResultCachedMpeg4Gif | InlineQueryResultCachedPhoto | InlineQueryResultCachedSticker | InlineQueryResultCachedVideo | InlineQueryResultCachedVoice | InlineQueryResultArticle | InlineQueryResultAudio | InlineQueryResultContact | InlineQueryResultGame | InlineQueryResultDocument | InlineQueryResultGif | InlineQueryResultLocation | InlineQueryResultMpeg4Gif | InlineQueryResultPhoto | InlineQueryResultVenue | InlineQueryResultVideo | InlineQueryResultVoice;
/** This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types: */
type InputMessageContent = InputTextMessageContent | InputLocationMessageContent | InputVenueMessageContent | InputContactMessageContent | InputInvoiceMessageContent;
/** This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of: */
type PassportElementError = PassportElementErrorDataField | PassportElementErrorFrontSide | PassportElementErrorReverseSide | PassportElementErrorSelfie | PassportElementErrorFile | PassportElementErrorFiles | PassportElementErrorTranslationFile | PassportElementErrorTranslationFiles | PassportElementErrorUnspecified;
/** This object represents an incoming update.At most one of the optional parameters can be present in any given update. */
interface Update {
/** The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using {@link T.setWebhook|webhooks}, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. */
update_id: number,
/** New incoming message of any kind - text, photo, sticker, etc. */
message?: Message,
/** New version of a message that is known to the bot and was edited */
edited_message?: Message,
/** New incoming channel post of any kind - text, photo, sticker, etc. */
channel_post?: Message,
/** New version of a channel post that is known to the bot and was edited */
edited_channel_post?: Message,
/** New incoming query */
inline_query?: InlineQuery,
/** The result of an query that was chosen by a user and sent to their chat partner. Please see our documentation on the for details on how to enable these updates for your bot. */
chosen_inline_result?: ChosenInlineResult,
/** New incoming callback query */
callback_query?: CallbackQuery,
/** New incoming shipping query. Only for invoices with flexible price */
shipping_query?: ShippingQuery,
/** New incoming pre-checkout query. Contains full information about checkout */
pre_checkout_query?: PreCheckoutQuery,
/** New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot */
poll?: Poll,
/** A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself. */
poll_answer?: PollAnswer,
/** The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user. */
my_chat_member?: ChatMemberUpdated,
/** A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates. */
chat_member?: ChatMemberUpdated,
/** A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates. */
chat_join_request?: ChatJoinRequest
}
/** Describes the current status of a webhook. */
interface WebhookInfo {
/** Webhook URL, may be empty if webhook is not set up */
url: string,
/** True, if a custom certificate was provided for webhook certificate checks */
has_custom_certificate: boolean,
/** Number of updates awaiting delivery */
pending_update_count: number,
/** Currently used webhook IP address */
ip_address?: string,
/** Unix time for the most recent error that happened when trying to deliver an update via webhook */
last_error_date?: number,
/** Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook */
last_error_message?: string,
/** Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters */
last_synchronization_error_date?: number,
/** The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery */
max_connections?: number,
/** A list of update types the bot is subscribed to. Defaults to all update types except chat_member */
allowed_updates?: string
}
/** This object represents a Telegram user or bot. */
interface User {
/** Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. */
id: number,
/** True, if this user is a bot */
is_bot: boolean,
/** User's or bot's first name */
first_name: string,
/** User's or bot's last name */
last_name?: string,
/** User's or bot's username */
username?: string,
/** of the user's language */
language_code?: string,
/** True, if this user is a Telegram Premium user */
is_premium?: true,
/** True, if this user added the bot to the attachment menu */
added_to_attachment_menu?: true,
/** True, if the bot can be invited to groups. Returned only in {@link T.getMe|getMe}. */
can_join_groups?: boolean,
/** True, if is disabled for the bot. Returned only in {@link T.getMe|getMe}. */
can_read_all_group_messages?: boolean,
/** True, if the bot supports inline queries. Returned only in {@link T.getMe|getMe}. */
supports_inline_queries?: boolean
}
/** This object represents a chat. */
interface Chat {
/** Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. */
id: number,
/** Type of chat, can be either “private”, “group”, “supergroup” or “channel” */
type: string,
/** Title, for supergroups, channels and group chats */
title?: string,
/** Username, for private chats, supergroups and channels if available */
username?: string,
/** First name of the other party in a private chat */
first_name?: string,
/** Last name of the other party in a private chat */
last_name?: string,
/** Chat photo. Returned only in {@link T.getChat|getChat}. */
photo?: ChatPhoto,
/** Bio of the other party in a private chat. Returned only in {@link T.getChat|getChat}. */
bio?: string,
/** True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in {@link T.getChat|getChat}. */
has_private_forwards?: true,
/** True, if users need to join the supergroup before they can send messages. Returned only in {@link T.getChat|getChat}. */
join_to_send_messages?: true,
/** True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in {@link T.getChat|getChat}. */
join_by_request?: true,
/** Description, for groups, supergroups and channel chats. Returned only in {@link T.getChat|getChat}. */
description?: string,
/** Primary invite link, for groups, supergroups and channel chats. Returned only in {@link T.getChat|getChat}. */
invite_link?: string,
/** The most recent pinned message (by sending date). Returned only in {@link T.getChat|getChat}. */
pinned_message?: Message,
/** Default chat member permissions, for groups and supergroups. Returned only in {@link T.getChat|getChat}. */
permissions?: ChatPermissions,
/** For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in {@link T.getChat|getChat}. */
slow_mode_delay?: number,
/** The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in {@link T.getChat|getChat}. */
message_auto_delete_time?: number,
/** True, if messages from the chat can't be forwarded to other chats. Returned only in {@link T.getChat|getChat}. */
has_protected_content?: true,
/** For supergroups, name of group sticker set. Returned only in {@link T.getChat|getChat}. */
sticker_set_name?: string,
/** True, if the bot can change the group sticker set. Returned only in {@link T.getChat|getChat}. */
can_set_sticker_set?: true,
/** Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in {@link T.getChat|getChat}. */
linked_chat_id?: number,
/** For supergroups, the location to which the supergroup is connected. Returned only in {@link T.getChat|getChat}. */
location?: ChatLocation
}
/** This object represents a message. */
interface Message {
/** Unique message identifier inside this chat */
message_id: number,
/** Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
from?: User,
/** Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat. */
sender_chat?: Chat,
/** Date the message was sent in Unix time */
date: number,
/** Conversation the message belongs to */
chat: Chat,
/** For forwarded messages, sender of the original message */
forward_from?: User,
/** For messages forwarded from channels or from anonymous administrators, information about the original sender chat */
forward_from_chat?: Chat,
/** For messages forwarded from channels, identifier of the original message in the channel */
forward_from_message_id?: number,
/** For forwarded messages that were originally sent in channels or by an anonymous chat administrator, signature of the message sender if present */
forward_signature?: string,
/** Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages */
forward_sender_name?: string,
/** For forwarded messages, date the original message was sent in Unix time */
forward_date?: number,
/** True, if the message is a channel post that was automatically forwarded to the connected discussion group */
is_automatic_forward?: true,
/** For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply. */
reply_to_message?: Message,
/** Bot through which the message was sent */
via_bot?: User,
/** Date the message was last edited in Unix time */
edit_date?: number,
/** True, if the message can't be forwarded */
has_protected_content?: true,
/** The unique identifier of a media message group this message belongs to */
media_group_id?: string,
/** Signature of the post author for messages in channels, or the custom title of an anonymous group administrator */
author_signature?: string,
/** For text messages, the actual UTF-8 text of the message */
text?: string,
/** For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text */
entities?: MessageEntity,
/** Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set */
animation?: Animation,
/** Message is an audio file, information about the file */
audio?: Audio,
/** Message is a general file, information about the file */
document?: Document,
/** Message is a photo, available sizes of the photo */
photo?: PhotoSize,
/** Message is a sticker, information about the sticker */
sticker?: Sticker,
/** Message is a video, information about the video */
video?: Video,
/** Message is a , information about the video message */
video_note?: VideoNote,
/** Message is a voice message, information about the file */
voice?: Voice,
/** Caption for the animation, audio, document, photo, video or voice */
caption?: string,
/** For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption */
caption_entities?: MessageEntity,
/** Message is a shared contact, information about the contact */
contact?: Contact,
/** Message is a dice with random value */
dice?: Dice,
/** Message is a game, information about the game. */
game?: Game,
/** Message is a native poll, information about the poll */
poll?: Poll,
/** Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set */
venue?: Venue,
/** Message is a shared location, information about the location */
location?: Location,
/** New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) */
new_chat_members?: User,
/** A member was removed from the group, information about them (this member may be the bot itself) */
left_chat_member?: User,
/** A chat title was changed to this value */
new_chat_title?: string,
/** A chat photo was change to this value */
new_chat_photo?: PhotoSize,
/** Service message: the chat photo was deleted */
delete_chat_photo?: true,
/** Service message: the group has been created */
group_chat_created?: true,
/** Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup. */
supergroup_chat_created?: true,
/** Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel. */
channel_chat_created?: true,
/** Service message: auto-delete timer settings changed in the chat */
message_auto_delete_timer_changed?: MessageAutoDeleteTimerChanged,
/** The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. */
migrate_to_chat_id?: number,
/** The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. */
migrate_from_chat_id?: number,
/** Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply. */
pinned_message?: Message,
/** Message is an invoice for a , information about the invoice. */
invoice?: Invoice,
/** Message is a service message about a successful payment, information about the payment. */
successful_payment?: SuccessfulPayment,
/** The domain name of the website on which the user has logged in. */
connected_website?: string,
/** Telegram Passport data */
passport_data?: PassportData,
/** Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. */
proximity_alert_triggered?: ProximityAlertTriggered,
/** Service message: video chat scheduled */
video_chat_scheduled?: VideoChatScheduled,
/** Service message: video chat started */
video_chat_started?: VideoChatStarted,
/** Service message: video chat ended */
video_chat_ended?: VideoChatEnded,
/** Service message: new participants invited to a video chat */
video_chat_participants_invited?: VideoChatParticipantsInvited,
/** Service message: data sent by a Web App */
web_app_data?: WebAppData,
/** Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. */
reply_markup?: InlineKeyboardMarkup
}
/** This object represents a unique message identifier. */
interface MessageId {
/** Unique message identifier */
message_id: number
}
/** This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. */
interface MessageEntity {
/** Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users ) */
type: string,
/** Offset in UTF-16 code units to the start of the entity */
offset: number,
/** Length of the entity in UTF-16 code units */
length: number,
/** For “text_link” only, URL that will be opened after user taps on the text */
url?: string,
/** For “text_mention” only, the mentioned user */
user?: User,
/** For “pre” only, the programming language of the entity text */
language?: string
}
/** This object represents one size of a photo or a {@link Document|file} / {@link Sticker|sticker} thumbnail. */
interface PhotoSize {
/** Identifier for this file, which can be used to download or reuse the file */
file_id: string,
/** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
file_unique_id: string,
/** Photo width */
width: number,
/** Photo height */
height: number,
/** File size in bytes */
file_size?: number
}
/** This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). */
interface Animation {
/** Identifier for this file, which can be used to download or reuse the file */
file_id: string,
/** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
file_unique_id: string,
/** Video width as defined by sender */
width: number,
/** Video height as defined by sender */
height: number,
/** Duration of the video in seconds as defined by sender */
duration: number,
/** Animation thumbnail as defined by sender */
thumb?: PhotoSize,
/** Original animation filename as defined by sender */
file_name?: string,
/** MIME type of the file as defined by sender */
mime_type?: string,
/** File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. */
file_size?: number
}
/** This object represents an audio file to be treated as music by the Telegram clients. */
interface Audio {
/** Identifier for this file, which can be used to download or reuse the file */
file_id: string,
/** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
file_unique_id: string,
/** Duration of the audio in seconds as defined by sender */
duration: number,
/** Performer of the audio as defined by sender or by audio tags */
performer?: string,
/** Title of the audio as defined by sender or by audio tags */
title?: string,
/** Original filename as defined by sender */
file_name?: string,
/** MIME type of the file as defined by sender */
mime_type?: string,
/** File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. */
file_size?: number,
/** Thumbnail of the album cover to which the music file belongs */
thumb?: PhotoSize
}
/** This object represents a general file (as opposed to {@link PhotoSize|photos}, {@link Voice|voice} messages and {@link Audio|audio} files). */
interface Document {
/** Identifier for this file, which can be used to download or reuse the file */
file_id: string,
/** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
file_unique_id: string,
/** Document thumbnail as defined by sender */
thumb?: PhotoSize,
/** Original filename as defined by sender */
file_name?: string,
/** MIME type of the file as defined by sender */
mime_type?: string,
/** File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. */
file_size?: number
}
/** This object represents a video file. */
interface Video {
/** Identifier for this file, which can be used to download or reuse the file */
file_id: string,
/** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
file_unique_id: string,
/** Video width as defined by sender */
width: number,
/** Video height as defined by sender */
height: number,
/** Duration of the video in seconds as defined by sender */
duration: number,
/** Video thumbnail */
thumb?: PhotoSize,
/** Original filename as defined by sender */
file_name?: string,
/** MIME type of the file as defined by sender */
mime_type?: string,
/** File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. */
file_size?: number
}
/** This object represents a video message (available in Telegram apps as of v.4.0). */
interface VideoNote {
/** Identifier for this file, which can be used to download or reuse the file */
file_id: string,
/** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
file_unique_id: string,
/** Video width and height (diameter of the video message) as defined by sender */
length: number,
/** Duration of the video in seconds as defined by sender */
duration: number,
/** Video thumbnail */
thumb?: PhotoSize,
/** File size in bytes */
file_size?: number
}
/** This object represents a voice note. */
interface Voice {
/** Identifier for this file, which can be used to download or reuse the file */
file_id: string,
/** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
file_unique_id: string,
/** Duration of the audio in seconds as defined by sender */
duration: number,
/** MIME type of the file as defined by sender */
mime_type?: string,
/** File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. */
file_size?: number
}
/** This object represents a phone contact. */
interface Contact {
/** Contact's phone number */
phone_number: string,
/** Contact's first name */
first_name: string,
/** Contact's last name */
last_name?: string,
/** Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. */
user_id?: number,
/** Additional data about the contact in the form of a */
vcard?: string
}
/** This object represents an animated emoji that displays a random value. */
interface Dice {
/** Emoji on which the dice throw animation is based */
emoji: string,
/** Value of the dice, 1-6 for “”, “” and “” base emoji, 1-5 for “” and “” base emoji, 1-64 for “” base emoji */
value: number
}
/** This object contains information about one answer option in a poll. */
interface PollOption {
/** Option text, 1-100 characters */
text: string,
/** Number of users that voted for this option */
voter_count: number
}
/** This object represents an answer of a user in a non-anonymous poll. */
interface PollAnswer {
/** Unique poll identifier */
poll_id: string,
/** The user, who changed the answer to the poll */
user: User,
/** 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote. */
option_ids: number
}
/** This object contains information about a poll. */
interface Poll {
/** Unique poll identifier */
id: string,
/** Poll question, 1-300 characters */
question: string,
/** List of poll options */
options: PollOption,
/** Total number of users that voted in the poll */
total_voter_count: number,
/** True, if the poll is closed */
is_closed: boolean,
/** True, if the poll is anonymous */
is_anonymous: boolean,
/** Poll type, currently can be “regular” or “quiz” */
type: string,
/** True, if the poll allows multiple answers */
allows_multiple_answers: boolean,
/** 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot. */
correct_option_id?: number,
/** Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters */
explanation?: string,
/** Special entities like usernames, URLs, bot commands, etc. that appear in the explanation */
explanation_entities?: MessageEntity,
/** Amount of time in seconds the poll will be active after creation */
open_period?: number,
/** Point in time (Unix timestamp) when the poll will be automatically closed */
close_date?: number
}
/** This object represents a point on the map. */
interface Location {
/** Longitude as defined by sender */
longitude: number,
/** Latitude as defined by sender */
latitude: number,
/** The radius of uncertainty for the location, measured in meters; 0-1500 */
horizontal_accuracy?: number,
/** Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only. */
live_period?: number,
/** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
heading?: number,
/** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
proximity_alert_radius?: number
}
/** This object represents a venue. */
interface Venue {
/** Venue location. Can't be a live location */
location: Location,
/** Name of the venue */
title: string,
/** Address of the venue */
address: string,
/** Foursquare identifier of the venue */
foursquare_id?: string,
/** Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) */
foursquare_type?: string,
/** Google Places identifier of the venue */
google_place_id?: string,
/** Google Places type of the venue. (See .) */
google_place_type?: string
}
/** Describes data sent from a Web App to the bot. */
interface WebAppData {
/** The data. Be aware that a bad client can send arbitrary data in this field. */
data: string,
/** Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field. */
button_text: string
}
/** This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user. */
interface ProximityAlertTriggered {
/** User that triggered the alert */
traveler: User,
/** User that set the alert */
watcher: User,
/** The distance between the users */
distance: number
}
/** This object represents a service message about a change in auto-delete timer settings. */
interface MessageAutoDeleteTimerChanged {
/** New auto-delete time for messages in the chat; in seconds */
message_auto_delete_time: number
}
/** This object represents a service message about a video chat scheduled in the chat. */
interface VideoChatScheduled {
/** Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator */
start_date: number
}
/** This object represents a service message about a video chat ended in the chat. */
interface VideoChatEnded {
/** Video chat duration in seconds */
duration: number
}
/** This object represents a service message about new members invited to a video chat. */
interface VideoChatParticipantsInvited {
/** New members that were invited to the video chat */
users: User
}
/** This object represent a user's profile pictures. */
interface UserProfilePhotos {
/** Total number of profile pictures the target user has */
total_count: number,
/** Requested profile pictures (in up to 4 sizes each) */
photos: PhotoSize
}
/** This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling {@link T.getFile|getFile}.
The maximum file size to download is 20 MB
*/
interface File {
/** Identifier for this file, which can be used to download or reuse the file */
file_id: string,
/** Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
file_unique_id: string,
/** File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. */
file_size?: number,
/** File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. */
file_path?: string
}
/** Describes a Web App. */
interface WebAppInfo {
/** An HTTPS URL of a Web App to be opened with additional data as specified in */
url: string
}
/** This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). */
interface ReplyKeyboardMarkup {
/** Array of button rows, each represented by an Array of {@link KeyboardButton|KeyboardButton} objects */
keyboard: KeyboardButton,
/** Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard. */
resize_keyboard?: boolean,
/** Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false. */
one_time_keyboard?: boolean,
/** The placeholder to be shown in the input field when the keyboard is active; 1-64 characters */
input_field_placeholder?: string,
/** Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the {@link Message|Message} object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard. */
selective?: boolean
}
/** This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive. */
interface KeyboardButton {
/** Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed */
text: string,
/** If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. */
request_contact?: boolean,
/** If True, the user's current location will be sent when the button is pressed. Available in private chats only. */
request_location?: boolean,
/** If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only. */
request_poll?: KeyboardButtonPollType,
/** If specified, the described will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only. */
web_app?: WebAppInfo
}
/** This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. */
interface KeyboardButtonPollType {
/** If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type. */
type?: string
}
/** Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see {@link ReplyKeyboardMarkup|ReplyKeyboardMarkup}). */
interface ReplyKeyboardRemove {
/** Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in {@link ReplyKeyboardMarkup|ReplyKeyboardMarkup}) */
remove_keyboard: true,
/** Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the {@link Message|Message} object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. */
selective?: boolean
}
/** This object represents an inline keyboard that appears right next to the message it belongs to. */
interface InlineKeyboardMarkup {
/** Array of button rows, each represented by an Array of {@link InlineKeyboardButton|InlineKeyboardButton} objects */
inline_keyboard: InlineKeyboardButton
}
/** This object represents one button of an inline keyboard. You must use exactly one of the optional fields. */
interface InlineKeyboardButton {
/** Label text on the button */
text: string,
/** HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings. */
url?: string,
/** Data to be sent in a {@link CallbackQuery|callback} to the bot when button is pressed, 1-64 bytes */
callback_data?: string,
/** Description of the that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method {@link T.answerWebAppQuery|answerWebAppQuery}. Available only in private chats between a user and the bot. */
web_app?: WebAppInfo,
/** An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the . */
login_url?: LoginUrl,
/** If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.Note: This offers an easy way for users to start using your bot in when they are currently in a private chat with it. Especially useful when combined with {@link T.answerInlineQuery|switch_pm} actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen. */
switch_inline_query?: string,
/** If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. */
switch_inline_query_current_chat?: string,
/** Description of the game that will be launched when the user presses the button.NOTE: This type of button must always be the first button in the first row. */
callback_game?: CallbackGame,
/** Specify True, to send a .NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages. */
pay?: boolean
}
/** 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.
Sample bot: @discussbot
*/
interface LoginUrl {
/** 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 .NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in . */
url: string,
/** New text of the button in forwarded messages. */
forward_text?: string,
/** Username of a bot, which will be used for user authorization. See 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 for more details. */
bot_username?: string,
/** Pass True to request the permission for your bot to send messages to the user. */
request_write_access?: boolean
}
/** This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present. */
interface CallbackQuery {
/** Unique identifier for this query */
id: string,
/** Sender */
from: User,
/** Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old */
message?: Message,
/** Identifier of the message sent via the bot in inline mode, that originated the query. */
inline_message_id?: string,
/** Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in . */
chat_instance: string,
/** Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data. */
data?: string,
/** Short name of a to be returned, serves as the unique identifier for the game */
game_short_name?: string
}
/** Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. */
interface ForceReply {
/** Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply' */
force_reply: true,
/** The placeholder to be shown in the input field when the reply is active; 1-64 characters */
input_field_placeholder?: string,
/** Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the {@link Message|Message} object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. */
selective?: boolean
}
/** This object represents a chat photo. */
interface ChatPhoto {
/** File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. */
small_file_id: string,
/** Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
small_file_unique_id: string,
/** File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. */
big_file_id: string,
/** Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. */
big_file_unique_id: string
}
/** Represents an invite link for a chat. */
interface ChatInviteLink {
/** The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”. */
invite_link: string,
/** Creator of the link */
creator: User,
/** True, if users joining the chat via the link need to be approved by chat administrators */
creates_join_request: boolean,
/** True, if the link is primary */
is_primary: boolean,
/** True, if the link is revoked */
is_revoked: boolean,
/** Invite link name */
name?: string,
/** Point in time (Unix timestamp) when the link will expire or has been expired */
expire_date?: number,
/** The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
member_limit?: number,
/** Number of pending join requests created using this link */
pending_join_request_count?: number
}
/** Represents the rights of an administrator in a chat. */
interface ChatAdministratorRights {
/** True, if the user's presence in the chat is hidden */
is_anonymous: boolean,
/** True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege */
can_manage_chat: boolean,
/** True, if the administrator can delete messages of other users */
can_delete_messages: boolean,
/** True, if the administrator can manage video chats */
can_manage_video_chats: boolean,
/** True, if the administrator can restrict, ban or unban chat members */
can_restrict_members: boolean,
/** True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) */
can_promote_members: boolean,
/** True, if the user is allowed to change the chat title, photo and other settings */
can_change_info: boolean,
/** True, if the user is allowed to invite new users to the chat */
can_invite_users: boolean,
/** True, if the administrator can post in the channel; channels only */
can_post_messages?: boolean,
/** True, if the administrator can edit messages of other users and can pin messages; channels only */
can_edit_messages?: boolean,
/** True, if the user is allowed to pin messages; groups and supergroups only */
can_pin_messages?: boolean
}
/** Represents a {@link ChatMember|chat} member that owns the chat and has all administrator privileges. */
interface ChatMemberOwner {
/** The member's status in the chat, always “creator” */
status: string,
/** Information about the user */
user: User,
/** True, if the user's presence in the chat is hidden */
is_anonymous: boolean,
/** Custom title for this user */
custom_title?: string
}
/** Represents a {@link ChatMember|chat} member that has some additional privileges. */
interface ChatMemberAdministrator {
/** The member's status in the chat, always “administrator” */
status: string,
/** Information about the user */
user: User,
/** True, if the bot is allowed to edit administrator privileges of that user */
can_be_edited: boolean,
/** True, if the user's presence in the chat is hidden */
is_anonymous: boolean,
/** True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege */
can_manage_chat: boolean,
/** True, if the administrator can delete messages of other users */
can_delete_messages: boolean,
/** True, if the administrator can manage video chats */
can_manage_video_chats: boolean,
/** True, if the administrator can restrict, ban or unban chat members */
can_restrict_members: boolean,
/** True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) */
can_promote_members: boolean,
/** True, if the user is allowed to change the chat title, photo and other settings */
can_change_inf