Skip to content

methods.md

Latest commit

 

History

History
1333 lines (1057 loc) · 138 KB

methods.md

File metadata and controls

1333 lines (1057 loc) · 138 KB

Métodos

getUpdates

Use este método para receber atualizações através de consulta diretas (pooling). Uma Array (Matriz) de objetos é retornado com o "Update".

Campo Tipo Requerido Descrição
offset Integer (Número) false (Falso) Identificador da primeira atualização a ser retornado. Must be greater by one than the highest among the identifiers of previously received updates. Por padrão, as atualizações começando com a mais recente atualização não linda pelo bot, elas são retornados. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. O offset negativo pode ser especificado para recuperar Updates Iniciando em -offset a partir do final da fila de atualizações. Todas as atualizações anteriores serão esquecidas.
limit Integer (Número) false (Falso) Limita o número de atualizações a serem retornadas. Valores entre 1-100 são aceitos. Padrão é 100.
timeout Integer (Número) false (Falso) Tempo limite em segundos para a polling. O padrão é 0, exemplo habitual de consulta curta. Should be positive, short polling should be used for testing purposes only.
allowed_updates Array de String false (Falso) Lista os tipos de atualizações que você deseja que o seu bot para receba. Por exemplo, especifique [“message”, “edited_channel_post”, “callback_query”] para receber apenas as atualizações desses tipos. Consulte o Update para obter uma lista completa dos tipos de atualização. Especifique uma lista vazia para receber todas as atualizações independentemente do tipo (padrão). Se não especificado, a configuração antiga será usada. Note que esse parâmetro não afeta updates criados antes da chamada do getUpdates, portanto updates indesejados podem ser recebidos por um breve período.

Exemplo:

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.

Campo Tipo Requerido Descrição
url String (Sequência de caracteres) true (Verdadeiro) HTTPS Url para enviar atualizações. Use uma string vazia para remover a integração do webhook
certificate InputFile false (Falso) Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.
max_connections Integer (Número) false (Falso) Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Padrão é 40. Use lower values to limit the load on your bot‘s server, and higher values to increase your bot’s throughput.
allowed_updates Array de String false (Falso) Lista os tipos de atualizações que você deseja que o seu bot para receba. Por exemplo, especifique [“message”, “edited_channel_post”, “callback_query”] para receber apenas as atualizações desses tipos. Consulte o Update para obter uma lista completa dos tipos de atualização. Especifique uma lista vazia para receber todas as atualizações independentemente do tipo (padrão). Se não especificado, a configuração antiga será usada. Note que esse parâmetro não afeta updates criados antes da chamada do setWebhook, portanto updates indesejados podem ser recebidos por um breve período.

Exemplo:

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

sendMessage

Use este método para enviar mensagens de texto. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
text String (Sequência de caracteres) true (Verdadeiro) Text of the message to be sent
parse_mode String (Sequência de caracteres) false (Falso) Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disable_web_page_preview Boolen (Boleano) false (Falso) Disables link previews for links in this message
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
from_chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
message_id Integer (Número) true (Verdadeiro) Message identifier in the chat specified in from_chat_id

Exemplo:

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

sendPhoto

Use este método para enviar fotos. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
photo InputFile ou String (Sequência de caracteres) true (Verdadeiro) Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. More info on Sending Files »
caption String (Sequência de caracteres) false (Falso) Photo caption (may also be used when resending photos by file_id), 0-200 characters
parse_mode String (Sequência de caracteres) false (Falso) "Markdown" ou "HTML", se você quiser que os aplicativos mostrem formatação na legenda do GIF.
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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. Em caso de sucesso, a mensagem enviada será retornada. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
audio InputFile ou String (Sequência de caracteres) true (Verdadeiro) Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »
caption String (Sequência de caracteres) false (Falso) Audio caption, 0-200 characters
parse_mode String (Sequência de caracteres) false (Falso) "Markdown" ou "HTML", se você quiser que os aplicativos mostrem formatação na legenda da foto.
duration Integer (Número) false (Falso) Duration of the audio in seconds
performer String (Sequência de caracteres) false (Falso) Artista
title String (Sequência de caracteres) false (Falso) Nome da faixa
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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. Em caso de sucesso, a mensagem enviada será retornada. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
document InputFile ou String (Sequência de caracteres) true (Verdadeiro) File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »
caption String (Sequência de caracteres) false (Falso) Document caption (may also be used when resending documents by file_id), 0-200 characters
parse_mode String (Sequência de caracteres) false (Falso) "Markdown" ou "HTML", se você quiser que os aplicativos mostrem formatação na legenda do GIF.
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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). Em caso de sucesso, a mensagem enviada será retornada. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
video InputFile ou String (Sequência de caracteres) true (Verdadeiro) Vídeo para enviar. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More info on Sending Files »
duration Integer (Número) false (Falso) Duração do vídeo enviado em segundos
width Integer (Número) false (Falso) Largura do vídeo
height Integer (Número) false (Falso) Altura do vídeo
caption String (Sequência de caracteres) false (Falso) Video caption (may also be used when resending videos by file_id), 0-200 characters
parse_mode String (Sequência de caracteres) false (Falso) "Markdown" ou "HTML", se você quiser que os aplicativos mostrem formatação na legenda da foto.
supports_streaming Boolen (Boleano) false (Falso) Pass True, if the uploaded video is suitable for streaming
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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). Em caso de sucesso, a mensagem enviada será retornada. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
voice InputFile ou String (Sequência de caracteres) true (Verdadeiro) Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »
caption String (Sequência de caracteres) false (Falso) Voice message caption, 0-200 characters
parse_mode String (Sequência de caracteres) false (Falso) "Markdown" ou "HTML", se você quiser que os aplicativos mostrem formatação na legenda da foto.
duration Integer (Número) false (Falso) Duration of the voice message in seconds
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
video_note InputFile ou String (Sequência de caracteres) true (Verdadeiro) Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More info on Sending Files ». Sending video notes by a URL is currently unsupported
duration Integer (Número) false (Falso) Duração do vídeo enviado em segundos
lenght Integer (Número) false (Falso) Video width and height
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
media Array of InputMedia true (Verdadeiro) A JSON-serialized array describing photos and videos to be sent, must include 2–10 items
disable_notification Boolen (Boleano) false (Falso) Sends the messages silently. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the messages are a reply, ID of the original message

Exemplo:

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

sendLocation

Use este método para enviar um ponto de localização no mapa. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
latitude Float número true (Verdadeiro) Latitude of the location
longitude Float número true (Verdadeiro) Longitude of the location
live_period Integer (Número) false (Falso) Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) false (Falso) Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Identifier of the sent message
inline_message_id String (Sequência de caracteres) false (Falso) Required if chat_id and message_id are not specified. Identifier of the inline message
latitude Float número true (Verdadeiro) Latitude of new location
longitude Float número true (Verdadeiro) Longitude of new location
reply_markup InlineKeyboardMarkup false (Falso) A JSON-serialized object for a new inline keyboard.

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) false (Falso) Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Identifier of the sent message
inline_message_id String (Sequência de caracteres) false (Falso) Required if chat_id and message_id are not specified. Identifier of the inline message
reply_markup InlineKeyboardMarkup false (Falso) A JSON-serialized object for a new inline keyboard.

Exemplo:

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

sendVenue

Use this method to send information about a venue. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
latitude Float número true (Verdadeiro) Latitude of the venue
longitude Float número true (Verdadeiro) Longitude of the venue
title String (Sequência de caracteres) true (Verdadeiro) Name of the venue
address String (Sequência de caracteres) true (Verdadeiro) Endereço do local
foursquare_id String (Sequência de caracteres) false (Falso) Foursquare identifier of the venue
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
phone_number String (Sequência de caracteres) true (Verdadeiro) Número de telefone do contato
first_name String (Sequência de caracteres) true (Verdadeiro) Primeiro nome do contato
last_name String (Sequência de caracteres) false (Falso) Último nome do contato
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user.

Exemplo:

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.

Campo Tipo Requerido Descrição
user_id Integer (Número) true (Verdadeiro) Unique identifier of the target user
offset Integer (Número) false (Falso) Sequential number of the first photo to be returned. By default, all photos are returned.
limit Integer (Número) false (Falso) Limits the number of photos to be retrieved. Valores entre 1-100 são aceitos. Padrão é 100.

Exemplo:

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

Campo Tipo Requerido Descrição
file_id String (Sequência de caracteres) true (Verdadeiro) File identifier to get info about

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
user_id Integer (Número) true (Verdadeiro) Unique identifier of the target user
until_date Integer (Número) false (Falso) Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target group or username of the target supergroup or channel (in the format @username)
user_id Integer (Número) true (Verdadeiro) Unique identifier of the target user

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
user_id Integer (Número) true (Verdadeiro) Unique identifier of the target user
until_date Integer (Número) false (Falso) Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever
can_send_messages Boolen (Boleano) false (Falso) Pass True, if the user can send text messages, contacts, locations and venues
can_send_media_messages Boolen (Boleano) false (Falso) Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages
can_send_other_messages Boolen (Boleano) false (Falso) Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages
can_add_web_page_previews Boolen (Boleano) false (Falso) Pass True, if the user may add web page previews to their messages, implies can_send_media_messages

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
user_id Integer (Número) true (Verdadeiro) Unique identifier of the target user
can_change_info Boolen (Boleano) false (Falso) Pass True, if the administrator can change chat title, photo and other settings
can_post_messages Boolen (Boleano) false (Falso) Pass True, if the administrator can create channel posts, channels only
can_edit_messages Boolen (Boleano) false (Falso) Pass True, if the administrator can edit messages of other users and can pin messages, channels only
can_delete_messages Boolen (Boleano) false (Falso) Pass True, if the administrator can delete messages of other users
can_invite_users Boolen (Boleano) false (Falso) Pass True, if the administrator can invite new users to the chat
can_restrict_members Boolen (Boleano) false (Falso) Pass True, if the administrator can restrict, ban or unban chat members
can_pin_messages Boolen (Boleano) false (Falso) Pass True, if the administrator can pin messages, supergroups only
can_promote_members Boolen (Boleano) false (Falso) Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
photo InputFile true (Verdadeiro) New chat photo, uploaded using multipart/form-data

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
title String (Sequência de caracteres) true (Verdadeiro) New chat title, 1-255 characters

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
description String (Sequência de caracteres) false (Falso) Nova descrição do chat, 0-255 caracteres

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Integer (Número) true (Verdadeiro) Identificador de uma mensagem fixada
disable_notification Boolen (Boleano) false (Falso) Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels.

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Exemplo:

unpinChatMessage({
    chat_id = Integer or String,
})

leaveChat

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

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

Exemplo:

getChatAdministrators({
    chat_id = Integer or String,
})

getChatMembersCount

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

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)
user_id Integer (Número) true (Verdadeiro) Unique identifier of the target user

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
sticker_set_name String (Sequência de caracteres) true (Verdadeiro) Name of the sticker set to be set as the group sticker set

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

Exemplo:

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.

Campo Tipo Requerido Descrição
callback_query_id String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the query to be answered
text String (Sequência de caracteres) false (Falso) Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
show_alert Boolen (Boleano) false (Falso) If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
url String (Sequência de caracteres) false (Falso) URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game – note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
cache_time Integer (Número) false (Falso) The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Padrão é 0.

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) false (Falso) Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Identifier of the sent message
inline_message_id String (Sequência de caracteres) false (Falso) Required if chat_id and message_id are not specified. Identifier of the inline message
text String (Sequência de caracteres) true (Verdadeiro) New text of the message
parse_mode String (Sequência de caracteres) false (Falso) Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disable_web_page_preview Boolen (Boleano) false (Falso) Disables link previews for links in this message
reply_markup InlineKeyboardMarkup false (Falso) A JSON-serialized object for an inline keyboard.

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) false (Falso) Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Identifier of the sent message
inline_message_id String (Sequência de caracteres) false (Falso) Required if chat_id and message_id are not specified. Identifier of the inline message
caption String (Sequência de caracteres) false (Falso) New caption of the message
parse_mode String (Sequência de caracteres) false (Falso) "Markdown" ou "HTML", se você quiser que os aplicativos mostrem formatação na legenda do GIF.
reply_markup InlineKeyboardMarkup false (Falso) A JSON-serialized object for an inline keyboard.

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) false (Falso) Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Identifier of the sent message
inline_message_id String (Sequência de caracteres) false (Falso) Required if chat_id and message_id are not specified. Identifier of the inline message
reply_markup InlineKeyboardMarkup false (Falso) A JSON-serialized object for an inline keyboard.

Exemplo:

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.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Integer (Número) true (Verdadeiro) Identifier of the message to delete

Exemplo:

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

sendSticker

Use this method to send .webp stickers. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Interger (Número) ou String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sticker InputFile ou String (Sequência de caracteres) true (Verdadeiro) Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .webp file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply false (Falso) Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Exemplo:

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.

Campo Tipo Requerido Descrição
name String (Sequência de caracteres) true (Verdadeiro) Name of the sticker set

Exemplo:

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.

Campo Tipo Requerido Descrição
user_id Integer (Número) true (Verdadeiro) User identifier of sticker file owner
png_sticker InputFile true (Verdadeiro) Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More info on Sending Files »

Exemplo:

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.

Campo Tipo Requerido Descrição
user_id Integer (Número) true (Verdadeiro) User identifier of created sticker set owner
name String (Sequência de caracteres) true (Verdadeiro) Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “by<bot username>”. <bot_username> is case insensitive. 1-64 characters.
title String (Sequência de caracteres) true (Verdadeiro) Sticker set title, 1-64 characters
png_sticker InputFile ou String (Sequência de caracteres) true (Verdadeiro) Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »
emojis String (Sequência de caracteres) true (Verdadeiro) One or more emoji corresponding to the sticker
contains_masks Boolen (Boleano) false (Falso) Pass True, if a set of mask stickers should be created
mask_position MaskPosition false (Falso) A JSON-serialized object for position where the mask should be placed on faces

Exemplo:

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.

Campo Tipo Requerido Descrição
user_id Integer (Número) true (Verdadeiro) User identifier of sticker set owner
name String (Sequência de caracteres) true (Verdadeiro) Sticker set name
png_sticker InputFile ou String (Sequência de caracteres) true (Verdadeiro) Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »
emojis String (Sequência de caracteres) true (Verdadeiro) One or more emoji corresponding to the sticker
mask_position MaskPosition false (Falso) A JSON-serialized object for position where the mask should be placed on faces

Exemplo:

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.

Campo Tipo Requerido Descrição
sticker String (Sequência de caracteres) true (Verdadeiro) File identifier of the sticker
position Integer (Número) true (Verdadeiro) New sticker position in the set, zero-based

Exemplo:

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

deleteStickerFromSet

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

Campo Tipo Requerido Descrição
sticker String (Sequência de caracteres) true (Verdadeiro) File identifier of the sticker

Exemplo:

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.

Campo Tipo Requerido Descrição
inline_query_id String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the answered query
results Array of InlineQueryResult true (Verdadeiro) A JSON-serialized array of results for the inline query
cache_time Integer (Número) false (Falso) The maximum amount of time in seconds that the result of the inline query may be cached on the server. Padrão é 300.
is_personal Boolen (Boleano) false (Falso) Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query
next_offset String (Sequência de caracteres) false (Falso) Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.
switch_pm_text String (Sequência de caracteres) false (Falso) If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter
switch_pm_parameter String (Sequência de caracteres) false (Falso) Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.

Exemplo:

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. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Integer (Número) true (Verdadeiro) Unique identifier for the target private chat
title String (Sequência de caracteres) true (Verdadeiro) Product name, 1-32 characters
description String (Sequência de caracteres) true (Verdadeiro) Product description, 1-255 characters
payload String (Sequência de caracteres) true (Verdadeiro) Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
provider_token String (Sequência de caracteres) true (Verdadeiro) Payments provider token, obtained via Botfather
start_parameter String (Sequência de caracteres) true (Verdadeiro) Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter
currency String (Sequência de caracteres) true (Verdadeiro) Three-letter ISO 4217 currency code, see more on currencies
prices Array of LabeledPrice true (Verdadeiro) Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
provider_data String (Sequência de caracteres) false (Falso) JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
photo_url String (Sequência de caracteres) false (Falso) URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
photo_size Integer (Número) false (Falso) Photo size
photo_width Integer (Número) false (Falso) Largura da foto
photo_height Integer (Número) false (Falso) Altura da foto
need_name Boolen (Boleano) false (Falso) Pass True, if you require the user's full name to complete the order
need_phone_number Boolen (Boleano) false (Falso) Pass True, if you require the user's phone number to complete the order
need_email Boolen (Boleano) false (Falso) Pass True, if you require the user's email address to complete the order
need_shipping_address Boolen (Boleano) false (Falso) Pass True, if you require the user's shipping address to complete the order
send_phone_number_to_provider Boolen (Boleano) false (Falso) Pass True, if user's phone number should be sent to provider
send_email_to_provider Boolen (Boleano) false (Falso) Pass True, if user's email address should be sent to provider
is_flexible Boolen (Boleano) false (Falso) Pass True, if the final price depends on the shipping method
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup false (Falso) A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.

Exemplo:

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.

Campo Tipo Requerido Descrição
shipping_query_id String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the query to be answered
ok Boolen (Boleano) true (Verdadeiro) Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
shipping_options Array of ShippingOption false (Falso) Required if ok is True. A JSON-serialized array of available shipping options.
error_message String (Sequência de caracteres) false (Falso) Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.

Exemplo:

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.

Campo Tipo Requerido Descrição
pre_checkout_query_id String (Sequência de caracteres) true (Verdadeiro) Unique identifier for the query to be answered
ok Boolen (Boleano) true (Verdadeiro) Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
error_message String (Sequência de caracteres) false (Falso) Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.

Exemplo:

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

sendGame

Use este método para enviar um jogo. Em caso de sucesso, a mensagem enviada será retornada.

Campo Tipo Requerido Descrição
chat_id Integer (Número) true (Verdadeiro) Unique identifier for the target chat
game_short_name String (Sequência de caracteres) true (Verdadeiro) Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather.
disable_notification Boolen (Boleano) false (Falso) Envia uma mensagem silenciosamente. Os usuários não receberão uma notificação em som.
reply_to_message_id Integer (Número) false (Falso) If the message is a reply, ID of the original message
reply_markup InlineKeyboardMarkup false (Falso) A JSON-serialized object for an inline keyboard. If empty, one ‘Play game_title’ button will be shown. If not empty, the first button must launch the game.

Exemplo:

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.

Campo Tipo Requerido Descrição
user_id Integer (Número) true (Verdadeiro) User identifier
score Integer (Número) true (Verdadeiro) New score, must be non-negative
force Boolen (Boleano) false (Falso) Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters
disable_edit_message Boolen (Boleano) false (Falso) Pass True, if the game message should not be automatically edited to include the current scoreboard
chat_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Unique identifier for the target chat
message_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Identifier of the sent message
inline_message_id String (Sequência de caracteres) false (Falso) Required if chat_id and message_id are not specified. Identifier of the inline message

Exemplo:

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.

Campo Tipo Requerido Descrição
user_id Integer (Número) true (Verdadeiro) Usuário do destino, seu user_id
chat_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Unique identifier for the target chat
message_id Integer (Número) false (Falso) Required if inline_message_id is not specified. Identifier of the sent message
inline_message_id String (Sequência de caracteres) false (Falso) Required if chat_id and message_id are not specified. Identifier of the inline message

Exemplo:

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