Telegram

Parámetros de entrada

• urlstring

  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.

• textstring

  Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters

• cache_timeinteger

  The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

• show_alertboolean

  If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.

• callback_query_idstringObligatorio

  Unique identifier for the query to be answered

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target channel

• message_idintegerObligatorio

  Identifier of the message to delete

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstringObligatorio

  New text of the message, 1-4096 characters after entities parsing

• chat_idinteger

  Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel

• message_idinteger

  Required if inline_message_id is not specified. Identifier of the message to edit

• parse_modestring

  Mode for parsing entities in the message text. Options: 'Markdown', 'MarkdownV2', 'HTML'

• reply_markupstring

  JSON-serialized object for an inline keyboard

• inline_message_idstring

  Required if chat_id and message_id are not specified. Identifier of the inline message

• disable_web_page_previewboolean

  Disables link previews for links in this message

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target supergroup or channel

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target channel

• message_idintegerObligatorio

  Message identifier in the chat specified in from_chat_id

• from_chat_idintegerObligatorio

  Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)

• disable_notificationboolean

  Sends the message silently. Users will receive a notification with no sound.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target supergroup or channel

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target supergroup or channel

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Limits the number of messages to be retrieved. Values between 1-100 are accepted. Defaults to 100.

• offsetinteger

  Sequential number of the first message to be returned; negative values are allowed. Default is 0.

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target supergroup or channel

• message_idinteger

  Identifier of a message in the chat as a starting point for getting history. If not specified, returns recent messages.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target supergroup or channel

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100

• offsetinteger

  Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates

• timeoutinteger

  Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only

• allowed_updatesstring[]

  A JSON-serialized list of the update types you want your bot to receive. Specify an empty list to receive all update types except chat_member

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• captionstring

  Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target channel

• documentstringObligatorio

  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 file using multipart/form-data. More info on Sending Files: https://core.telegram.org/bots/api#sending-files

• thumbnailstring

  Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side

• parse_modestring

  Mode for parsing entities in the document caption. Options: 'Markdown', 'MarkdownV2', 'HTML'

• reply_markupstring

  JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user

• reply_to_message_idinteger

  If the message is a reply, ID of the original message

• disable_notificationboolean

  Sends the message silently. Users will receive a notification with no sound.

• disable_content_type_detectionboolean

  Disables automatic server-side content type detection for files uploaded using multipart/form-data

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target channel

• headinginteger

  For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

• latitudenumberObligatorio

  Latitude of the location

• longitudenumberObligatorio

  Longitude of the location

• live_periodinteger

  Period in seconds for which the location will be updated (see Live Locations), should be between 60 and 86400

• reply_markupstring

  JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user

• horizontal_accuracynumber

  The radius of uncertainty for the location, measured in meters; 0-1500

• reply_to_message_idinteger

  If the message is a reply, ID of the original message

• disable_notificationboolean

  Sends the message silently. Users will receive a notification with no sound.

• proximity_alert_radiusinteger

  For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstringObligatorio

  Text of the message to be sent, 1-4096 characters after entities parsing

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target channel (in the format @channelusername)

• parse_modestring

  Mode for parsing entities in the message text. Options: 'Markdown', 'MarkdownV2', 'HTML'

• reply_markupstring

  JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

• reply_to_message_idinteger

  If the message is a reply, ID of the original message

• disable_notificationboolean

  Sends the message silently. Users will receive a notification with no sound.

• disable_web_page_previewboolean

  Disables link previews for links in this message

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• photostringObligatorio

  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

• captionstring

  Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target channel

• parse_modestring

  Mode for parsing entities in the photo caption. Options: 'Markdown', 'MarkdownV2', 'HTML'

• reply_markupstring

  JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user

• reply_to_message_idinteger

  If the message is a reply, ID of the original message

• disable_notificationboolean

  Sends the message silently. Users will receive a notification with no sound.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• typestring

  Poll type, 'quiz' or 'regular', defaults to 'regular'

• chat_idintegerObligatorio

  Unique identifier for the target chat or username of the target channel

• optionsstring[]Obligatorio

  A list of answer options, 2-10 strings 1-100 characters each

• questionstringObligatorio

  Poll question, 1-300 characters

• is_closedboolean

  Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.

• close_dateinteger

  Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.

• explanationstring

  Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing

• open_periodinteger

  Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.

• is_anonymousboolean

  True, if the poll needs to be anonymous, defaults to True

• reply_markupstring

  JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user

• correct_option_idinteger

  0-based identifier of the correct answer option, required for polls in quiz mode

• reply_to_message_idinteger

  If the message is a reply, ID of the original message

• disable_notificationboolean

  Sends the message silently. Users will receive a notification with no sound.

• explanation_parse_modestring

  Mode for parsing entities in the explanation. Options: 'Markdown', 'MarkdownV2', 'HTML'

• allows_multiple_answersboolean

  True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• scopestring

  JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.

• commandsobject[]Obligatorio

  A list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.

• language_codestring

  A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not