Methods
Account
Add a bot to the attachments menu.
Add music to profile.
Add a saved notification sound.
Allow a bot to set custom emoji status.
Allow unpaid messages from a user.
Block a user.
Check the availability of a username.
Clear recent emoji statuses.
Delete the current account.
Disable sponsored messages on the current user.
Disallow a bot to set custom emoji status.
Disallow unpaid messages from a user.
Disconnect a connected website.
Disconnect all connected websites.
Enable sponsored messages on the current user.
Get the current account’s TTL.
Get application configuration.
Get app support.
Get app support name.
Get whether new chats from unknown users are archived and muted.
Get the authorization sessions.
Get blocked users.
Get a business connection.
Get connected websites.
Get countries.
Get the country code for the current user based on its IP address.
Get gift privacy setting.
Get information on the currently authorized user.
Get new chat privacy setting.
Get owned bots.
Get the user account password’s hint.
Get a privacy setting.
Get a user’s profile music.
Get the profile photos of a user.
Get read date privacy.
Get recent emoji statuses.
Get saved notification sounds.
Get timezones.
Hide a username from the current account, a bot account, a supergroup, or a channel’s profile.
Hide all usernames from a supergroup or a channel’s profile.
Pause the business bot in a chat.
Remove an authorization session.
Remove all authorization sessions except for the current one.
Remove a bot from the attachments menu.
Remove the current user’s business away message.
Remove the business greeting message.
Remove the business intro.
Remove the emoji status of a channel.
Remove the current account’s emoji status.
Remove music from profile.
Remove the profile video of the current user or a bot managed by the current user.
Remove a saved notification sound.
Remove the emoji status of a bot’s user.
Remove the current account’s username.
Reorder the usernames of the current account, a bot account, a supergroup, or a channel’s profile.
Reset notification settings.
Resolve a phone number.
Resolve a username.
Resume the business bot in a chat.
Send a custom request.
Set the current account’s TTL.
Set whether new chats from unknown users should be archived and muted.
Set the birthday of the current user.
Set the current user’s business away message.
Set the business greeting message.
Set the business intro.
Set the emoji status of a channel.
Set the list of close friends.
Set the default message TTL.
Set the current account’s emoji status.
Set gift privacy setting.
Set the current account’s online status.
Set the location of the current user.
Set the name color of the current user.
Set new chat privacy setting.
Set the personal channel of the current user.
Set a privacy setting.
Set the profile color of the current user.
Set read date privacy.
Set the emoji status of a bot’s user.
Set the username of the current account.
Set the working hours of the current user.
Show a username in the current account, a bot account, a supergroup, or a channel’s profile.
Suggest a birthday.
Unblock a user.
Update the profile of the current user. At least one parameter must be specified.
Update the profile photo of the current user or a bot managed by the current user.
Update the profile video of the current user or a bot managed by the current user.
Authorization
Check whether a bot token is valid.
Check if a code entered by the user was the same as the verification code.
Check whether a password entered by the user is the same as the account’s password.
Export the auth string for the current authorization session.
Import an auth string.
Send a user verification code.
Signs in using the provided parameters if not already signed in. If no parameters are provided, the credentials will be prompted in runtime.
Notes:
- Requires the
apiIdandapiHashparameters to be passed when constructing the client. - Reconnects the client to the appropriate DC in case of MIGRATE_X errors.
Sign out.
Sign up.
Bots
Delete the bot’s commands in the given scope and/or language.
Get the bot’s commands in the given scope and/or language.
Get the bot’s description in the given language.
Get the bot’s name in the given language.
Get the bot’s short description in the given language.
Set the bot’s commands in the given scope and/or language.
Set the bot’s description in the given language.
Set the bot’s name in the given language.
Set the bot’s short description in the given language.
Callback Queries
Chats
Add a single user to a chat.
Add multiple users at once to a channel or a supergroup.
Approve a join request.
Approve all join requests.
Archive a single chat.
Archive multiple chats.
Ban a member from a chat.
Add a single user to a chat.
Close a chat previously opened by openChat.
Close a forum topic.
Create a channel.
Create a group.
Create an invite link.
Create a supergroup.
Create a forum topic.
Decline a join request.
Decline all join requests.
Delete a chat.
Delete a chat’s photo.
Delete a chat’s sticker set.
Delete revoked invite links.
Delete a forum topic.
Disable automatic anti-spam in a group.
Disable business bots in a private chat.
Disable chat history for new members.
Disable join requests in a chat.
Disable sharing in a chat.
Disable post signatures in a channel.
Disable slow mode in a group.
Disable topics in a group.
Edit a forum topic.
Enable automatic anti-spam in a group.
Enable business bots in a private chat.
Enable chat history for new members.
Enable join requests in a chat.
Enable sharing in a chat.
Enable post signatures in a channel.
Enable topics in a group.
Get administered chats.
Get a chat.
Get the administrators of a chat.
Get information on a user’s chat membership.
Get the members of a chat.
Get a partial chat.
Get chats from a chat list.
Get the settings of a chat.
Get common chats between a user and the current one.
Get the invite links created for a chat.
Get discussion chat suggestions.
Get chat history.
Get inactive chats.
Get pending join requests in a chat.
Get a chat’s notification settings.
Get the count of online members in a chat.
Get pinned chats from a chat list.
Get the recent actions of a channel or a supergroup.
Get recommended channels.
Get similar bots.
Get similar channels.
Get a topic of a forum chat by its identifier.
Get the topics of a forum chat.
Get topics of a forum chat by their identifiers.
Hide the general forum topic.
Hide the member list of a group to non-admins.
Join a chat.
Join a chat using an invite link.
Kick a member from a chat. Same as a banChatMember call followed by unbanChatMember.
Leave a chat.
Mark all mentions in a chat as read.
Mark a chat as read.
Mark a chat as unread.
Open a chat.
Pin a forum topic.
Promote a chat member.
Reopen a forum topic.
Report a chat.
Resolve an invite link.
Set a chat’s available reactions.
Set the number of boosts required to circumvent a chat’s default restrictions.
Change the description of a chat.
Set the rights of a chat member.
Change the tag of a chat member.
Set a chat’s photo.
Set a chat’s sticker set.
Change the title of a chat.
Set the default send as chat of a chat.
Set a channel’s discussion chat.
Set the time to live of the messages of a chat.
Set a chat’s notification settings.
Change slow mode in a group.
Show the general forum topic.
Show the member list of a group to non-admins.
Transfer the ownership of a chat.
Unarchive a single chat.
Unarchive multiple chats.
Unban a member from a chat.
Unpin a forum topic.
Checklists
Add items to a checklist.
Check a single item of a checklist.
Check multiple items of a checklist.
Uncheck a single item of a checklist.
Uncheck multiple items of a checklist.
Update a checklist.
Connection
Connect the client.
Disconnect the client.
Start the client. Same as calling {@link Client.connect} followed by {@link Client.signIn}.
Contacts
Add a contact.
Delete a single contact.
Delete multiple contacts.
Get contacts.
Set a contact note.
Files
Download a file.
Download a chunk of a file.
Get custom emoji documents for download.
Gift Collections
Add gifts to a gift collection.
Create a gift collection.
Delete a gift collection.
Get gift collections of a chat.
Remove gifts from a gift collection.
Reorder gift collections.
Reorder gifts in a gift collection.
Set the name of a gift collection.
Gifts
Craft gifts.
Get gifts claimed by a user or a channel.
Get a gift using its slug.
Get available gifts.
Gift a Telegram Premium subscription.
Sell a gift.
Send a gift.
Transfer a gift.
Guest Queries
Answer a guest query.
Inline Queries
Low Level
Get a channel or a supergroup’s inputChannel. Useful when calling API functions directly.
Get a chat’s inputPeer. Useful when calling API functions directly.
Get a user’s inputUser. Useful when calling API functions directly.
Invoke a low-level function.
Managed Bots
Get the access settings of a managed bot.
Get the token of a managed bot.
Revoke the token of a managed bot.
Set the access settings of a managed bot.
Messages
Add a sticker to favorites.
Add a sticker to recents.
Clear all message drafts.
Clear recent stickers.
Delete all messages sent by a specific member of a chat.
Delete a single message.
Delete multiple messages.
Delete a scheduled message.
Delete multiple scheduled messages.
Edit an inline message’s caption.
Edit an inline message’s live location.
Edit an inline message’s media.
Edit an inline message’s reply markup.
Edit an inline message’s rich text.
Edit an inline message’s text.
Edit a message’s caption.
Edit a message’s live location.
Edit a message’s media.
Edit a message’s reply markup.
Edit a message’s rich text.
Edit a message’s text.
Forward a single message.
Forward multiple messages.
Get favorite stickers.
Get the link preview for a message that is about to be sent.
Retrieve a single message.
Get the counters of a single message.
Get a list of reactions made to a message.
Get a message’s read date.
Retrieve multiple messages.
Get the counters of multiple messages.
Get a message’s viewers.
Get a progress ID that can be passed to relevant send* methods to receive upload progress updates for them.
Get recent stickers.
Get a message’s full rich text.
Get saved animations.
Get a list of saved chats.
Get messages saved from a specific chat.
Get the scheduled messages of a chat.
Open a mini app.
Pin a message in a chat.
Mark messages as read.
Remove a sticker from favorites.
Remove a sticker from recents.
Report a message reaction.
Retrieve a message using its link.
Save an animation.
Save a message draft.
Save a rich text message draft.
Search for messages.
Send an animation.
Send an audio file.
Send a chat action.
Send a checklist.
Send a contact.
Send a dice.
Send a document.
Send an invoice.
Send a live photo.
Send a location.
Send a media group.
Send a text message.
Stream a drafted text message.
Send a photo.
Send a poll.
Send a rich text message.
Stream a drafted rich text message.
Send a scheduled message before its schedule.
Send multiple scheduled messages before their schedule.
Send a screenshot notification.
Send a sticker.
Send a venue.
Send a video.
Send a video note.
Send a voice message.
Set a reaction as default.
Start a bot.
Stop a poll.
Summarize a message’s text.
Transcribe a voice message.
Translate a single text.
Translate multiple texts.
Translate a single text.
Translate multiple texts.
Unpin a pinned message.
Unpin all pinned messages.
Unsave an animation.
View a single message.
View multiple messages.
Network Statistics
Get network statistics. This might not always be available.
Payments
Answer a pre-checkout query.
Get the star balance of a chat.
Get star transactions.
Get the TON balance of a chat.
Get TON transactions.
Refund a star payment.
Polls
Add an option to a poll.
Get poll voters.
Remove an option from a poll.
Retract a vote.
Cast a vote.
Reactions
Make a reaction to a message.
Clear recent reactions.
Undo a reaction made to a message.
Undo a reaction by another user.
Undo recent reactions to messages made by another user.
Change reactions made to a message.
Secret Chats
Accept a secret chat.
End a secret chat.
Request a secret chat.
Send an animation to a secret chat.
Send an audio file to a secret chat.
Send a cancel typing action to a secret chat.
Send a contact to a secret chat.
Send a document to a secret chat.
Send a location to a secret chat.
Send a message to a secret chat.
Send a photo to a secret chat.
Send a secret chat screenshot notification.
Send a sticker to a secret chat.
Send a typing action to a secret chat.
Send a venue to a secret chat.
Send a video to a secret chat.
Send a video note to a secret chat.
Send a voice message to a secret chat.
Sticker Sets
Add a sticker set.
Add a sticker to a sticker set.
Archive a sticker set.
Change the position of a sticker in its set.
Check the availability of a sticker set slug.
Create a sticker set.
Delete a sticker set.
Get added sticker sets.
Get a dice sticker set.
Get a sticker set.
Remove a sticker from its set.
Remove a sticker set.
Replace a sticker’s emoji.
Replace a sticker in a sticker set.
Set a custom emoji as a sticker set’s thumbnail.
Set a sticker set’s thumbnail.
Set the title of a sticker set.
Suggest a sticker set slug from its title.
Unarchive a sticker set.
Stories
Add multiple stories to highlights.
Add a single story to highlights.
Create a story.
Delete multiple stories.
Delete a single story.
Edit a story.
Retrieve multiple stories.
Retrieve a single story.
Remove multiple stories from highlights.
Remove a single story from highlights.
Report multiple stories.
Report a single story.
Story Albums
Add multiple stories to an album.
Add a single story to an album.
Create a story album.
Delete a story album.
Get stories inside an album.
Get story albums in a chat.
Remove multiple stories from an album.
Remove a single story from an album.
Reorder stories in an album.
Reorder story albums.
Set the name of a story album.
Takeouts
End a takeout session.
Get left channels.
Start a takeout session.
Translations
Get translations.
Video Chats
Download a live stream segment.
Get live stream channels.
Get a video chat.
Join a live stream.
Join a video chat.
Leave a video chat.
Schedule a video chat.
Start a video chat.