methods
the raw bot api methods available on tg.api.* (bot api 10.0).
addStickerToSet
Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier of sticker set owner |
name | string | ✓ | Sticker set name |
sticker | InputSticker | ✓ | A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed. |
returns: true
answerCallbackQuery
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
| parameter | type | required | description |
|---|---|---|---|
callback_query_id | string | ✓ | Unique identifier for the query to be answered |
text | string | Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters. | |
show_alert | boolean | If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. | |
url | string | URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. | |
cache_time | integer | The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0. |
returns: true
answerGuestQuery
Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned.
| parameter | type | required | description |
|---|---|---|---|
guest_query_id | string | ✓ | Unique identifier for the query to be answered |
result | InlineQueryResult | ✓ | A JSON-serialized object describing the message to be sent |
returns: SentGuestMessage
answerInlineQuery
Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed.
| parameter | type | required | description |
|---|---|---|---|
inline_query_id | string | ✓ | Unique identifier for the answered query |
results | InlineQueryResult[] | ✓ | A JSON-serialized array of results for the inline query |
cache_time | integer | The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. | |
is_personal | boolean | Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. | |
next_offset | string | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes. | |
button | InlineQueryResultsButton | A JSON-serialized object describing a button to be shown above inline query results |
returns: true
answerPreCheckoutQuery
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
| parameter | type | required | description |
|---|---|---|---|
pre_checkout_query_id | string | ✓ | Unique identifier for the query to be answered |
ok | boolean | ✓ | Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems. |
error_message | string | Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. |
returns: true
answerShippingQuery
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
| parameter | type | required | description |
|---|---|---|---|
shipping_query_id | string | ✓ | Unique identifier for the query to be answered |
ok | boolean | ✓ | Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) |
shipping_options | ShippingOption[] | Required if ok is True. A JSON-serialized array of available shipping options. | |
error_message | string | Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user. |
returns: true
answerWebAppQuery
Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
| parameter | type | required | description |
|---|---|---|---|
web_app_query_id | string | ✓ | Unique identifier for the query to be answered |
result | InlineQueryResult | ✓ | A JSON-serialized object describing the message to be sent |
returns: SentWebAppMessage
approveChatJoinRequest
Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
returns: true
approveSuggestedPost
Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | ✓ | Unique identifier for the target direct messages chat |
message_id | integer | ✓ | Identifier of a suggested post message to approve |
send_date | integer | Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future. |
returns: true
banChatMember
Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target group or username of the target supergroup or channel in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
until_date | integer | Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. | |
revoke_messages | boolean | Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels. |
returns: true
banChatSenderChat
Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
sender_chat_id | integer | ✓ | Unique identifier of the target sender chat |
returns: true
close
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
returns: true
closeForumTopic
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
message_thread_id | integer | ✓ | Unique identifier for the target message thread of the forum topic |
returns: true
closeGeneralForumTopic
Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
returns: true
convertGiftToStars
Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
owned_gift_id | string | ✓ | Unique identifier of the regular gift that should be converted to Telegram Stars |
returns: true
copyMessage
Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
from_chat_id | integer | string | ✓ | Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username) |
message_id | integer | ✓ | Message identifier in the chat specified in from_chat_id |
video_start_timestamp | integer | New start timestamp for the copied video in the message | |
caption | string | New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept. | |
parse_mode | string | Mode for parsing entities in the new caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified. | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; only available when copying to private chats | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: MessageId
copyMessages
Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat | |
from_chat_id | integer | string | ✓ | Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username) |
message_ids | integer[] | ✓ | A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order. |
disable_notification | boolean | Sends the messages silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent messages from forwarding and saving | |
remove_caption | boolean | Pass True to copy the messages without their captions |
returns: MessageId[]
createChatInviteLink
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
name | string | Invite link name; 0-32 characters | |
expire_date | integer | Point in time (Unix timestamp) when the link will expire | |
member_limit | integer | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | |
creates_join_request | boolean | True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified. |
returns: ChatInviteLink
createChatSubscriptionInviteLink
Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target channel chat or username of the target channel in the format @username |
name | string | Invite link name; 0-32 characters | |
subscription_period | integer | ✓ | The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days). |
subscription_price | integer | ✓ | The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000 |
returns: ChatInviteLink
createForumTopic
Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
name | string | ✓ | Topic name, 1-128 characters |
icon_color | integer | Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F). | |
icon_custom_emoji_id | string | Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. |
returns: ForumTopic
createInvoiceLink
Use this method to create a link for an invoice. Returns the created invoice link as String on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only. | |
title | string | ✓ | Product name, 1-32 characters |
description | string | ✓ | Product description, 1-255 characters |
payload | string | ✓ | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. |
provider_token | string | Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. | |
currency | string | ✓ | Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. |
prices | LabeledPrice[] | ✓ | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. |
subscription_period | integer | The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars. | |
max_tip_amount | integer | The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. | |
suggested_tip_amounts | integer[] | A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. | |
provider_data | string | JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. | |
photo_url | string | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. | |
photo_size | integer | Photo size in bytes | |
photo_width | integer | Photo width | |
photo_height | integer | Photo height | |
need_name | boolean | Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. | |
need_phone_number | boolean | Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. | |
need_email | boolean | Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. | |
need_shipping_address | boolean | Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. | |
send_phone_number_to_provider | boolean | Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars. | |
send_email_to_provider | boolean | Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars. | |
is_flexible | boolean | Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. |
returns: string
createNewStickerSet
Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier of created sticker set owner |
name | string | ✓ | Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "by<bot_username>". <bot_username> is case insensitive. 1-64 characters. |
title | string | ✓ | Sticker set title, 1-64 characters |
stickers | InputSticker[] | ✓ | A JSON-serialized list of 1-50 initial stickers to be added to the sticker set |
sticker_type | string | Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created. | |
needs_repainting | boolean | Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only |
returns: true
declineChatJoinRequest
Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
returns: true
declineSuggestedPost
Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | ✓ | Unique identifier for the target direct messages chat |
message_id | integer | ✓ | Identifier of a suggested post message to decline |
comment | string | Comment for the creator of the suggested post; 0-128 characters |
returns: true
deleteAllMessageReactions
Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
user_id | integer | Identifier of the user whose reactions will be removed, if the reactions were added by a user | |
actor_chat_id | integer | Identifier of the chat whose reactions will be removed, if the reactions were added by a chat |
returns: true
deleteBusinessMessages
Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection on behalf of which to delete the messages |
message_ids | integer[] | ✓ | A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted. |
returns: true
deleteChatPhoto
Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
returns: true
deleteChatStickerSet
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
returns: true
deleteForumTopic
Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
message_thread_id | integer | ✓ | Unique identifier for the target message thread of the forum topic |
returns: true
deleteMessage
Use this method to delete a message, including service messages, with the following limitations:- A message can only be deleted if it was sent less than 48 hours ago.- Service messages about a supergroup, channel, or forum topic creation can't be deleted.- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.- Bots can delete outgoing messages in private chats, groups, and supergroups.- Bots can delete incoming messages in private chats.- Bots granted can_post_messages permissions can delete outgoing messages in channels.- If the bot is an administrator of a group, it can delete any message there.- If the bot has can_delete_messages administrator right in a supergroup or a channel, it can delete any message there.- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_id | integer | ✓ | Identifier of the message to delete |
returns: true
deleteMessageReaction
Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
message_id | integer | ✓ | Identifier of the target message |
user_id | integer | Identifier of the user whose reaction will be removed, if the reaction was added by a user | |
actor_chat_id | integer | Identifier of the chat whose reaction will be removed, if the reaction was added by a chat |
returns: true
deleteMessages
Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_ids | integer[] | ✓ | A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted. |
returns: true
deleteMyCommands
Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
scope | BotCommandScope | A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. | |
language_code | string | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands. |
returns: true
deleteStickerFromSet
Use this method to delete a sticker from a set created by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
sticker | string | ✓ | File identifier of the sticker |
returns: true
deleteStickerSet
Use this method to delete a sticker set that was created by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
name | string | ✓ | Sticker set name |
returns: true
deleteStory
Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
story_id | integer | ✓ | Unique identifier of the story to delete |
returns: true
deleteWebhook
Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
drop_pending_updates | boolean | Pass True to drop all pending updates |
returns: true
editChatInviteLink
Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
invite_link | string | ✓ | The invite link to edit |
name | string | Invite link name; 0-32 characters | |
expire_date | integer | Point in time (Unix timestamp) when the link will expire | |
member_limit | integer | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | |
creates_join_request | boolean | True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified. |
returns: ChatInviteLink
editChatSubscriptionInviteLink
Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
invite_link | string | ✓ | The invite link to edit |
name | string | Invite link name; 0-32 characters |
returns: ChatInviteLink
editForumTopic
Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
message_thread_id | integer | ✓ | Unique identifier for the target message thread of the forum topic |
name | string | New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept. | |
icon_custom_emoji_id | string | New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept. |
returns: true
editGeneralForumTopic
Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
name | string | ✓ | New topic name, 1-128 characters |
returns: true
editMessageCaption
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message to be edited was sent | |
chat_id | integer | string | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | |
message_id | integer | Required if inline_message_id is not specified. Identifier of the message to edit. | |
inline_message_id | string | Required if chat_id and message_id are not specified. Identifier of the inline message. | |
caption | string | New caption of the message, 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the message caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages. | |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for an inline keyboard |
returns: Message
editMessageChecklist
Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot in the format @username |
message_id | integer | ✓ | Unique identifier for the target message |
checklist | InputChecklist | ✓ | A JSON-serialized object for the new checklist |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for the new inline keyboard for the message |
returns: Message
editMessageLiveLocation
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message to be edited was sent | |
chat_id | integer | string | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | |
message_id | integer | Required if inline_message_id is not specified. Identifier of the message to edit. | |
inline_message_id | string | Required if chat_id and message_id are not specified. Identifier of the inline message. | |
latitude | float | ✓ | Latitude of new location |
longitude | float | ✓ | Longitude of new location |
live_period | integer | New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged. | |
horizontal_accuracy | float | The radius of uncertainty for the location, measured in meters; 0-1500 | |
heading | integer | Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | |
proximity_alert_radius | integer | The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for a new inline keyboard |
returns: Message
editMessageMedia
Use this method to edit animation, audio, document, live photo, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, a live photo, or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message to be edited was sent | |
chat_id | integer | string | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | |
message_id | integer | Required if inline_message_id is not specified. Identifier of the message to edit. | |
inline_message_id | string | Required if chat_id and message_id are not specified. Identifier of the inline message. | |
media | InputMedia | ✓ | A JSON-serialized object for a new media content of the message |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for a new inline keyboard |
returns: Message
editMessageReplyMarkup
Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message to be edited was sent | |
chat_id | integer | string | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | |
message_id | integer | Required if inline_message_id is not specified. Identifier of the message to edit. | |
inline_message_id | string | Required if chat_id and message_id are not specified. Identifier of the inline message. | |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for an inline keyboard |
returns: Message
editMessageText
Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message to be edited was sent | |
chat_id | integer | string | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | |
message_id | integer | Required if inline_message_id is not specified. Identifier of the message to edit. | |
inline_message_id | string | Required if chat_id and message_id are not specified. Identifier of the inline message. | |
text | string | ✓ | New text of the message, 1-4096 characters after entities parsing |
parse_mode | string | Mode for parsing entities in the message text. See formatting options for more details. | |
entities | MessageEntity[] | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | |
link_preview_options | LinkPreviewOptions | Link preview generation options for the message | |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for an inline keyboard |
returns: Message
editStory
Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
story_id | integer | ✓ | Unique identifier of the story to edit |
content | InputStoryContent | ✓ | Content of the story |
caption | string | Caption of the story, 0-2048 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the story caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
areas | StoryArea[] | A JSON-serialized list of clickable areas to be shown on the story |
returns: Story
editUserStarSubscription
Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Identifier of the user whose subscription will be edited |
telegram_payment_charge_id | string | ✓ | Telegram payment identifier for the subscription |
is_canceled | boolean | ✓ | Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot. |
returns: true
exportChatInviteLink
Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
returns: string
forwardMessage
Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat | |
from_chat_id | integer | string | ✓ | Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username) |
video_start_timestamp | integer | New start timestamp for the forwarded video in the message | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the forwarded message from forwarding and saving | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; only available when forwarding to private chats | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only | |
message_id | integer | ✓ | Message identifier in the chat specified in from_chat_id |
returns: Message
forwardMessages
Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat | |
from_chat_id | integer | string | ✓ | Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username) |
message_ids | integer[] | ✓ | A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. |
disable_notification | boolean | Sends the messages silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the forwarded messages from forwarding and saving |
returns: MessageId[]
getAvailableGifts
Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.
returns: Gifts
getBusinessAccountGifts
Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
exclude_unsaved | boolean | Pass True to exclude gifts that aren't saved to the account's profile page | |
exclude_saved | boolean | Pass True to exclude gifts that are saved to the account's profile page | |
exclude_unlimited | boolean | Pass True to exclude gifts that can be purchased an unlimited number of times | |
exclude_limited_upgradable | boolean | Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | |
exclude_limited_non_upgradable | boolean | Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | |
exclude_unique | boolean | Pass True to exclude unique gifts | |
exclude_from_blockchain | boolean | Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | |
sort_by_price | boolean | Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | |
offset | string | Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results | |
limit | integer | The maximum number of gifts to be returned; 1-100. Defaults to 100. |
returns: OwnedGifts
getBusinessAccountStarBalance
Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
returns: StarAmount
getBusinessConnection
Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
returns: BusinessConnection
getChat
Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup or channel in the format @username |
returns: ChatFullInfo
getChatAdministrators
Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup or channel in the format @username |
return_bots | boolean | Pass True to additionally receive all bots that are administrators of the chat. By default, bots other than the current bot are omitted. |
returns: ChatMember[]
getChatGifts
Returns the gifts owned by a chat. Returns OwnedGifts on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
exclude_unsaved | boolean | Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel. | |
exclude_saved | boolean | Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel. | |
exclude_unlimited | boolean | Pass True to exclude gifts that can be purchased an unlimited number of times | |
exclude_limited_upgradable | boolean | Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | |
exclude_limited_non_upgradable | boolean | Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | |
exclude_from_blockchain | boolean | Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | |
exclude_unique | boolean | Pass True to exclude unique gifts | |
sort_by_price | boolean | Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | |
offset | string | Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results | |
limit | integer | The maximum number of gifts to be returned; 1-100. Defaults to 100. |
returns: OwnedGifts
getChatMember
Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup or channel in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
returns: ChatMember
getChatMemberCount
Use this method to get the number of members in a chat. Returns Int on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup or channel in the format @username |
returns: integer
getChatMenuButton
Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | Unique identifier for the target private chat. If not specified, the bot's default menu button will be returned. |
returns: MenuButton
getCustomEmojiStickers
Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
| parameter | type | required | description |
|---|---|---|---|
custom_emoji_ids | string[] | ✓ | A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified. |
returns: Sticker[]
getFile
Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. 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 again.
| parameter | type | required | description |
|---|---|---|---|
file_id | string | ✓ | File identifier to get information about |
returns: File
getForumTopicIconStickers
Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.
returns: Sticker[]
getGameHighScores
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Target user id |
chat_id | integer | Required if inline_message_id is not specified. Unique identifier for the target chat. | |
message_id | integer | Required if inline_message_id is not specified. Identifier of the sent message. | |
inline_message_id | string | Required if chat_id and message_id are not specified. Identifier of the inline message. |
returns: GameHighScore[]
getManagedBotAccessSettings
Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier of the managed bot whose access settings will be returned |
returns: BotAccessSettings
getManagedBotToken
Use this method to get the token of a managed bot. Returns the token as String on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier of the managed bot whose token will be returned |
returns: string
getMe
A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
returns: User
getMyCommands
Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
| parameter | type | required | description |
|---|---|---|---|
scope | BotCommandScope | A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault. | |
language_code | string | A two-letter ISO 639-1 language code or an empty string |
returns: BotCommand[]
getMyDefaultAdministratorRights
Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
| parameter | type | required | description |
|---|---|---|---|
for_channels | boolean | Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned. |
returns: ChatAdministratorRights
getMyDescription
Use this method to get the current bot description for the given user language. Returns BotDescription on success.
| parameter | type | required | description |
|---|---|---|---|
language_code | string | A two-letter ISO 639-1 language code or an empty string |
returns: BotDescription
getMyName
Use this method to get the current bot name for the given user language. Returns BotName on success.
| parameter | type | required | description |
|---|---|---|---|
language_code | string | A two-letter ISO 639-1 language code or an empty string |
returns: BotName
getMyShortDescription
Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
| parameter | type | required | description |
|---|---|---|---|
language_code | string | A two-letter ISO 639-1 language code or an empty string |
returns: BotShortDescription
getMyStarBalance
A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.
returns: StarAmount
getStarTransactions
Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.
| parameter | type | required | description |
|---|---|---|---|
offset | integer | Number of transactions to skip in the response | |
limit | integer | The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100. |
returns: StarTransactions
getStickerSet
Use this method to get a sticker set. On success, a StickerSet object is returned.
| parameter | type | required | description |
|---|---|---|---|
name | string | ✓ | Name of the sticker set |
returns: StickerSet
getUpdates
Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
| parameter | type | required | description |
|---|---|---|---|
offset | integer | Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten. | |
limit | integer | Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. | |
timeout | integer | Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. | |
allowed_updates | string[] | A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time. |
returns: Update[]
getUserChatBoosts
Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the chat or username of the channel in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
returns: UserChatBoosts
getUserGifts
Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the user |
exclude_unlimited | boolean | Pass True to exclude gifts that can be purchased an unlimited number of times | |
exclude_limited_upgradable | boolean | Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | |
exclude_limited_non_upgradable | boolean | Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | |
exclude_from_blockchain | boolean | Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | |
exclude_unique | boolean | Pass True to exclude unique gifts | |
sort_by_price | boolean | Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | |
offset | string | Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results | |
limit | integer | The maximum number of gifts to be returned; 1-100. Defaults to 100. |
returns: OwnedGifts
getUserPersonalChatMessages
Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an array of Message objects is returned.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier for the target user |
limit | integer | ✓ | The maximum number of messages to return; 1-20 |
returns: Message[]
getUserProfileAudios
Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the target user |
offset | integer | Sequential number of the first audio to be returned. By default, all audios are returned. | |
limit | integer | Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100. |
returns: UserProfileAudios
getUserProfilePhotos
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the target user |
offset | integer | Sequential number of the first photo to be returned. By default, all photos are returned. | |
limit | integer | Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. |
returns: UserProfilePhotos
getWebhookInfo
Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
returns: WebhookInfo
giftPremiumSubscription
Gifts a Telegram Premium subscription to the given user. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the target user who will receive a Telegram Premium subscription |
month_count | integer | ✓ | Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12 |
star_count | integer | ✓ | Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months |
text | string | Text that will be shown along with the service message about the subscription; 0-128 characters | |
text_parse_mode | string | Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored. | |
text_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored. |
returns: true
hideGeneralForumTopic
Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
returns: true
leaveChat
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup or channel in the format @username. Channel direct messages chats aren't supported; leave the corresponding channel instead. |
returns: true
logOut
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
returns: true
pinChatMessage
Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be pinned | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
message_id | integer | ✓ | Identifier of a message to pin |
disable_notification | boolean | Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. |
returns: true
postStory
Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
content | InputStoryContent | ✓ | Content of the story |
active_period | integer | ✓ | Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 |
caption | string | Caption of the story, 0-2048 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the story caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
areas | StoryArea[] | A JSON-serialized list of clickable areas to be shown on the story | |
post_to_chat_page | boolean | Pass True to keep the story accessible after it expires | |
protect_content | boolean | Pass True if the content of the story must be protected from forwarding and screenshotting |
returns: Story
promoteChatMember
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
is_anonymous | boolean | Pass True if the administrator's presence in the chat is hidden | |
can_manage_chat | boolean | Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. | |
can_delete_messages | boolean | Pass True if the administrator can delete messages of other users | |
can_manage_video_chats | boolean | Pass True if the administrator can manage video chats | |
can_restrict_members | boolean | Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators. | |
can_promote_members | boolean | Pass 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 him) | |
can_change_info | boolean | Pass True if the administrator can change chat title, photo and other settings | |
can_invite_users | boolean | Pass True if the administrator can invite new users to the chat | |
can_post_stories | boolean | Pass True if the administrator can post stories to the chat | |
can_edit_stories | boolean | Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | |
can_delete_stories | boolean | Pass True if the administrator can delete stories posted by other users | |
can_post_messages | boolean | Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | |
can_edit_messages | boolean | Pass True if the administrator can edit messages of other users and can pin messages; for channels only | |
can_pin_messages | boolean | Pass True if the administrator can pin messages; for supergroups only | |
can_manage_topics | boolean | Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | |
can_manage_direct_messages | boolean | Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only | |
can_manage_tags | boolean | Pass True if the administrator can edit the tags of regular members; for groups and supergroups only |
returns: true
readBusinessMessage
Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection on behalf of which to read the message |
chat_id | integer | ✓ | Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours. |
message_id | integer | ✓ | Unique identifier of the message to mark as read |
returns: true
refundStarPayment
Refunds a successful payment in Telegram Stars. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Identifier of the user whose payment will be refunded |
telegram_payment_charge_id | string | ✓ | Telegram payment identifier |
returns: true
removeBusinessAccountProfilePhoto
Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
is_public | boolean | Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo. |
returns: true
removeChatVerification
Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot or channel in the format @username |
returns: true
removeMyProfilePhoto
Removes the profile photo of the bot. Requires no parameters. Returns True on success.
returns: true
removeUserVerification
Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the target user |
returns: true
reopenForumTopic
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
message_thread_id | integer | ✓ | Unique identifier for the target message thread of the forum topic |
returns: true
reopenGeneralForumTopic
Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
returns: true
replaceManagedBotToken
Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier of the managed bot whose token will be replaced |
returns: string
replaceStickerInSet
Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier of the sticker set owner |
name | string | ✓ | Sticker set name |
old_sticker | string | ✓ | File identifier of the replaced sticker |
sticker | InputSticker | ✓ | A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged. |
returns: true
repostStory
Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
from_chat_id | integer | ✓ | Unique identifier of the chat which posted the story that should be reposted |
from_story_id | integer | ✓ | Unique identifier of the story that should be reposted |
active_period | integer | ✓ | Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 |
post_to_chat_page | boolean | Pass True to keep the story accessible after it expires | |
protect_content | boolean | Pass True if the content of the story must be protected from forwarding and screenshotting |
returns: Story
restrictChatMember
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
permissions | ChatPermissions | ✓ | A JSON-serialized object for new user permissions |
use_independent_chat_permissions | boolean | Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. | |
until_date | integer | Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever. |
returns: true
revokeChatInviteLink
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier of the target chat or username of the target channel in the format @username |
invite_link | string | ✓ | The invite link to revoke |
returns: ChatInviteLink
savePreparedInlineMessage
Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the target user that can use the prepared message |
result | InlineQueryResult | ✓ | A JSON-serialized object describing the message to be sent |
allow_user_chats | boolean | Pass True if the message can be sent to private chats with users | |
allow_bot_chats | boolean | Pass True if the message can be sent to private chats with bots | |
allow_group_chats | boolean | Pass True if the message can be sent to group and supergroup chats | |
allow_channel_chats | boolean | Pass True if the message can be sent to channel chats |
returns: PreparedInlineMessage
savePreparedKeyboardButton
Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the target user that can use the button |
button | KeyboardButton | ✓ | A JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot. |
returns: PreparedKeyboardButton
sendAnimation
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
animation | InputFile | string | ✓ | Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files » |
duration | integer | Duration of sent animation in seconds | |
width | integer | Animation width | |
height | integer | Animation height | |
thumbnail | InputFile | string | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | |
caption | string | Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the animation caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Pass True, if the caption must be shown above the message media | |
has_spoiler | boolean | Pass True if the animation needs to be covered with a spoiler animation | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendAudio
Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice method instead.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
audio | InputFile | string | ✓ | Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » |
caption | string | Audio caption, 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the audio caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
duration | integer | Duration of the audio in seconds | |
performer | string | Performer | |
title | string | Track name | |
thumbnail | InputFile | string | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendChatAction
Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the action will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot or supergroup in the format @username. Channel chats and channel direct messages chats aren't supported. |
message_thread_id | integer | Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only | |
action | string | ✓ | Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. |
returns: true
sendChecklist
Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection on behalf of which the message will be sent |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot in the format @username |
checklist | InputChecklist | ✓ | A JSON-serialized object for the checklist to send |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
message_effect_id | string | Unique identifier of the message effect to be added to the message | |
reply_parameters | ReplyParameters | A JSON-serialized object for description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for an inline keyboard |
returns: Message
sendContact
Use this method to send phone contacts. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
phone_number | string | ✓ | Contact's phone number |
first_name | string | ✓ | Contact's first name |
last_name | string | Contact's last name | |
vcard | string | Additional data about the contact in the form of a vCard, 0-2048 bytes | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendDice
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
emoji | string | Emoji on which the dice throw animation is based. Currently, must be one of “”, “”, “”, “”, “”, or “”. Dice can have values 1-6 for “”, “” and “”, values 1-5 for “” and “”, and values 1-64 for “”. Defaults to “”. | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendDocument
Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
document | InputFile | string | ✓ | File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » |
thumbnail | InputFile | string | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | |
caption | string | Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the document caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
disable_content_type_detection | boolean | Disables automatic server-side content type detection for files uploaded using multipart/form-data | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendGame
Use this method to send a game. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot in the format @username. Games can't be sent to channel direct messages chats and channel chats. |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
game_short_name | string | ✓ | Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather. |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. |
returns: Message
sendGift
Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | Required if chat_id is not specified. Unique identifier of the target user who will receive the gift. | |
chat_id | integer | string | Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @username) that will receive the gift. | |
gift_id | string | ✓ | Identifier of the gift; limited gifts can't be sent to channel chats |
pay_for_upgrade | boolean | Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver | |
text | string | Text that will be shown along with the gift; 0-128 characters | |
text_parse_mode | string | Mode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored. | |
text_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored. |
returns: true
sendInvoice
Use this method to send invoices. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
title | string | ✓ | Product name, 1-32 characters |
description | string | ✓ | Product description, 1-255 characters |
payload | string | ✓ | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. |
provider_token | string | Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. | |
currency | string | ✓ | Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. |
prices | LabeledPrice[] | ✓ | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. |
max_tip_amount | integer | The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. | |
suggested_tip_amounts | integer[] | A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. | |
start_parameter | string | Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter. | |
provider_data | string | JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. | |
photo_url | string | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. | |
photo_size | integer | Photo size in bytes | |
photo_width | integer | Photo width | |
photo_height | integer | Photo height | |
need_name | boolean | Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. | |
need_phone_number | boolean | Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. | |
need_email | boolean | Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. | |
need_shipping_address | boolean | Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. | |
send_phone_number_to_provider | boolean | Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars. | |
send_email_to_provider | boolean | Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars. | |
is_flexible | boolean | Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. |
returns: Message
sendLivePhoto
Use this method to send live photos. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
live_photo | InputFile | string | ✓ | Live photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported. |
photo | InputFile | string | ✓ | The static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported. |
caption | string | Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the video caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Pass True, if the caption must be shown above the message media | |
has_spoiler | boolean | Pass True if the video needs to be covered with a spoiler animation | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendLocation
Use this method to send point on the map. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
latitude | float | ✓ | Latitude of the location |
longitude | float | ✓ | Longitude of the location |
horizontal_accuracy | float | The radius of uncertainty for the location, measured in meters; 0-1500 | |
live_period | integer | Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely | |
heading | integer | For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | |
proximity_alert_radius | integer | For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendMediaGroup
Use this method to send a group of photos, live photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Message objects that were sent is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat | |
media | InputMediaAudio | InputMediaDocument | InputMediaLivePhoto | InputMediaPhoto | InputMediaVideo[] | ✓ | A JSON-serialized array describing messages to be sent, must include 2-10 items |
disable_notification | boolean | Sends messages silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent messages from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
reply_parameters | ReplyParameters | Description of the message to reply to |
returns: Message[]
sendMessage
Use this method to send text messages. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
text | string | ✓ | Text of the message to be sent, 1-4096 characters after entities parsing |
parse_mode | string | Mode for parsing entities in the message text. See formatting options for more details. | |
entities | MessageEntity[] | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | |
link_preview_options | LinkPreviewOptions | Link preview generation options for the message | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendMessageDraft
Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendMessage with the complete message to persist it in the user's chat. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | ✓ | Unique identifier for the target private chat |
message_thread_id | integer | Unique identifier for the target message thread | |
draft_id | integer | ✓ | Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated. |
text | string | Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a “Thinking…” placeholder. | |
parse_mode | string | Mode for parsing entities in the message text. See formatting options for more details. | |
entities | MessageEntity[] | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode |
returns: true
sendPaidMedia
Use this method to send paid media. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance. |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
star_count | integer | ✓ | The number of Telegram Stars that must be paid to buy access to the media; 1-25000 |
media | InputPaidMedia[] | ✓ | A JSON-serialized array describing the media to be sent; up to 10 items |
payload | string | Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes. | |
caption | string | Media caption, 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the media caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Pass True, if the caption must be shown above the message media | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendPhoto
Use this method to send photos. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
photo | InputFile | string | ✓ | Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files » |
caption | string | Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the photo caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Pass True, if the caption must be shown above the message media | |
has_spoiler | boolean | Pass True if the photo needs to be covered with a spoiler animation | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendPoll
Use this method to send a native poll. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Polls can't be sent to channel direct messages chats. |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
question | string | ✓ | Poll question, 1-300 characters |
question_parse_mode | string | Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed. | |
question_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode. | |
options | InputPollOption[] | ✓ | A JSON-serialized list of 1-12 answer options |
is_anonymous | boolean | True, if the poll needs to be anonymous, defaults to True | |
type | string | Poll type, “quiz” or “regular”, defaults to “regular” | |
allows_multiple_answers | boolean | Pass True, if the poll allows multiple answers, defaults to False | |
allows_revoting | boolean | Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls | |
shuffle_options | boolean | Pass True, if the poll options must be shown in random order | |
allow_adding_options | boolean | Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes | |
hide_results_until_closes | boolean | Pass True, if poll results must be shown only after the poll closes | |
members_only | boolean | Pass True, if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only | |
country_codes | string[] | A JSON-serialized list of 0-12 two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll; for channel chats only. Use “FT” as a country code to allow users with anonymous numbers to vote. If omitted or empty, then users from any country can participate in the poll. | |
correct_option_ids | integer[] | A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode | |
explanation | string | 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 with at most 2 line feeds after entities parsing | |
explanation_parse_mode | string | Mode for parsing entities in the explanation. See formatting options for more details. | |
explanation_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode. | |
explanation_media | InputPollMedia | Media added to the quiz explanation | |
open_period | integer | Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date. | |
close_date | integer | Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period. | |
is_closed | boolean | Pass True if the poll needs to be immediately closed. This can be useful for poll preview. | |
description | string | Description of the poll to be sent, 0-1024 characters after entities parsing | |
description_parse_mode | string | Mode for parsing entities in the poll description. See formatting options for more details. | |
description_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode | |
media | InputPollMedia | Media added to the poll description | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendSticker
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
sticker | InputFile | string | ✓ | Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL. |
emoji | string | Emoji associated with the sticker; only for just uploaded stickers | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendVenue
Use this method to send information about a venue. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
latitude | float | ✓ | Latitude of the venue |
longitude | float | ✓ | Longitude of the venue |
title | string | ✓ | Name of the venue |
address | string | ✓ | Address of the venue |
foursquare_id | string | Foursquare identifier of the venue | |
foursquare_type | string | Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) | |
google_place_id | string | Google Places identifier of the venue | |
google_place_type | string | Google Places type of the venue. (See supported types.) | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendVideo
Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
video | InputFile | string | ✓ | Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files » |
duration | integer | Duration of sent video in seconds | |
width | integer | Video width | |
height | integer | Video height | |
thumbnail | InputFile | string | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | |
cover | InputFile | string | Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » | |
start_timestamp | integer | Start timestamp for the video in the message | |
caption | string | Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the video caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Pass True, if the caption must be shown above the message media | |
has_spoiler | boolean | Pass True if the video needs to be covered with a spoiler animation | |
supports_streaming | boolean | Pass True if the uploaded video is suitable for streaming | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendVideoNote
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
video_note | InputFile | string | ✓ | Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported. |
duration | integer | Duration of sent video in seconds | |
length | integer | Video width and height, i.e. diameter of the video message | |
thumbnail | InputFile | string | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
sendVoice
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_thread_id | integer | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | |
direct_messages_topic_id | integer | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | |
voice | InputFile | string | ✓ | Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » |
caption | string | Voice message caption, 0-1024 characters after entities parsing | |
parse_mode | string | Mode for parsing entities in the voice message caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | |
duration | integer | Duration of the voice message in seconds | |
disable_notification | boolean | Sends the message silently. Users will receive a notification with no sound. | |
protect_content | boolean | Protects the contents of the sent message from forwarding and saving | |
allow_paid_broadcast | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | |
message_effect_id | string | Unique identifier of the message effect to be added to the message; for private chats only | |
suggested_post_parameters | SuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | |
reply_parameters | ReplyParameters | Description of the message to reply to | |
reply_markup | InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. |
returns: Message
setBusinessAccountBio
Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
bio | string | The new value of the bio for the business account; 0-140 characters |
returns: true
setBusinessAccountGiftSettings
Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
show_gift_button | boolean | ✓ | Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field |
accepted_gift_types | AcceptedGiftTypes | ✓ | Types of gifts accepted by the business account |
returns: true
setBusinessAccountName
Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
first_name | string | ✓ | The new value of the first name for the business account; 1-64 characters |
last_name | string | The new value of the last name for the business account; 0-64 characters |
returns: true
setBusinessAccountProfilePhoto
Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
photo | InputProfilePhoto | ✓ | The new profile photo to set |
is_public | boolean | Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo. |
returns: true
setBusinessAccountUsername
Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
username | string | The new value of the username for the business account; 0-32 characters |
returns: true
setChatAdministratorCustomTitle
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
custom_title | string | ✓ | New custom title for the administrator; 0-16 characters, emoji are not allowed |
returns: true
setChatDescription
Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
description | string | New chat description, 0-255 characters |
returns: true
setChatMemberTag
Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
tag | string | New tag for the member; 0-16 characters, emoji are not allowed |
returns: true
setChatMenuButton
Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | Unique identifier for the target private chat. If not specified, the bot's default menu button will be changed. | |
menu_button | MenuButton | A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault. |
returns: true
setChatPermissions
Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
permissions | ChatPermissions | ✓ | A JSON-serialized object for new default chat permissions |
use_independent_chat_permissions | boolean | Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. |
returns: true
setChatPhoto
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
photo | InputFile | ✓ | New chat photo, uploaded using multipart/form-data |
returns: true
setChatStickerSet
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
sticker_set_name | string | ✓ | Name of the sticker set to be set as the group sticker set |
returns: true
setChatTitle
Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
title | string | ✓ | New chat title, 1-128 characters |
returns: true
setCustomEmojiStickerSetThumbnail
Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
name | string | ✓ | Sticker set name |
custom_emoji_id | string | Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail |
returns: true
setGameScore
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier |
score | integer | ✓ | New score, must be non-negative |
force | boolean | Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters. | |
disable_edit_message | boolean | Pass True if the game message should not be automatically edited to include the current scoreboard | |
chat_id | integer | Required if inline_message_id is not specified. Unique identifier for the target chat. | |
message_id | integer | Required if inline_message_id is not specified. Identifier of the sent message. | |
inline_message_id | string | Required if chat_id and message_id are not specified. Identifier of the inline message. |
returns: Message
setManagedBotAccessSettings
Use this method to change the access settings of a managed bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier of the managed bot whose access settings will be changed |
is_access_restricted | boolean | ✓ | Pass True, if only selected users can access the bot. The bot's owner can always access it. |
added_user_ids | integer[] | A JSON-serialized list of up to 10 identifiers of users who will have access to the bot in addition to its owner. Ignored if is_access_restricted is false. |
returns: true
setMessageReaction
Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_id | integer | ✓ | Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead. |
reaction | ReactionType[] | A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots. | |
is_big | boolean | Pass True to set the reaction with a big animation |
returns: true
setMyCommands
Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
commands | BotCommand[] | ✓ | A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. |
scope | BotCommandScope | A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. | |
language_code | string | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands. |
returns: true
setMyDefaultAdministratorRights
Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
rights | ChatAdministratorRights | A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared. | |
for_channels | boolean | Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed. |
returns: true
setMyDescription
Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
description | string | New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language. | |
language_code | string | A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description. |
returns: true
setMyName
Use this method to change the bot's name. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
name | string | New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language. | |
language_code | string | A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name. |
returns: true
setMyProfilePhoto
Changes the profile photo of the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
photo | InputProfilePhoto | ✓ | The new profile photo to set |
returns: true
setMyShortDescription
Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
short_description | string | New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language. | |
language_code | string | A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description. |
returns: true
setPassportDataErrors
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier |
errors | PassportElementError[] | ✓ | A JSON-serialized array describing the errors |
returns: true
setStickerEmojiList
Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
sticker | string | ✓ | File identifier of the sticker |
emoji_list | string[] | ✓ | A JSON-serialized list of 1-20 emoji associated with the sticker |
returns: true
setStickerKeywords
Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
sticker | string | ✓ | File identifier of the sticker |
keywords | string[] | A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters |
returns: true
setStickerMaskPosition
Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
sticker | string | ✓ | File identifier of the sticker |
mask_position | MaskPosition | A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position. |
returns: true
setStickerPositionInSet
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
sticker | string | ✓ | File identifier of the sticker |
position | integer | ✓ | New sticker position in the set, zero-based |
returns: true
setStickerSetThumbnail
Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
name | string | ✓ | Sticker set name |
user_id | integer | ✓ | User identifier of the sticker set owner |
thumbnail | InputFile | string | A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. | |
format | static | animated | video | ✓ | Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a .WEBM video |
returns: true
setStickerSetTitle
Use this method to set the title of a created sticker set. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
name | string | ✓ | Sticker set name |
title | string | ✓ | Sticker set title, 1-64 characters |
returns: true
setUserEmojiStatus
Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the target user |
emoji_status_custom_emoji_id | string | Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status. | |
emoji_status_expiration_date | integer | Expiration date of the emoji status, if any |
returns: true
setWebhook
Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request (a request with response HTTP status code different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
| parameter | type | required | description |
|---|---|---|---|
url | string | ✓ | HTTPS URL to send updates to. Use an empty string to remove webhook integration. |
certificate | InputFile | Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. | |
ip_address | string | The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS | |
max_connections | integer | The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. | |
allowed_updates | string[] | A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. | |
drop_pending_updates | boolean | Pass True to drop all pending updates | |
secret_token | string | A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. |
returns: true
stopMessageLiveLocation
Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message to be edited was sent | |
chat_id | integer | string | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | |
message_id | integer | Required if inline_message_id is not specified. Identifier of the message with live location to stop. | |
inline_message_id | string | Required if chat_id and message_id are not specified. Identifier of the inline message. | |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for a new inline keyboard |
returns: Message
stopPoll
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message to be edited was sent | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username |
message_id | integer | ✓ | Identifier of the original message with the poll |
reply_markup | InlineKeyboardMarkup | A JSON-serialized object for a new message inline keyboard |
returns: Poll
transferBusinessAccountStars
Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
star_count | integer | ✓ | Number of Telegram Stars to transfer; 1-10000 |
returns: true
transferGift
Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
owned_gift_id | string | ✓ | Unique identifier of the regular gift that should be transferred |
new_owner_chat_id | integer | ✓ | Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours. |
star_count | integer | The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required. |
returns: true
unbanChatMember
Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target group or username of the target supergroup or channel in the format @username |
user_id | integer | ✓ | Unique identifier of the target user |
only_if_banned | boolean | Do nothing if the user is not banned |
returns: true
unbanChatSenderChat
Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
sender_chat_id | integer | ✓ | Unique identifier of the target sender chat |
returns: true
unhideGeneralForumTopic
Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
returns: true
unpinAllChatMessages
Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
returns: true
unpinAllForumTopicMessages
Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
message_thread_id | integer | ✓ | Unique identifier for the target message thread of the forum topic |
returns: true
unpinAllGeneralForumTopicMessages
Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target supergroup in the format @username |
returns: true
unpinChatMessage
Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | Unique identifier of the business connection on behalf of which the message will be unpinned | |
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target channel in the format @username |
message_id | integer | Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned. |
returns: true
upgradeGift
Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
owned_gift_id | string | ✓ | Unique identifier of the regular gift that should be upgraded to a unique one |
keep_original_details | boolean | Pass True to keep the original gift text, sender and receiver in the upgraded gift | |
star_count | integer | The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed. |
returns: true
uploadStickerFile
Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | User identifier of sticker file owner |
sticker | InputFile | ✓ | A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files » |
sticker_format | static | animated | video | ✓ | Format of the sticker, must be one of “static”, “animated”, “video” |
returns: File
verifyChat
Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
chat_id | integer | string | ✓ | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Channel direct messages chats can't be verified. |
custom_description | string | Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. |
returns: true
verifyUser
Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.
| parameter | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Unique identifier of the target user |
custom_description | string | Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. |
returns: true