class

Telegram::Client::APIClient

Inherits Telegram::ResponseParser < Telegram::JSONHelper < Reference < Object

Main API client for Telegram Bot API with enhanced HTTP features Features: persistent connections, retries, timeouts, proxy support

Constructors

new(token : String, api_url : String, http_config : Telegram::HTTPClientConfig)

Initialize with custom configuration

Source
new(token : String, api_url : String, custom_client : HTTP::Client, http_config : Telegram::HTTPClientConfig = Telegram::HTTPClientConfig.new)

Initialize with custom HTTP client (for advanced use cases)

Source
new(token : String, api_url : String = "https://api.telegram.org")

Initialize with default configuration

Source

Instance methods

add_sticker_to_set(user_id : Int32, name : String, sticker : InputSticker) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#addstickertoset

Source
answer_callback_query(callback_query_id : String, text : String | Nil = nil, show_alert : Bool | Nil = nil, url : String | Nil = nil, cache_time : Int32 | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#answercallbackquery

Source
answer_inline_query(inline_query_id : String, results : Array(InlineQueryResult), cache_time : Int32 | Nil = nil, is_personal : Bool | Nil = nil, next_offset : String | Nil = nil, button : InlineQueryResultsButton | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#answerinlinequery

Source
answer_pre_checkout_query(pre_checkout_query_id : String, ok : Bool, error_message : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#answerprecheckoutquery

Source
answer_shipping_query(shipping_query_id : String, ok : Bool, shipping_options : Array(ShippingOption) | Nil = nil, error_message : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#answershippingquery

Source
answer_web_app_query(web_app_query_id : String, result : InlineQueryResult) : SentWebAppMessage

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.

Returns: SentWebAppMessage See: https://core.telegram.org/bots/api#answerwebappquery

Source
api_url

Base API URL

Source
api_url=(api_url : String)

Base API URL

Source
approve_chat_join_request(chat_id : Int32 | String, user_id : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#approvechatjoinrequest

Source
approve_suggested_post(chat_id : Int32, message_id : Int32, send_date : Int32 | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#approvesuggestedpost

Source
ban_chat_member(chat_id : Int32 | String, user_id : Int32, until_date : Int32 | Nil = nil, revoke_messages : Bool | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#banchatmember

Source
ban_chat_sender_chat(chat_id : Int32 | String, sender_chat_id : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#banchatsenderchat

Source
close

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: Bool See: https://core.telegram.org/bots/api#close

Source
close_forum_topic(chat_id : Int32 | String, message_thread_id : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#closeforumtopic

Source
close_general_forum_topic(chat_id : Int32 | String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#closegeneralforumtopic

Source
configure_http

Configure the HTTP client

Source
convert_gift_to_stars(business_connection_id : String, owned_gift_id : String) : Bool

convertGiftToStars Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#convertgifttostars

Source
copy_message(chat_id : Int32 | String, from_chat_id : Int32 | String, message_id : Int32, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, video_start_timestamp : Int32 | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, show_caption_above_media : Bool | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : MessageId

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.

Returns: MessageId See: https://core.telegram.org/bots/api#copymessage

Source
copy_messages(chat_id : Int32 | String, from_chat_id : Int32 | String, message_ids : Array(Int32), message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, remove_caption : Bool | Nil = nil) : Array(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.

Returns: Array(MessageId) See: https://core.telegram.org/bots/api#copymessages

Source
create_chat_invite_link(chat_id : Int32 | String, name : String | Nil = nil, expire_date : Int32 | Nil = nil, member_limit : Int32 | Nil = nil, creates_join_request : Bool | Nil = nil) : ChatInviteLink

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.

Returns: ChatInviteLink See: https://core.telegram.org/bots/api#createchatinvitelink

Source
create_chat_subscription_invite_link(chat_id : Int32 | String, subscription_period : Int32, subscription_price : Int32, name : String | Nil = nil) : 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.

Returns: ChatInviteLink See: https://core.telegram.org/bots/api#createchatsubscriptioninvitelink

Source
create_forum_topic(chat_id : Int32 | String, name : String, icon_color : Int32 | Nil = nil, icon_custom_emoji_id : String | Nil = nil) : ForumTopic

createForumTopic Use this method to create a 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 information about the created topic as a ForumTopic object.

Returns: ForumTopic See: https://core.telegram.org/bots/api#createforumtopic

Source
create_invoice_link(title : String, description : String, payload : String, currency : String, prices : Array(LabeledPrice), business_connection_id : String | Nil = nil, provider_token : String | Nil = nil, subscription_period : Int32 | Nil = nil, max_tip_amount : Int32 | Nil = nil, suggested_tip_amounts : Array(Int32) | Nil = nil, provider_data : String | Nil = nil, photo_url : String | Nil = nil, photo_size : Int32 | Nil = nil, photo_width : Int32 | Nil = nil, photo_height : Int32 | Nil = nil, need_name : Bool | Nil = nil, need_phone_number : Bool | Nil = nil, need_email : Bool | Nil = nil, need_shipping_address : Bool | Nil = nil, send_phone_number_to_provider : Bool | Nil = nil, send_email_to_provider : Bool | Nil = nil, is_flexible : Bool | Nil = nil) : String

createInvoiceLink Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Returns: String See: https://core.telegram.org/bots/api#createinvoicelink

Source
create_new_sticker_set(user_id : Int32, name : String, title : String, stickers : Array(InputSticker), sticker_type : String | Nil = nil, needs_repainting : Bool | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#createnewstickerset

Source
decline_chat_join_request(chat_id : Int32 | String, user_id : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#declinechatjoinrequest

Source
decline_suggested_post(chat_id : Int32, message_id : Int32, comment : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#declinesuggestedpost

Source
delete_business_messages(business_connection_id : String, message_ids : Array(Int32)) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#deletebusinessmessages

Source
delete_chat_photo(chat_id : Int32 | String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#deletechatphoto

Source
delete_chat_sticker_set(chat_id : Int32 | String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#deletechatstickerset

Source
delete_forum_topic(chat_id : Int32 | String, message_thread_id : Int32) : Bool

deleteForumTopic Use this method to delete a forum topic along with all its messages in a forum 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.

Returns: Bool See: https://core.telegram.org/bots/api#deleteforumtopic

Source
delete_message(chat_id : Int32 | String, message_id : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#deletemessage

Source
delete_messages(chat_id : Int32 | String, message_ids : Array(Int32)) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#deletemessages

Source
delete_my_commands(scope : BotCommandScope | Nil = nil, language_code : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#deletemycommands

Source
delete_sticker_from_set(sticker : String) : Bool

deleteStickerFromSet Use this method to delete a sticker from a set created by the bot. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#deletestickerfromset

Source
delete_sticker_set(name : String) : Bool

deleteStickerSet Use this method to delete a sticker set that was created by the bot. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#deletestickerset

Source
delete_story(business_connection_id : String, story_id : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#deletestory

Source
delete_webhook(drop_pending_updates : Bool | Nil = nil) : Bool

deleteWebhook Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#deletewebhook

Source
edit_chat_invite_link(chat_id : Int32 | String, invite_link : String, name : String | Nil = nil, expire_date : Int32 | Nil = nil, member_limit : Int32 | Nil = nil, creates_join_request : Bool | Nil = nil) : ChatInviteLink

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.

Returns: ChatInviteLink See: https://core.telegram.org/bots/api#editchatinvitelink

Source
edit_chat_subscription_invite_link(chat_id : Int32 | String, invite_link : String, name : String | Nil = nil) : 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.

Returns: ChatInviteLink See: https://core.telegram.org/bots/api#editchatsubscriptioninvitelink

Source
edit_forum_topic(chat_id : Int32 | String, message_thread_id : Int32, name : String | Nil = nil, icon_custom_emoji_id : String | Nil = nil) : Bool

editForumTopic Use this method to edit name and icon of a 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.

Returns: Bool See: https://core.telegram.org/bots/api#editforumtopic

Source
edit_general_forum_topic(chat_id : Int32 | String, name : String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#editgeneralforumtopic

Source
edit_message_caption(business_connection_id : String | Nil = nil, chat_id : Int32 | String | Nil = nil, message_id : Int32 | Nil = nil, inline_message_id : String | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, show_caption_above_media : Bool | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : JSON::Any

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.

Returns: JSON::Any See: https://core.telegram.org/bots/api#editmessagecaption

Source
edit_message_checklist(business_connection_id : String, chat_id : Int32, message_id : Int32, checklist : InputChecklist, reply_markup : InlineKeyboardMarkup | Nil = nil) : Message

editMessageChecklist Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#editmessagechecklist

Source
edit_message_live_location(latitude : Float64, longitude : Float64, business_connection_id : String | Nil = nil, chat_id : Int32 | String | Nil = nil, message_id : Int32 | Nil = nil, inline_message_id : String | Nil = nil, live_period : Int32 | Nil = nil, horizontal_accuracy : Float64 | Nil = nil, heading : Int32 | Nil = nil, proximity_alert_radius : Int32 | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : JSON::Any

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.

Returns: JSON::Any See: https://core.telegram.org/bots/api#editmessagelivelocation

Source
edit_message_media(media : InputMedia, business_connection_id : String | Nil = nil, chat_id : Int32 | String | Nil = nil, message_id : Int32 | Nil = nil, inline_message_id : String | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : JSON::Any

editMessageMedia Use this method to edit animation, audio, document, 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 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.

Returns: JSON::Any See: https://core.telegram.org/bots/api#editmessagemedia

Source
edit_message_reply_markup(business_connection_id : String | Nil = nil, chat_id : Int32 | String | Nil = nil, message_id : Int32 | Nil = nil, inline_message_id : String | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : JSON::Any

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.

Returns: JSON::Any See: https://core.telegram.org/bots/api#editmessagereplymarkup

Source
edit_message_text(text : String, business_connection_id : String | Nil = nil, chat_id : Int32 | String | Nil = nil, message_id : Int32 | Nil = nil, inline_message_id : String | Nil = nil, parse_mode : String | Nil = nil, entities : Array(MessageEntity) | Nil = nil, link_preview_options : LinkPreviewOptions | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : JSON::Any

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.

Returns: JSON::Any See: https://core.telegram.org/bots/api#editmessagetext

Source
edit_story(business_connection_id : String, story_id : Int32, content : InputStoryContent, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, areas : Array(StoryArea) | Nil = nil) : Story

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.

Returns: Story See: https://core.telegram.org/bots/api#editstory

Source
edit_user_star_subscription(user_id : Int32, telegram_payment_charge_id : String, is_canceled : Bool) : Bool

editUserStarSubscription Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#edituserstarsubscription

Source
export_chat_invite_link(chat_id : Int32 | String) : String

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.

Returns: String See: https://core.telegram.org/bots/api#exportchatinvitelink

Source
forward_message(chat_id : Int32 | String, from_chat_id : Int32 | String, message_id : Int32, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, video_start_timestamp : Int32 | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil) : Message

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.

Returns: Message See: https://core.telegram.org/bots/api#forwardmessage

Source
forward_messages(chat_id : Int32 | String, from_chat_id : Int32 | String, message_ids : Array(Int32), message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil) : Array(MessageId)

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.

Returns: Array(MessageId) See: https://core.telegram.org/bots/api#forwardmessages

Source
get_available_gifts

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 See: https://core.telegram.org/bots/api#getavailablegifts

Source
get_business_account_gifts(business_connection_id : String, exclude_unsaved : Bool | Nil = nil, exclude_saved : Bool | Nil = nil, exclude_unlimited : Bool | Nil = nil, exclude_limited : Bool | Nil = nil, exclude_unique : Bool | Nil = nil, sort_by_price : Bool | Nil = nil, offset : String | Nil = nil, limit : Int32 | Nil = nil) : OwnedGifts

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.

Returns: OwnedGifts See: https://core.telegram.org/bots/api#getbusinessaccountgifts

Source
get_business_account_star_balance(business_connection_id : String) : StarAmount

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.

Returns: StarAmount See: https://core.telegram.org/bots/api#getbusinessaccountstarbalance

Source
get_business_connection(business_connection_id : String) : BusinessConnection

getBusinessConnection Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Returns: BusinessConnection See: https://core.telegram.org/bots/api#getbusinessconnection

Source
get_chat(chat_id : Int32 | String) : ChatFullInfo

getChat Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.

Returns: ChatFullInfo See: https://core.telegram.org/bots/api#getchat

Source
get_chat_administrators(chat_id : Int32 | String) : Array(ChatMember)

getChatAdministrators Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

Returns: Array(ChatMember) See: https://core.telegram.org/bots/api#getchatadministrators

Source
get_chat_member(chat_id : Int32 | String, user_id : Int32) : ChatMember

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.

Returns: ChatMember See: https://core.telegram.org/bots/api#getchatmember

Source
get_chat_member_count(chat_id : Int32 | String) : Int32

getChatMemberCount Use this method to get the number of members in a chat. Returns Int on success.

Returns: Int32 See: https://core.telegram.org/bots/api#getchatmembercount

Source
get_chat_menu_button(chat_id : Int32 | Nil = nil) : MenuButton

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.

Returns: MenuButton See: https://core.telegram.org/bots/api#getchatmenubutton

Source
get_custom_emoji_stickers(custom_emoji_ids : Array(String)) : Array(Sticker)

getCustomEmojiStickers Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Returns: Array(Sticker) See: https://core.telegram.org/bots/api#getcustomemojistickers

Source
get_file(file_id : String) : TelegramFile

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. Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.

Returns: TelegramFile See: https://core.telegram.org/bots/api#getfile

Source
get_forum_topic_icon_stickers

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: Array(Sticker) See: https://core.telegram.org/bots/api#getforumtopiciconstickers

Source
get_game_high_scores(user_id : Int32, chat_id : Int32 | Nil = nil, message_id : Int32 | Nil = nil, inline_message_id : String | Nil = nil) : Array(GameHighScore)

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.

Returns: Array(GameHighScore) See: https://core.telegram.org/bots/api#getgamehighscores

Source
get_me

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 See: https://core.telegram.org/bots/api#getme

Source
get_my_commands(scope : BotCommandScope | Nil = nil, language_code : String | Nil = nil) : Array(BotCommand)

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.

Returns: Array(BotCommand) See: https://core.telegram.org/bots/api#getmycommands

Source
get_my_default_administrator_rights(for_channels : Bool | Nil = nil) : ChatAdministratorRights

getMyDefaultAdministratorRights Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Returns: ChatAdministratorRights See: https://core.telegram.org/bots/api#getmydefaultadministratorrights

Source
get_my_description(language_code : String | Nil = nil) : BotDescription

getMyDescription Use this method to get the current bot description for the given user language. Returns BotDescription on success.

Returns: BotDescription See: https://core.telegram.org/bots/api#getmydescription

Source
get_my_name(language_code : String | Nil = nil) : BotName

getMyName Use this method to get the current bot name for the given user language. Returns BotName on success.

Returns: BotName See: https://core.telegram.org/bots/api#getmyname

Source
get_my_short_description(language_code : String | Nil = nil) : BotShortDescription

getMyShortDescription Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

Returns: BotShortDescription See: https://core.telegram.org/bots/api#getmyshortdescription

Source
get_my_star_balance

getMyStarBalance A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

Returns: StarAmount See: https://core.telegram.org/bots/api#getmystarbalance

Source
get_star_transactions(offset : Int32 | Nil = nil, limit : Int32 | Nil = nil) : StarTransactions

getStarTransactions Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

Returns: StarTransactions See: https://core.telegram.org/bots/api#getstartransactions

Source
get_sticker_set(name : String) : StickerSet

getStickerSet Use this method to get a sticker set. On success, a StickerSet object is returned.

Returns: StickerSet See: https://core.telegram.org/bots/api#getstickerset

Source
get_updates(offset : Int32 | Nil = nil, limit : Int32 | Nil = nil, timeout : Int32 | Nil = nil, allowed_updates : Array(String) | Nil = nil) : Array(Update)

getUpdates Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Returns: Array(Update) See: https://core.telegram.org/bots/api#getupdates

Source
get_user_chat_boosts(chat_id : Int32 | String, user_id : Int32) : UserChatBoosts

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.

Returns: UserChatBoosts See: https://core.telegram.org/bots/api#getuserchatboosts

Source
get_user_profile_photos(user_id : Int32, offset : Int32 | Nil = nil, limit : Int32 | Nil = nil) : UserProfilePhotos

getUserProfilePhotos Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Returns: UserProfilePhotos See: https://core.telegram.org/bots/api#getuserprofilephotos

Source
get_webhook_info

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 See: https://core.telegram.org/bots/api#getwebhookinfo

Source
gift_premium_subscription(user_id : Int32, month_count : Int32, star_count : Int32, text : String | Nil = nil, text_parse_mode : String | Nil = nil, text_entities : Array(MessageEntity) | Nil = nil) : Bool

giftPremiumSubscription Gifts a Telegram Premium subscription to the given user. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#giftpremiumsubscription

Source
hide_general_forum_topic(chat_id : Int32 | String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#hidegeneralforumtopic

Source
http_config

HTTP client configuration

Source
http_config=(http_config : Telegram::HTTPClientConfig)

HTTP client configuration

Source
leave_chat(chat_id : Int32 | String) : Bool

leaveChat Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#leavechat

Source
log_out

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: Bool See: https://core.telegram.org/bots/api#logout

Source
pin_chat_message(chat_id : Int32 | String, message_id : Int32, business_connection_id : String | Nil = nil, disable_notification : Bool | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#pinchatmessage

Source
post_story(business_connection_id : String, content : InputStoryContent, active_period : Int32, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, areas : Array(StoryArea) | Nil = nil, post_to_chat_page : Bool | Nil = nil, protect_content : Bool | Nil = nil) : Story

postStory Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

Returns: Story See: https://core.telegram.org/bots/api#poststory

Source
promote_chat_member(chat_id : Int32 | String, user_id : Int32, is_anonymous : Bool | Nil = nil, can_manage_chat : Bool | Nil = nil, can_delete_messages : Bool | Nil = nil, can_manage_video_chats : Bool | Nil = nil, can_restrict_members : Bool | Nil = nil, can_promote_members : Bool | Nil = nil, can_change_info : Bool | Nil = nil, can_invite_users : Bool | Nil = nil, can_post_stories : Bool | Nil = nil, can_edit_stories : Bool | Nil = nil, can_delete_stories : Bool | Nil = nil, can_post_messages : Bool | Nil = nil, can_edit_messages : Bool | Nil = nil, can_pin_messages : Bool | Nil = nil, can_manage_topics : Bool | Nil = nil, can_manage_direct_messages : Bool | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#promotechatmember

Source
read_business_message(business_connection_id : String, chat_id : Int32, message_id : Int32) : Bool

readBusinessMessage Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#readbusinessmessage

Source
refund_star_payment(user_id : Int32, telegram_payment_charge_id : String) : Bool

refundStarPayment Refunds a successful payment in Telegram Stars. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#refundstarpayment

Source
remove_business_account_profile_photo(business_connection_id : String, is_public : Bool | Nil = nil) : Bool

removeBusinessAccountProfilePhoto Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#removebusinessaccountprofilephoto

Source
remove_chat_verification(chat_id : Int32 | String) : Bool

removeChatVerification Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#removechatverification

Source
remove_user_verification(user_id : Int32) : Bool

removeUserVerification Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#removeuserverification

Source
reopen_forum_topic(chat_id : Int32 | String, message_thread_id : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#reopenforumtopic

Source
reopen_general_forum_topic(chat_id : Int32 | String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#reopengeneralforumtopic

Source
replace_sticker_in_set(user_id : Int32, name : String, old_sticker : String, sticker : InputSticker) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#replacestickerinset

Source
restrict_chat_member(chat_id : Int32 | String, user_id : Int32, permissions : ChatPermissions, use_independent_chat_permissions : Bool | Nil = nil, until_date : Int32 | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#restrictchatmember

Source
revoke_chat_invite_link(chat_id : Int32 | String, invite_link : String) : ChatInviteLink

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.

Returns: ChatInviteLink See: https://core.telegram.org/bots/api#revokechatinvitelink

Source
save_prepared_inline_message(user_id : Int32, result : InlineQueryResult, allow_user_chats : Bool | Nil = nil, allow_bot_chats : Bool | Nil = nil, allow_group_chats : Bool | Nil = nil, allow_channel_chats : Bool | Nil = nil) : PreparedInlineMessage

savePreparedInlineMessage Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.

Returns: PreparedInlineMessage See: https://core.telegram.org/bots/api#savepreparedinlinemessage

Source
send_animation(chat_id : Int32 | String, animation : Telegram::InputFile | File | IO | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, duration : Int32 | Nil = nil, width : Int32 | Nil = nil, height : Int32 | Nil = nil, thumbnail : Telegram::InputFile | File | IO | String | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, show_caption_above_media : Bool | Nil = nil, has_spoiler : Bool | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

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.

Returns: Message See: https://core.telegram.org/bots/api#sendanimation

Source
send_audio(chat_id : Int32 | String, audio : Telegram::InputFile | File | IO | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, duration : Int32 | Nil = nil, performer : String | Nil = nil, title : String | Nil = nil, thumbnail : Telegram::InputFile | File | IO | String | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : 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.

Returns: Message See: https://core.telegram.org/bots/api#sendaudio

Source
send_chat_action(chat_id : Int32 | String, action : String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#sendchataction

Source
send_checklist(business_connection_id : String, chat_id : Int32, checklist : InputChecklist, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, message_effect_id : String | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : Message

sendChecklist Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendchecklist

Source
send_contact(chat_id : Int32 | String, phone_number : String, first_name : String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, last_name : String | Nil = nil, vcard : String | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendContact Use this method to send phone contacts. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendcontact

Source
send_dice(chat_id : Int32 | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, emoji : String | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendDice Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#senddice

Source
send_document(chat_id : Int32 | String, document : Telegram::InputFile | File | IO | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, thumbnail : Telegram::InputFile | File | IO | String | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, disable_content_type_detection : Bool | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : 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.

Returns: Message See: https://core.telegram.org/bots/api#senddocument

Source
send_game(chat_id : Int32, game_short_name : String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : Message

sendGame Use this method to send a game. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendgame

Source
send_gift(gift_id : String, user_id : Int32 | Nil = nil, chat_id : Int32 | String | Nil = nil, pay_for_upgrade : Bool | Nil = nil, text : String | Nil = nil, text_parse_mode : String | Nil = nil, text_entities : Array(MessageEntity) | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#sendgift

Source
send_invoice(chat_id : Int32 | String, title : String, description : String, payload : String, currency : String, prices : Array(LabeledPrice), message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, provider_token : String | Nil = nil, max_tip_amount : Int32 | Nil = nil, suggested_tip_amounts : Array(Int32) | Nil = nil, start_parameter : String | Nil = nil, provider_data : String | Nil = nil, photo_url : String | Nil = nil, photo_size : Int32 | Nil = nil, photo_width : Int32 | Nil = nil, photo_height : Int32 | Nil = nil, need_name : Bool | Nil = nil, need_phone_number : Bool | Nil = nil, need_email : Bool | Nil = nil, need_shipping_address : Bool | Nil = nil, send_phone_number_to_provider : Bool | Nil = nil, send_email_to_provider : Bool | Nil = nil, is_flexible : Bool | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : Message

sendInvoice Use this method to send invoices. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendinvoice

Source
send_location(chat_id : Int32 | String, latitude : Float64, longitude : Float64, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, horizontal_accuracy : Float64 | Nil = nil, live_period : Int32 | Nil = nil, heading : Int32 | Nil = nil, proximity_alert_radius : Int32 | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendLocation Use this method to send point on the map. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendlocation

Source
send_media_group(chat_id : Int32 | String, media : Array(InputMediaAudio) | Array(InputMediaDocument) | Array(InputMediaPhoto) | Array(InputMediaVideo), business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, reply_parameters : ReplyParameters | Nil = nil) : Array(Message)

sendMediaGroup Use this method to send a group of 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.

Returns: Array(Message) See: https://core.telegram.org/bots/api#sendmediagroup

Source
send_message(chat_id : Int32 | String, text : String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, parse_mode : String | Nil = nil, entities : Array(MessageEntity) | Nil = nil, link_preview_options : LinkPreviewOptions | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendMessage Use this method to send text messages. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendmessage

Source
send_paid_media(chat_id : Int32 | String, star_count : Int32, media : Array(InputPaidMedia), business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, payload : String | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, show_caption_above_media : Bool | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendPaidMedia Use this method to send paid media. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendpaidmedia

Source
send_photo(chat_id : Int32 | String, photo : Telegram::InputFile | File | IO | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, show_caption_above_media : Bool | Nil = nil, has_spoiler : Bool | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendPhoto Use this method to send photos. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendphoto

Source
send_poll(chat_id : Int32 | String, question : String, options : Array(InputPollOption), business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, question_parse_mode : String | Nil = nil, question_entities : Array(MessageEntity) | Nil = nil, is_anonymous : Bool | Nil = nil, type : String | Nil = nil, allows_multiple_answers : Bool | Nil = nil, correct_option_id : Int32 | Nil = nil, explanation : String | Nil = nil, explanation_parse_mode : String | Nil = nil, explanation_entities : Array(MessageEntity) | Nil = nil, open_period : Int32 | Nil = nil, close_date : Int32 | Nil = nil, is_closed : Bool | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendPoll Use this method to send a native poll. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendpoll

Source
send_sticker(chat_id : Int32 | String, sticker : Telegram::InputFile | File | IO | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, emoji : String | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendSticker Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendsticker

Source
send_venue(chat_id : Int32 | String, latitude : Float64, longitude : Float64, title : String, address : String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, foursquare_id : String | Nil = nil, foursquare_type : String | Nil = nil, google_place_id : String | Nil = nil, google_place_type : String | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : Message

sendVenue Use this method to send information about a venue. On success, the sent Message is returned.

Returns: Message See: https://core.telegram.org/bots/api#sendvenue

Source
send_video(chat_id : Int32 | String, video : Telegram::InputFile | File | IO | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, duration : Int32 | Nil = nil, width : Int32 | Nil = nil, height : Int32 | Nil = nil, thumbnail : Telegram::InputFile | File | IO | String | Nil = nil, cover : Telegram::InputFile | File | IO | String | Nil = nil, start_timestamp : Int32 | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, show_caption_above_media : Bool | Nil = nil, has_spoiler : Bool | Nil = nil, supports_streaming : Bool | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : 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.

Returns: Message See: https://core.telegram.org/bots/api#sendvideo

Source
send_video_note(chat_id : Int32 | String, video_note : Telegram::InputFile | File | IO | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, duration : Int32 | Nil = nil, length : Int32 | Nil = nil, thumbnail : Telegram::InputFile | File | IO | String | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : 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.

Returns: Message See: https://core.telegram.org/bots/api#sendvideonote

Source
send_voice(chat_id : Int32 | String, voice : Telegram::InputFile | File | IO | String, business_connection_id : String | Nil = nil, message_thread_id : Int32 | Nil = nil, direct_messages_topic_id : Int32 | Nil = nil, caption : String | Nil = nil, parse_mode : String | Nil = nil, caption_entities : Array(MessageEntity) | Nil = nil, duration : Int32 | Nil = nil, disable_notification : Bool | Nil = nil, protect_content : Bool | Nil = nil, allow_paid_broadcast : Bool | Nil = nil, message_effect_id : String | Nil = nil, suggested_post_parameters : SuggestedPostParameters | Nil = nil, reply_parameters : ReplyParameters | Nil = nil, reply_markup : InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Nil = nil) : 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.

Returns: Message See: https://core.telegram.org/bots/api#sendvoice

Source
set_business_account_bio(business_connection_id : String, bio : String | Nil = nil) : Bool

setBusinessAccountBio Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setbusinessaccountbio

Source
set_business_account_gift_settings(business_connection_id : String, show_gift_button : Bool, accepted_gift_types : AcceptedGiftTypes) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setbusinessaccountgiftsettings

Source
set_business_account_name(business_connection_id : String, first_name : String, last_name : String | Nil = nil) : Bool

setBusinessAccountName Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setbusinessaccountname

Source
set_business_account_profile_photo(business_connection_id : String, photo : InputProfilePhoto, is_public : Bool | Nil = nil) : Bool

setBusinessAccountProfilePhoto Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setbusinessaccountprofilephoto

Source
set_business_account_username(business_connection_id : String, username : String | Nil = nil) : Bool

setBusinessAccountUsername Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setbusinessaccountusername

Source
set_chat_administrator_custom_title(chat_id : Int32 | String, user_id : Int32, custom_title : String) : Bool

setChatAdministratorCustomTitle Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setchatadministratorcustomtitle

Source
set_chat_description(chat_id : Int32 | String, description : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setchatdescription

Source
set_chat_menu_button(chat_id : Int32 | Nil = nil, menu_button : MenuButton | Nil = nil) : Bool

setChatMenuButton Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setchatmenubutton

Source
set_chat_permissions(chat_id : Int32 | String, permissions : ChatPermissions, use_independent_chat_permissions : Bool | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setchatpermissions

Source
set_chat_photo(chat_id : Int32 | String, photo : Telegram::InputFile | File | IO) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setchatphoto

Source
set_chat_sticker_set(chat_id : Int32 | String, sticker_set_name : String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setchatstickerset

Source
set_chat_title(chat_id : Int32 | String, title : String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setchattitle

Source
set_custom_emoji_sticker_set_thumbnail(name : String, custom_emoji_id : String | Nil = nil) : Bool

setCustomEmojiStickerSetThumbnail Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail

Source
set_game_score(user_id : Int32, score : Int32, force : Bool | Nil = nil, disable_edit_message : Bool | Nil = nil, chat_id : Int32 | Nil = nil, message_id : Int32 | Nil = nil, inline_message_id : String | Nil = nil) : JSON::Any

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.

Returns: JSON::Any See: https://core.telegram.org/bots/api#setgamescore

Source
set_message_reaction(chat_id : Int32 | String, message_id : Int32, reaction : Array(ReactionType) | Nil = nil, is_big : Bool | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setmessagereaction

Source
set_my_commands(commands : Array(BotCommand), scope : BotCommandScope | Nil = nil, language_code : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setmycommands

Source
set_my_default_administrator_rights(rights : ChatAdministratorRights | Nil = nil, for_channels : Bool | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setmydefaultadministratorrights

Source
set_my_description(description : String | Nil = nil, language_code : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setmydescription

Source
set_my_name(name : String | Nil = nil, language_code : String | Nil = nil) : Bool

setMyName Use this method to change the bot's name. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setmyname

Source
set_my_short_description(short_description : String | Nil = nil, language_code : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setmyshortdescription

Source
set_passport_data_errors(user_id : Int32, errors : Array(PassportElementError)) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setpassportdataerrors

Source
set_sticker_emoji_list(sticker : String, emoji_list : Array(String)) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setstickeremojilist

Source
set_sticker_keywords(sticker : String, keywords : Array(String) | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setstickerkeywords

Source
set_sticker_mask_position(sticker : String, mask_position : MaskPosition | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setstickermaskposition

Source
set_sticker_position_in_set(sticker : String, position : Int32) : Bool

setStickerPositionInSet Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setstickerpositioninset

Source
set_sticker_set_thumbnail(name : String, user_id : Int32, format : String, thumbnail : Telegram::InputFile | File | IO | String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setstickersetthumbnail

Source
set_sticker_set_title(name : String, title : String) : Bool

setStickerSetTitle Use this method to set the title of a created sticker set. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#setstickersettitle

Source
set_user_emoji_status(user_id : Int32, emoji_status_custom_emoji_id : String | Nil = nil, emoji_status_expiration_date : Int32 | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setuseremojistatus

Source
set_webhook(url : String, certificate : Telegram::InputFile | File | IO | Nil = nil, ip_address : String | Nil = nil, max_connections : Int32 | Nil = nil, allowed_updates : Array(String) | Nil = nil, drop_pending_updates : Bool | Nil = nil, secret_token : String | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#setwebhook

Source
stop_message_live_location(business_connection_id : String | Nil = nil, chat_id : Int32 | String | Nil = nil, message_id : Int32 | Nil = nil, inline_message_id : String | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : JSON::Any

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.

Returns: JSON::Any See: https://core.telegram.org/bots/api#stopmessagelivelocation

Source
stop_poll(chat_id : Int32 | String, message_id : Int32, business_connection_id : String | Nil = nil, reply_markup : InlineKeyboardMarkup | Nil = nil) : Poll

stopPoll Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

Returns: Poll See: https://core.telegram.org/bots/api#stoppoll

Source
token

Bot token from @BotFather

Source
token=(token : String)

Bot token from @BotFather

Source
transfer_business_account_stars(business_connection_id : String, star_count : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#transferbusinessaccountstars

Source
transfer_gift(business_connection_id : String, owned_gift_id : String, new_owner_chat_id : Int32, star_count : Int32 | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#transfergift

Source
unban_chat_member(chat_id : Int32 | String, user_id : Int32, only_if_banned : Bool | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#unbanchatmember

Source
unban_chat_sender_chat(chat_id : Int32 | String, sender_chat_id : Int32) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#unbanchatsenderchat

Source
unhide_general_forum_topic(chat_id : Int32 | String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#unhidegeneralforumtopic

Source
unpin_all_chat_messages(chat_id : Int32 | String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#unpinallchatmessages

Source
unpin_all_forum_topic_messages(chat_id : Int32 | String, message_thread_id : Int32) : Bool

unpinAllForumTopicMessages Use this method to clear the list of pinned messages in a 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.

Returns: Bool See: https://core.telegram.org/bots/api#unpinallforumtopicmessages

Source
unpin_all_general_forum_topic_messages(chat_id : Int32 | String) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages

Source
unpin_chat_message(chat_id : Int32 | String, business_connection_id : String | Nil = nil, message_id : Int32 | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#unpinchatmessage

Source
upgrade_gift(business_connection_id : String, owned_gift_id : String, keep_original_details : Bool | Nil = nil, star_count : Int32 | Nil = nil) : Bool

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.

Returns: Bool See: https://core.telegram.org/bots/api#upgradegift

Source
upload_sticker_file(user_id : Int32, sticker : Telegram::InputFile | File | IO, sticker_format : String) : TelegramFile

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.

Returns: TelegramFile See: https://core.telegram.org/bots/api#uploadstickerfile

Source
verify_chat(chat_id : Int32 | String, custom_description : String | Nil = nil) : Bool

verifyChat Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#verifychat

Source
verify_user(user_id : Int32, custom_description : String | Nil = nil) : Bool

verifyUser Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.

Returns: Bool See: https://core.telegram.org/bots/api#verifyuser

Source