Skip to main content
Module

x/grammy_types/manage.ts

Types for the Telegram Bot API
Very Popular
Go to Latest
File
import type { Location, Message, PhotoSize } from "./message.ts";import type { Update } from "./update.ts";
/** Describes the current status of a webhook. */export 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: Array<Exclude<keyof Update, "update_id">>;}
/** This object represents a Telegram user or bot. */export 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; /** IETF language tag 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;}
/** This object represents a Telegram user or bot that was returned by `getMe`. */export interface UserFromGetMe extends User { is_bot: true; username: string; /** True, if the bot can be invited to groups. Returned only in getMe. */ can_join_groups: boolean; /** True, if privacy mode is disabled for the bot. Returned only in getMe. */ can_read_all_group_messages: boolean; /** True, if the bot supports inline queries. Returned only in getMe. */ supports_inline_queries: boolean;}
export namespace Chat { // ABSTRACT /** Internal type holding properties that all kinds of chats share. */ interface AbstractChat { /** 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; }
// HELPERS /** Internal type holding properties that those chats with user names share. */ interface UserNameChat { /** Username, for private chats, supergroups and channels if available */ username?: string; } /** Internal type holding properties that those chats with titles share. */ interface TitleChat { /** Title, for supergroups, channels and group chats */ title: string; }
// ==> CHATS /** Internal type representing private chats. */ export interface PrivateChat extends AbstractChat, UserNameChat { type: "private"; /** 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; } /** Internal type representing group chats. */ export interface GroupChat extends AbstractChat, TitleChat { type: "group"; } /** Internal type representing super group chats. */ export interface SupergroupChat extends AbstractChat, UserNameChat, TitleChat { type: "supergroup"; /** True, if the supergroup chat is a forum (has topics enabled) */ is_forum?: true; } /** Internal type representing channel chats. */ export interface ChannelChat extends AbstractChat, UserNameChat, TitleChat { type: "channel"; }
// GET CHAT HELPERS /** Internal type holding properties that those chats returned from `getChat` share. */ interface GetChat { /** Chat photo. Returned only in getChat. */ photo?: ChatPhoto; /** The most recent pinned message (by sending date). Returned only in getChat. */ pinned_message?: Message; /** The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat. */ message_auto_delete_time?: number; /** True, if messages from the chat can't be forwarded to other chats. Returned only in getChat. */ has_protected_content?: true; } /** Internal type holding properties that those private, supergroup, and channel chats returned from `getChat` share. */ interface NonGroupGetChat extends GetChat { /** If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat. */ active_usernames?: string[]; } /** Internal type holding properties that those group, supergroup, and channel chats returned from `getChat` share. */ interface NonPrivateGetChat extends GetChat { /** Description, for groups, supergroups and channel chats. Returned only in getChat. */ description?: string; /** Primary invite link, for groups, supergroups and channel chats. Returned only in getChat. */ invite_link?: string; } /** Internal type holding properties that those group and supergroup chats returned from `getChat` share. */ interface MultiUserGetChat extends NonPrivateGetChat { /** Default chat member permissions, for groups and supergroups. Returned only in getChat. */ permissions?: ChatPermissions; /** True, if the bot can change the group sticker set. Returned only in getChat. */ can_set_sticker_set?: true; } /** Internal type holding properties that those supergroup and channel chats returned from `getChat` share. */ interface LargeGetChat extends NonPrivateGetChat { /** 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 getChat. */ linked_chat_id?: number; }
// ==> GET CHATS /** Internal type representing private chats returned from `getChat`. */ export interface PrivateGetChat extends PrivateChat, NonGroupGetChat, GetChat { /** Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat. */ emoji_status_custom_emoji_id?: string; /** Bio of the other party in a private chat. Returned only in 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 getChat. */ has_private_forwards?: true; /** True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat. */ has_restricted_voice_and_video_messages?: true; } /** Internal type representing group chats returned from `getChat`. */ export interface GroupGetChat extends GroupChat, MultiUserGetChat {} /** Internal type representing supergroup chats returned from `getChat`. */ export interface SupergroupGetChat extends SupergroupChat, NonGroupGetChat, MultiUserGetChat, LargeGetChat { /** For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat. */ slow_mode_delay?: number; /** True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat. */ has_aggressive_anti_spam_enabled?: true; /** For supergroups, name of group sticker set. Returned only in getChat. */ sticker_set_name?: string; /** For supergroups, the location to which the supergroup is connected. Returned only in getChat. */ location?: ChatLocation; /** True, if users need to join the supergroup before they can send messages. Returned only in getChat. */ join_to_send_messages?: true; /** True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat. */ join_by_request?: true; } /** Internal type representing channel chats returned from `getChat`. */ export interface ChannelGetChat extends ChannelChat, NonGroupGetChat, LargeGetChat {}}
/** This object represents a chat. */export type Chat = | Chat.PrivateChat | Chat.GroupChat | Chat.SupergroupChat | Chat.ChannelChat;
/** This object represents a Telegram user or bot that was returned by `getChat`. */export type ChatFromGetChat = | Chat.PrivateGetChat | Chat.GroupGetChat | Chat.SupergroupGetChat | Chat.ChannelGetChat;
/** This object represent a user's profile pictures. */export 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 chat photo. */export 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. */export 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. */export 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 they have 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; /** True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only */ can_manage_topics?: boolean;}
/** This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:- ChatMemberOwner- ChatMemberAdministrator- ChatMemberMember- ChatMemberRestricted- ChatMemberLeft- ChatMemberBanned */export type ChatMember = | ChatMemberOwner | ChatMemberAdministrator | ChatMemberMember | ChatMemberRestricted | ChatMemberLeft | ChatMemberBanned;
/** Represents a chat member that owns the chat and has all administrator privileges. */export interface ChatMemberOwner { /** The member's status in the chat, always “creator” */ status: "creator"; /** 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 chat member that has some additional privileges. */export interface ChatMemberAdministrator { /** The member's status in the chat, always “administrator” */ status: "administrator"; /** 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 they have 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; /** True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only */ can_manage_topics?: boolean; /** Custom title for this user */ custom_title?: string;}
/** Represents a chat member that has no additional privileges or restrictions. */export interface ChatMemberMember { /** The member's status in the chat, always “member” */ status: "member"; /** Information about the user */ user: User;}
/** Represents a chat member that is under certain restrictions in the chat. Supergroups only. */export interface ChatMemberRestricted { /** The member's status in the chat, always “restricted” */ status: "restricted"; /** Information about the user */ user: User; /** True, if the user is a member of the chat at the moment of the request */ is_member: boolean; /** True, if the user is allowed to send text messages, contacts, invoices, locations and venues */ can_send_messages: boolean; /** True, if the user is allowed to send audios */ can_send_audios: boolean; /** True, if the user is allowed to send documents */ can_send_documents: boolean; /** True, if the user is allowed to send photos */ can_send_photos: boolean; /** True, if the user is allowed to send videos */ can_send_videos: boolean; /** True, if the user is allowed to send video notes */ can_send_video_notes: boolean; /** True, if the user is allowed to send voice notes */ can_send_voice_notes: boolean; /** True, if the user is allowed to send polls */ can_send_polls: boolean; /** True, if the user is allowed to send animations, games, stickers and use inline bots */ can_send_other_messages: boolean; /** True, if the user is allowed to add web page previews to their messages */ can_add_web_page_previews: 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 user is allowed to pin messages */ can_pin_messages: boolean; /** True, if the user is allowed to create forum topics */ can_manage_topics: boolean; /** Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever */ until_date: number;}
/** Represents a chat member that isn't currently a member of the chat, but may join it themselves. */export interface ChatMemberLeft { /** The member's status in the chat, always “left” */ status: "left"; /** Information about the user */ user: User;}
/** Represents a chat member that was banned in the chat and can't return to the chat or view chat messages. */export interface ChatMemberBanned { /** The member's status in the chat, always “kicked” */ status: "kicked"; /** Information about the user */ user: User; /** Date when restrictions will be lifted for this user; unix time. If 0, then the user is banned forever */ until_date: number;}
/** This object represents changes in the status of a chat member. */export interface ChatMemberUpdated { /** Chat the user belongs to */ chat: Chat; /** Performer of the action, which resulted in the change */ from: User; /** Date the change was done in Unix time */ date: number; /** Previous information about the chat member */ old_chat_member: ChatMember; /** New information about the chat member */ new_chat_member: ChatMember; /** Chat invite link, which was used by the user to join the chat; for joining by invite link events only. */ invite_link?: ChatInviteLink;}
/** Represents a join request sent to a chat. */export interface ChatJoinRequest { /** Chat to which the request was sent */ chat: Chat.SupergroupChat | Chat.ChannelChat; /** User that sent the join request */ from: User; /** Identifier of a private chat with the user who sent the join request. 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. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user. */ user_chat_id: number; /** Date the request was sent in Unix time */ date: number; /** Bio of the user. */ bio?: string; /** Chat invite link that was used by the user to send the join request */ invite_link?: ChatInviteLink;}
/** Describes actions that a non-administrator user is allowed to take in a chat. */export interface ChatPermissions { /** True, if the user is allowed to send text messages, contacts, invoices, locations and venues */ can_send_messages?: boolean; /** True, if the user is allowed to send audios */ can_send_audios?: boolean; /** True, if the user is allowed to send documents */ can_send_documents?: boolean; /** True, if the user is allowed to send photos */ can_send_photos?: boolean; /** True, if the user is allowed to send videos */ can_send_videos?: boolean; /** True, if the user is allowed to send video notes */ can_send_video_notes?: boolean; /** True, if the user is allowed to send voice notes */ can_send_voice_notes?: boolean; /** True, if the user is allowed to send polls */ can_send_polls?: boolean; /** True, if the user is allowed to send animations, games, stickers and use inline bots */ can_send_other_messages?: boolean; /** True, if the user is allowed to add web page previews to their messages */ can_add_web_page_previews?: boolean; /** True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups */ can_change_info?: boolean; /** True, if the user is allowed to invite new users to the chat */ can_invite_users?: boolean; /** True, if the user is allowed to pin messages. Ignored in public supergroups */ can_pin_messages?: boolean; /** True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages */ can_manage_topics?: boolean;}
/** Represents a location to which a chat is connected. */export interface ChatLocation { /** The location to which the supergroup is connected. Can't be a live location. */ location: Location; /** Location address; 1-64 characters, as defined by the chat owner */ address: string;}
/** This object represents a forum topic. */export interface ForumTopic { /** Unique identifier of the forum topic */ message_thread_id: number; /** Name of the topic */ name: string; /** Color of the topic icon in RGB format */ icon_color: number; /** Unique identifier of the custom emoji shown as the topic icon */ icon_custom_emoji_id?: string;}
/** This object represents a bot command. */export interface BotCommand { /** Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores. */ command: string; /** Description of the command; 1-256 characters. */ description: string;}
/** 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 getFile. */export 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 */ file_size?: number; /** File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. */ file_path?: string;}