Methods

• getUpdates
• setWebhook
• sendMessage
• forwardMessage
• sendPhoto
• sendAudio
• sendDocument
• sendVideo
• sendVoice
• sendVideoNote
• sendMediaGroup
• sendLocation
• editMessageLiveLocation
• stopMessageLiveLocation
• sendVenue
• sendContact
• getUserProfilePhotos
• getFile
• kickChatMember
• unbanChatMember
• restrictChatMember
• promoteChatMember
• exportChatInviteLink
• setChatPhoto
• deleteChatPhoto
• setChatTitle
• setChatDescription
• pinChatMessage
• unpinChatMessage
• leaveChat
• getChat
• getChatAdministrators
• getChatMembersCount
• getChatMember
• setChatStickerSet
• deleteChatStickerSet
• answerCallbackQuery
• editMessageText
• editMessageCaption
• editMessageReplyMarkup
• deleteMessage
• sendSticker
• getStickerSet
• uploadStickerFile
• createNewStickerSet
• addStickerToSet
• setStickerPositionInSet
• deleteStickerFromSet
• answerInlineQuery
• sendInvoice
• answerShippingQuery
• answerPreCheckoutQuery
• sendGame
• setGameScore
• getGameHighScores

getUpdates

Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.

Example:

getUpdates({
    offset = Integer,
    limit = Integer,
    timeout = Integer,
    allowed_updates = Array of String,
})

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, we will give up after a reasonable amount of attempts. Returns True on success.

Example:

setWebhook({
    url = String,
    certificate = InputFile,
    max_connections = Integer,
    allowed_updates = Array of String,
})

sendMessage

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

Example:

sendMessage({
    chat_id = Integer or String,
    text = String,
    parse_mode = String,
    disable_web_page_preview = Boolean,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

forwardMessage

Use this method to forward messages of any kind. On success, the sent Message is returned.

Example:

forwardMessage({
    chat_id = Integer or String,
    from_chat_id = Integer or String,
    disable_notification = Boolean,
    message_id = Integer,
})

sendPhoto

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

Example:

sendPhoto({
    chat_id = Integer or String,
    photo = InputFile or String,
    caption = String,
    parse_mode = String,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

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 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.

Example:

sendAudio({
    chat_id = Integer or String,
    audio = InputFile or String,
    caption = String,
    parse_mode = String,
    duration = Integer,
    performer = String,
    title = String,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

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.

Example:

sendDocument({
    chat_id = Integer or String,
    document = InputFile or String,
    caption = String,
    parse_mode = String,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

sendVideo

Use this method to send video files, Telegram clients support mp4 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.

Example:

sendVideo({
    chat_id = Integer or String,
    video = InputFile or String,
    duration = Integer,
    width = Integer,
    height = Integer,
    caption = String,
    parse_mode = String,
    supports_streaming = Boolean,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

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 (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.

Example:

sendVoice({
    chat_id = Integer or String,
    voice = InputFile or String,
    caption = String,
    parse_mode = String,
    duration = Integer,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

sendVideoNote

As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

Example:

sendVideoNote({
    chat_id = Integer or String,
    video_note = InputFile or String,
    duration = Integer,
    length = Integer,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

sendMediaGroup

Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned.

Example:

sendMediaGroup({
    chat_id = Integer or String,
    media = Array of InputMedia,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
})

sendLocation

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

Example:

sendLocation({
    chat_id = Integer or String,
    latitude = Float number,
    longitude = Float number,
    live_period = Integer,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

editMessageLiveLocation

Use this method to edit live location messages sent by the bot or via the bot (for inline bots). 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 was sent by the bot, the edited Message is returned, otherwise True is returned.

Example:

editMessageLiveLocation({
    chat_id = Integer or String,
    message_id = Integer,
    inline_message_id = String,
    latitude = Float number,
    longitude = Float number,
    reply_markup = InlineKeyboardMarkup,
})

stopMessageLiveLocation

Use this method to stop updating a live location message sent by the bot or via the bot (for inline bots) before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.

Example:

stopMessageLiveLocation({
    chat_id = Integer or String,
    message_id = Integer,
    inline_message_id = String,
    reply_markup = InlineKeyboardMarkup,
})

sendVenue

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

Example:

sendVenue({
    chat_id = Integer or String,
    latitude = Float number,
    longitude = Float number,
    title = String,
    address = String,
    foursquare_id = String,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

sendContact

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

Example:

sendContact({
    chat_id = Integer or String,
    phone_number = String,
    first_name = String,
    last_name = String,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

getUserProfilePhotos

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

Example:

getUserProfilePhotos({
    user_id = Integer,
    offset = Integer,
    limit = Integer,
})

getFile

Use this method to get basic info 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/, where 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.

Example:

getFile({
    file_id = String,
})

kickChatMember

Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group 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 admin rights. Returns True on success.

Example:

kickChatMember({
    chat_id = Integer or String,
    user_id = Integer,
    until_date = Integer,
})

unbanChatMember

Use this method to unban a previously kicked 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. Returns True on success.

Example:

unbanChatMember({
    chat_id = Integer or String,
    user_id = Integer,
})

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 admin rights. Pass True for all boolean parameters to lift restrictions from a user. Returns True on success.

Example:

restrictChatMember({
    chat_id = Integer or String,
    user_id = Integer,
    until_date = Integer,
    can_send_messages = Boolean,
    can_send_media_messages = Boolean,
    can_send_other_messages = Boolean,
    can_add_web_page_previews = Boolean,
})

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 admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Example:

promoteChatMember({
    chat_id = Integer or String,
    user_id = Integer,
    can_change_info = Boolean,
    can_post_messages = Boolean,
    can_edit_messages = Boolean,
    can_delete_messages = Boolean,
    can_invite_users = Boolean,
    can_restrict_members = Boolean,
    can_pin_messages = Boolean,
    can_promote_members = Boolean,
})

exportChatInviteLink

Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.

Example:

exportChatInviteLink({
    chat_id = Integer or String,
})

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 admin rights. Returns True on success.

Example:

setChatPhoto({
    chat_id = Integer or String,
    photo = InputFile,
})

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 admin rights. Returns True on success.

Example:

deleteChatPhoto({
    chat_id = Integer or String,
})

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 admin rights. Returns True on success.

Example:

setChatTitle({
    chat_id = Integer or String,
    title = String,
})

setChatDescription

Use this method to change the description of a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Example:

setChatDescription({
    chat_id = Integer or String,
    description = String,
})

pinChatMessage

Use this method to pin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.

Example:

pinChatMessage({
    chat_id = Integer or String,
    message_id = Integer,
    disable_notification = Boolean,
})

unpinChatMessage

Use this method to unpin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.

Example:

unpinChatMessage({
    chat_id = Integer or String,
})

leaveChat

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

Example:

leaveChat({
    chat_id = Integer or String,
})

getChat

Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.

Example:

getChat({
    chat_id = Integer or String,
})

getChatAdministrators

Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

Example:

getChatAdministrators({
    chat_id = Integer or String,
})

getChatMembersCount

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

Example:

getChatMembersCount({
    chat_id = Integer or String,
})

getChatMember

Use this method to get information about a member of a chat. Returns a ChatMember object on success.

Example:

getChatMember({
    chat_id = Integer or String,
    user_id = Integer,
})

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 admin 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.

Example:

setChatStickerSet({
    chat_id = Integer or String,
    sticker_set_name = String,
})

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 admin 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.

Example:

deleteChatStickerSet({
    chat_id = Integer or String,
})

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.

Example:

answerCallbackQuery({
    callback_query_id = String,
    text = String,
    show_alert = Boolean,
    url = String,
    cache_time = Integer,
})

editMessageText

Use this method to edit text and game messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

Example:

editMessageText({
    chat_id = Integer or String,
    message_id = Integer,
    inline_message_id = String,
    text = String,
    parse_mode = String,
    disable_web_page_preview = Boolean,
    reply_markup = InlineKeyboardMarkup,
})

editMessageCaption

Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

Example:

editMessageCaption({
    chat_id = Integer or String,
    message_id = Integer,
    inline_message_id = String,
    caption = String,
    parse_mode = String,
    reply_markup = InlineKeyboardMarkup,
})

editMessageReplyMarkup

Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

Example:

editMessageReplyMarkup({
    chat_id = Integer or String,
    message_id = Integer,
    inline_message_id = String,
    reply_markup = InlineKeyboardMarkup,
})

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.- Bots can delete outgoing messages in groups and supergroups.- 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 permission in a supergroup or a channel, it can delete any message there.Returns True on success.

Example:

deleteMessage({
    chat_id = Integer or String,
    message_id = Integer,
})

sendSticker

Use this method to send .webp stickers. On success, the sent Message is returned.

Example:

sendSticker({
    chat_id = Integer or String,
    sticker = InputFile or String,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply,
})

getStickerSet

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

Example:

getStickerSet({
    name = String,
})

uploadStickerFile

Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.

Example:

uploadStickerFile({
    user_id = Integer,
    png_sticker = InputFile,
})

createNewStickerSet

Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. Returns True on success.

Example:

createNewStickerSet({
    user_id = Integer,
    name = String,
    title = String,
    png_sticker = InputFile or String,
    emojis = String,
    contains_masks = Boolean,
    mask_position = MaskPosition,
})

addStickerToSet

Use this method to add a new sticker to a set created by the bot. Returns True on success.

Example:

addStickerToSet({
    user_id = Integer,
    name = String,
    png_sticker = InputFile or String,
    emojis = String,
    mask_position = MaskPosition,
})

setStickerPositionInSet

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

Example:

setStickerPositionInSet({
    sticker = String,
    position = Integer,
})

deleteStickerFromSet

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

Example:

deleteStickerFromSet({
    sticker = String,
})

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.

Example:

answerInlineQuery({
    inline_query_id = String,
    results = Array of InlineQueryResult,
    cache_time = Integer,
    is_personal = Boolean,
    next_offset = String,
    switch_pm_text = String,
    switch_pm_parameter = String,
})

sendInvoice

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

Example:

sendInvoice({
    chat_id = Integer,
    title = String,
    description = String,
    payload = String,
    provider_token = String,
    start_parameter = String,
    currency = String,
    prices = Array of LabeledPrice,
    provider_data = String,
    photo_url = String,
    photo_size = Integer,
    photo_width = Integer,
    photo_height = Integer,
    need_name = Boolean,
    need_phone_number = Boolean,
    need_email = Boolean,
    need_shipping_address = Boolean,
    send_phone_number_to_provider = Boolean,
    send_email_to_provider = Boolean,
    is_flexible = Boolean,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup,
})

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.

Example:

answerShippingQuery({
    shipping_query_id = String,
    ok = Boolean,
    shipping_options = Array of ShippingOption,
    error_message = String,
})

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.

Example:

answerPreCheckoutQuery({
    pre_checkout_query_id = String,
    ok = Boolean,
    error_message = String,
})

sendGame

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

Example:

sendGame({
    chat_id = Integer,
    game_short_name = String,
    disable_notification = Boolean,
    reply_to_message_id = Integer,
    reply_markup = InlineKeyboardMarkup,
})

setGameScore

Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Example:

setGameScore({
    user_id = Integer,
    score = Integer,
    force = Boolean,
    disable_edit_message = Boolean,
    chat_id = Integer,
    message_id = Integer,
    inline_message_id = String,
})

getGameHighScores

Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects.

Example:

getGameHighScores({
    user_id = Integer,
    chat_id = Integer,
    message_id = Integer,
    inline_message_id = String,
})