Cluster · разработчикам

Bot API · методы

Каталог и общие правила · Справочник SDK

addStickerToSet

Аргументы

• name: String, обязательный.
• sticker: InputSticker, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.addStickerToSet(name=name, sticker=sticker, user_id=user_id)

Описание Telegram

answerCallbackQuery

Аргументы

• cache_time: Integer, необязательный.
• callback_query_id: String, обязательный.
• show_alert: Boolean, необязательный.
• text: String, необязательный.
• url: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.answerCallbackQuery(callback_query_id=callback_query_id)

Описание Telegram

answerChatJoinRequestQuery

Аргументы

• chat_join_request_query_id: String, обязательный.
• result: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.answerChatJoinRequestQuery(chat_join_request_query_id=chat_join_request_query_id, result=result)

Описание Telegram

answerGuestQuery

Аргументы

• guest_query_id: String, обязательный.
• result: InlineQueryResult, обязательный.

Результат

SentGuestMessage. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.answerGuestQuery(guest_query_id=guest_query_id, result=result)

Описание Telegram

answerInlineQuery

Аргументы

• button: InlineQueryResultsButton, необязательный.
• cache_time: Integer, необязательный.
• inline_query_id: String, обязательный.
• is_personal: Boolean, необязательный.
• next_offset: String, необязательный.
• results: Array of InlineQueryResult, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.answerInlineQuery(inline_query_id=inline_query_id, results=results)

Описание Telegram

answerPreCheckoutQuery

Аргументы

• error_message: String, необязательный.
• ok: Boolean, обязательный.
• pre_checkout_query_id: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.answerPreCheckoutQuery(ok=ok, pre_checkout_query_id=pre_checkout_query_id)

Описание Telegram

answerShippingQuery

Аргументы

• error_message: String, необязательный.
• ok: Boolean, обязательный.
• shipping_options: Array of ShippingOption, необязательный.
• shipping_query_id: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.answerShippingQuery(ok=ok, shipping_query_id=shipping_query_id)

Описание Telegram

answerWebAppQuery

Аргументы

• result: InlineQueryResult, обязательный.
• web_app_query_id: String, обязательный.

Результат

SentWebAppMessage. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.answerWebAppQuery(result=result, web_app_query_id=web_app_query_id)

Описание Telegram

approveChatJoinRequest

Аргументы

• chat_id: Integer or String, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.approveChatJoinRequest(chat_id=chat_id, user_id=user_id)

Описание Telegram

approveSuggestedPost

Аргументы

• chat_id: Integer, обязательный.
• message_id: Integer, обязательный.
• send_date: Integer, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.approveSuggestedPost(chat_id=chat_id, message_id=message_id)

Описание Telegram

banChatMember

Аргументы

• chat_id: Integer or String, обязательный.
• revoke_messages: Boolean, необязательный.
• until_date: Integer, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.banChatMember(chat_id=chat_id, user_id=user_id)

Описание Telegram

banChatSenderChat

Аргументы

• chat_id: Integer or String, обязательный.
• sender_chat_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.banChatSenderChat(chat_id=chat_id, sender_chat_id=sender_chat_id)

Описание Telegram

closeForumTopic

Аргументы

• chat_id: Integer or String, обязательный.
• message_thread_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.closeForumTopic(chat_id=chat_id, message_thread_id=message_thread_id)

Описание Telegram

closeGeneralForumTopic

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.closeGeneralForumTopic(chat_id=chat_id)

Описание Telegram

convertGiftToStars

Аргументы

• business_connection_id: String, обязательный.
• owned_gift_id: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.convertGiftToStars(business_connection_id=business_connection_id, owned_gift_id=owned_gift_id)

Описание Telegram

copyMessage

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• from_chat_id: Integer or String, обязательный.
• message_effect_id: String, необязательный.
• message_id: Integer, обязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• show_caption_above_media: Boolean, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• video_start_timestamp: Integer, необязательный.

Результат

MessageId. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.copyMessage(chat_id=chat_id, from_chat_id=from_chat_id, message_id=message_id)

Описание Telegram

copyMessages

Аргументы

• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• from_chat_id: Integer or String, обязательный.
• message_ids: Array of Integer, обязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• remove_caption: Boolean, необязательный.

Результат

list[MessageId]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.copyMessages(chat_id=chat_id, from_chat_id=from_chat_id, message_ids=message_ids)

Описание Telegram

createChatInviteLink

Аргументы

• chat_id: Integer or String, обязательный.
• creates_join_request: Boolean, необязательный.
• expire_date: Integer, необязательный.
• member_limit: Integer, необязательный.
• name: String, необязательный.

Результат

ChatInviteLink. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.createChatInviteLink(chat_id=chat_id)

Описание Telegram

createChatSubscriptionInviteLink

Аргументы

• chat_id: Integer or String, обязательный.
• name: String, необязательный.
• subscription_period: Integer, обязательный.
• subscription_price: Integer, обязательный.

Результат

ChatInviteLink. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.createChatSubscriptionInviteLink(chat_id=chat_id, subscription_period=subscription_period, subscription_price=subscription_price)

Описание Telegram

createForumTopic

Аргументы

• chat_id: Integer or String, обязательный.
• icon_color: Integer, необязательный.
• icon_custom_emoji_id: String, необязательный.
• name: String, обязательный.

Результат

ForumTopic. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.createForumTopic(chat_id=chat_id, name=name)

Описание Telegram

createInvoiceLink

Аргументы

• business_connection_id: String, необязательный.
• currency: String, обязательный.
• description: String, обязательный.
• is_flexible: Boolean, необязательный.
• max_tip_amount: Integer, необязательный.
• need_email: Boolean, необязательный.
• need_name: Boolean, необязательный.
• need_phone_number: Boolean, необязательный.
• need_shipping_address: Boolean, необязательный.
• payload: String, обязательный.
• photo_height: Integer, необязательный.
• photo_size: Integer, необязательный.
• photo_url: String, необязательный.
• photo_width: Integer, необязательный.
• prices: Array of LabeledPrice, обязательный.
• provider_data: String, необязательный.
• provider_token: String, необязательный.
• send_email_to_provider: Boolean, необязательный.
• send_phone_number_to_provider: Boolean, необязательный.
• subscription_period: Integer, необязательный.
• suggested_tip_amounts: Array of Integer, необязательный.
• title: String, обязательный.

Результат

str. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.createInvoiceLink(currency=currency, description=description, payload=payload, prices=prices, title=title)

Описание Telegram

createNewStickerSet

Аргументы

• name: String, обязательный.
• needs_repainting: Boolean, необязательный.
• sticker_type: String, необязательный.
• stickers: Array of InputSticker, обязательный.
• title: String, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.createNewStickerSet(name=name, stickers=stickers, title=title, user_id=user_id)

Описание Telegram

declineChatJoinRequest

Аргументы

• chat_id: Integer or String, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.declineChatJoinRequest(chat_id=chat_id, user_id=user_id)

Описание Telegram

declineSuggestedPost

Аргументы

• chat_id: Integer, обязательный.
• comment: String, необязательный.
• message_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.declineSuggestedPost(chat_id=chat_id, message_id=message_id)

Описание Telegram

deleteAllMessageReactions

Аргументы

• actor_chat_id: Integer, необязательный.
• chat_id: Integer or String, обязательный.
• user_id: Integer, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteAllMessageReactions(chat_id=chat_id)

Описание Telegram

deleteBusinessMessages

Аргументы

• business_connection_id: String, обязательный.
• message_ids: Array of Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteBusinessMessages(business_connection_id=business_connection_id, message_ids=message_ids)

Описание Telegram

deleteChatPhoto

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteChatPhoto(chat_id=chat_id)

Описание Telegram

deleteChatStickerSet

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteChatStickerSet(chat_id=chat_id)

Описание Telegram

deleteEphemeralMessage

Аргументы

• chat_id: Integer or String, обязательный.
• ephemeral_message_id: Integer, обязательный.
• receiver_user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteEphemeralMessage(chat_id=chat_id, ephemeral_message_id=ephemeral_message_id, receiver_user_id=receiver_user_id)

Описание Telegram

deleteForumTopic

Аргументы

• chat_id: Integer or String, обязательный.
• message_thread_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteForumTopic(chat_id=chat_id, message_thread_id=message_thread_id)

Описание Telegram

deleteMessage

Аргументы

• chat_id: Integer or String, обязательный.
• message_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteMessage(chat_id=chat_id, message_id=message_id)

Описание Telegram

deleteMessageReaction

Аргументы

• actor_chat_id: Integer, необязательный.
• chat_id: Integer or String, обязательный.
• message_id: Integer, обязательный.
• user_id: Integer, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteMessageReaction(chat_id=chat_id, message_id=message_id)

Описание Telegram

deleteMessages

Аргументы

• chat_id: Integer or String, обязательный.
• message_ids: Array of Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteMessages(chat_id=chat_id, message_ids=message_ids)

Описание Telegram

deleteMyCommands

Аргументы

• language_code: String, необязательный.
• scope: BotCommandScope, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteMyCommands()

Описание Telegram

deleteStickerFromSet

Аргументы

• sticker: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteStickerFromSet(sticker=sticker)

Описание Telegram

deleteStickerSet

Аргументы

• name: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteStickerSet(name=name)

Описание Telegram

deleteStory

Аргументы

• business_connection_id: String, обязательный.
• story_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteStory(business_connection_id=business_connection_id, story_id=story_id)

Описание Telegram

deleteWebhook

Аргументы

• drop_pending_updates: Boolean, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.deleteWebhook()

Описание Telegram

editChatInviteLink

Аргументы

• chat_id: Integer or String, обязательный.
• creates_join_request: Boolean, необязательный.
• expire_date: Integer, необязательный.
• invite_link: String, обязательный.
• member_limit: Integer, необязательный.
• name: String, необязательный.

Результат

ChatInviteLink. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editChatInviteLink(chat_id=chat_id, invite_link=invite_link)

Описание Telegram

editChatSubscriptionInviteLink

Аргументы

• chat_id: Integer or String, обязательный.
• invite_link: String, обязательный.
• name: String, необязательный.

Результат

ChatInviteLink. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editChatSubscriptionInviteLink(chat_id=chat_id, invite_link=invite_link)

Описание Telegram

editEphemeralMessageCaption

Аргументы

• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• ephemeral_message_id: Integer, обязательный.
• parse_mode: String, необязательный.
• receiver_user_id: Integer, обязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.
• show_caption_above_media: Boolean, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editEphemeralMessageCaption(chat_id=chat_id, ephemeral_message_id=ephemeral_message_id, receiver_user_id=receiver_user_id)

Описание Telegram

editEphemeralMessageMedia

Аргументы

• chat_id: Integer or String, обязательный.
• ephemeral_message_id: Integer, обязательный.
• media: InputMedia, обязательный.
• receiver_user_id: Integer, обязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editEphemeralMessageMedia(chat_id=chat_id, ephemeral_message_id=ephemeral_message_id, media=media, receiver_user_id=receiver_user_id)

Описание Telegram

editEphemeralMessageReplyMarkup

Аргументы

• chat_id: Integer or String, обязательный.
• ephemeral_message_id: Integer, обязательный.
• receiver_user_id: Integer, обязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editEphemeralMessageReplyMarkup(chat_id=chat_id, ephemeral_message_id=ephemeral_message_id, receiver_user_id=receiver_user_id)

Описание Telegram

editEphemeralMessageText

Аргументы

• chat_id: Integer or String, обязательный.
• entities: Array of MessageEntity, необязательный.
• ephemeral_message_id: Integer, обязательный.
• link_preview_options: LinkPreviewOptions, необязательный.
• parse_mode: String, необязательный.
• receiver_user_id: Integer, обязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.
• rich_message: InputRichMessage, необязательный.
• text: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editEphemeralMessageText(chat_id=chat_id, ephemeral_message_id=ephemeral_message_id, receiver_user_id=receiver_user_id)

Описание Telegram

editForumTopic

Аргументы

• chat_id: Integer or String, обязательный.
• icon_custom_emoji_id: String, необязательный.
• message_thread_id: Integer, обязательный.
• name: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editForumTopic(chat_id=chat_id, message_thread_id=message_thread_id)

Описание Telegram

editGeneralForumTopic

Аргументы

• chat_id: Integer or String, обязательный.
• name: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editGeneralForumTopic(chat_id=chat_id, name=name)

Описание Telegram

editMessageCaption

Аргументы

• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, необязательный.
• inline_message_id: String, необязательный.
• message_id: Integer, необязательный.
• parse_mode: String, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.
• show_caption_above_media: Boolean, необязательный.

Результат

Message | bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editMessageCaption()

Описание Telegram

editMessageChecklist

Аргументы

• business_connection_id: String, обязательный.
• chat_id: Integer or String, обязательный.
• checklist: InputChecklist, обязательный.
• message_id: Integer, обязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editMessageChecklist(business_connection_id=business_connection_id, chat_id=chat_id, checklist=checklist, message_id=message_id)

Описание Telegram

editMessageLiveLocation

Аргументы

• business_connection_id: String, необязательный.
• chat_id: Integer or String, необязательный.
• heading: Integer, необязательный.
• horizontal_accuracy: Float, необязательный.
• inline_message_id: String, необязательный.
• latitude: Float, обязательный.
• live_period: Integer, необязательный.
• longitude: Float, обязательный.
• message_id: Integer, необязательный.
• proximity_alert_radius: Integer, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.

Результат

Message | bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editMessageLiveLocation(latitude=latitude, longitude=longitude)

Описание Telegram

editMessageMedia

Аргументы

• business_connection_id: String, необязательный.
• chat_id: Integer or String, необязательный.
• inline_message_id: String, необязательный.
• media: InputMedia, обязательный.
• message_id: Integer, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.

Результат

Message | bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editMessageMedia(media=media)

Описание Telegram

editMessageReplyMarkup

Аргументы

• business_connection_id: String, необязательный.
• chat_id: Integer or String, необязательный.
• inline_message_id: String, необязательный.
• message_id: Integer, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.

Результат

Message | bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editMessageReplyMarkup()

Описание Telegram

editMessageText

Аргументы

• business_connection_id: String, необязательный.
• chat_id: Integer or String, необязательный.
• entities: Array of MessageEntity, необязательный.
• inline_message_id: String, необязательный.
• link_preview_options: LinkPreviewOptions, необязательный.
• message_id: Integer, необязательный.
• parse_mode: String, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.
• rich_message: InputRichMessage, необязательный.
• text: String, необязательный.

Результат

Message | bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editMessageText()

Описание Telegram

editStory

Аргументы

• areas: Array of StoryArea, необязательный.
• business_connection_id: String, обязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• content: InputStoryContent, обязательный.
• parse_mode: String, необязательный.
• story_id: Integer, обязательный.

Результат

Story. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editStory(business_connection_id=business_connection_id, content=content, story_id=story_id)

Описание Telegram

editUserStarSubscription

Аргументы

• is_canceled: Boolean, обязательный.
• telegram_payment_charge_id: String, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.editUserStarSubscription(is_canceled=is_canceled, telegram_payment_charge_id=telegram_payment_charge_id, user_id=user_id)

Описание Telegram

exportChatInviteLink

Аргументы

• chat_id: Integer or String, обязательный.

Результат

str. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.exportChatInviteLink(chat_id=chat_id)

Описание Telegram

forwardMessage

Аргументы

• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• from_chat_id: Integer or String, обязательный.
• message_effect_id: String, необязательный.
• message_id: Integer, обязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• video_start_timestamp: Integer, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.forwardMessage(chat_id=chat_id, from_chat_id=from_chat_id, message_id=message_id)

Описание Telegram

forwardMessages

Аргументы

• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• from_chat_id: Integer or String, обязательный.
• message_ids: Array of Integer, обязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.

Результат

list[MessageId]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.forwardMessages(chat_id=chat_id, from_chat_id=from_chat_id, message_ids=message_ids)

Описание Telegram

getAvailableGifts

Аргументы

Нет.

Результат

Gifts. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getAvailableGifts()

Описание Telegram

getBusinessAccountGifts

Аргументы

• business_connection_id: String, обязательный.
• exclude_from_blockchain: Boolean, необязательный.
• exclude_limited_non_upgradable: Boolean, необязательный.
• exclude_limited_upgradable: Boolean, необязательный.
• exclude_saved: Boolean, необязательный.
• exclude_unique: Boolean, необязательный.
• exclude_unlimited: Boolean, необязательный.
• exclude_unsaved: Boolean, необязательный.
• limit: Integer, необязательный.
• offset: String, необязательный.
• sort_by_price: Boolean, необязательный.

Результат

OwnedGifts. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getBusinessAccountGifts(business_connection_id=business_connection_id)

Описание Telegram

getBusinessAccountStarBalance

Аргументы

• business_connection_id: String, обязательный.

Результат

StarAmount. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getBusinessAccountStarBalance(business_connection_id=business_connection_id)

Описание Telegram

getBusinessConnection

Аргументы

• business_connection_id: String, обязательный.

Результат

BusinessConnection. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getBusinessConnection(business_connection_id=business_connection_id)

Описание Telegram

getChat

Аргументы

• chat_id: Integer or String, обязательный.

Результат

ChatFullInfo. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getChat(chat_id=chat_id)

Описание Telegram

getChatAdministrators

Аргументы

• chat_id: Integer or String, обязательный.
• return_bots: Boolean, необязательный.

Результат

list[ChatMember]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getChatAdministrators(chat_id=chat_id)

Описание Telegram

getChatGifts

Аргументы

• chat_id: Integer or String, обязательный.
• exclude_from_blockchain: Boolean, необязательный.
• exclude_limited_non_upgradable: Boolean, необязательный.
• exclude_limited_upgradable: Boolean, необязательный.
• exclude_saved: Boolean, необязательный.
• exclude_unique: Boolean, необязательный.
• exclude_unlimited: Boolean, необязательный.
• exclude_unsaved: Boolean, необязательный.
• limit: Integer, необязательный.
• offset: String, необязательный.
• sort_by_price: Boolean, необязательный.

Результат

OwnedGifts. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getChatGifts(chat_id=chat_id)

Описание Telegram

getChatMember

Аргументы

• chat_id: Integer or String, обязательный.
• user_id: Integer, обязательный.

Результат

ChatMember. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getChatMember(chat_id=chat_id, user_id=user_id)

Описание Telegram

getChatMemberCount

Аргументы

• chat_id: Integer or String, обязательный.

Результат

int. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getChatMemberCount(chat_id=chat_id)

Описание Telegram

getChatMenuButton

Аргументы

• chat_id: Integer, необязательный.

Результат

MenuButton. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getChatMenuButton()

Описание Telegram

getCustomEmojiStickers

Аргументы

• custom_emoji_ids: Array of String, обязательный.

Результат

list[Sticker]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getCustomEmojiStickers(custom_emoji_ids=custom_emoji_ids)

Описание Telegram

getFile

Аргументы

• file_id: String, обязательный.

Результат

File. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getFile(file_id=file_id)

Описание Telegram

getForumTopicIconStickers

Аргументы

Нет.

Результат

list[Sticker]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getForumTopicIconStickers()

Описание Telegram

getGameHighScores

Аргументы

• chat_id: Integer, необязательный.
• inline_message_id: String, необязательный.
• message_id: Integer, необязательный.
• user_id: Integer, обязательный.

Результат

list[GameHighScore]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getGameHighScores(user_id=user_id)

Описание Telegram

getManagedBotAccessSettings

Аргументы

• user_id: Integer, обязательный.

Результат

BotAccessSettings. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getManagedBotAccessSettings(user_id=user_id)

Описание Telegram

getManagedBotToken

Аргументы

• user_id: Integer, обязательный.

Результат

str. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getManagedBotToken(user_id=user_id)

Описание Telegram

getMe

Аргументы

Нет.

Результат

User. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.read при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getMe()

Описание Telegram

getMyCommands

Аргументы

• language_code: String, необязательный.
• scope: BotCommandScope, необязательный.

Результат

list[BotCommand]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getMyCommands()

Описание Telegram

getMyDefaultAdministratorRights

Аргументы

• for_channels: Boolean, необязательный.

Результат

ChatAdministratorRights. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getMyDefaultAdministratorRights()

Описание Telegram

getMyDescription

Аргументы

• language_code: String, необязательный.

Результат

BotDescription. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getMyDescription()

Описание Telegram

getMyName

Аргументы

• language_code: String, необязательный.

Результат

BotName. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getMyName()

Описание Telegram

getMyShortDescription

Аргументы

• language_code: String, необязательный.

Результат

BotShortDescription. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getMyShortDescription()

Описание Telegram

getMyStarBalance

Аргументы

Нет.

Результат

StarAmount. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getMyStarBalance()

Описание Telegram

getStarTransactions

Аргументы

• limit: Integer, необязательный.
• offset: Integer, необязательный.

Результат

StarTransactions. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getStarTransactions()

Описание Telegram

getStickerSet

Аргументы

• name: String, обязательный.

Результат

StickerSet. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getStickerSet(name=name)

Описание Telegram

getUpdates

Аргументы

• allowed_updates: Array of String, необязательный.
• limit: Integer, необязательный.
• offset: Integer, необязательный.
• timeout: Integer, необязательный.

Результат

list[Update]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getUpdates()

Описание Telegram

getUserChatBoosts

Аргументы

• chat_id: Integer or String, обязательный.
• user_id: Integer, обязательный.

Результат

UserChatBoosts. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getUserChatBoosts(chat_id=chat_id, user_id=user_id)

Описание Telegram

getUserGifts

Аргументы

• exclude_from_blockchain: Boolean, необязательный.
• exclude_limited_non_upgradable: Boolean, необязательный.
• exclude_limited_upgradable: Boolean, необязательный.
• exclude_unique: Boolean, необязательный.
• exclude_unlimited: Boolean, необязательный.
• limit: Integer, необязательный.
• offset: String, необязательный.
• sort_by_price: Boolean, необязательный.
• user_id: Integer, обязательный.

Результат

OwnedGifts. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getUserGifts(user_id=user_id)

Описание Telegram

getUserPersonalChatMessages

Аргументы

• limit: Integer, обязательный.
• user_id: Integer, обязательный.

Результат

list[Message]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getUserPersonalChatMessages(limit=limit, user_id=user_id)

Описание Telegram

getUserProfileAudios

Аргументы

• limit: Integer, необязательный.
• offset: Integer, необязательный.
• user_id: Integer, обязательный.

Результат

UserProfileAudios. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getUserProfileAudios(user_id=user_id)

Описание Telegram

getUserProfilePhotos

Аргументы

• limit: Integer, необязательный.
• offset: Integer, необязательный.
• user_id: Integer, обязательный.

Результат

UserProfilePhotos. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getUserProfilePhotos(user_id=user_id)

Описание Telegram

getWebhookInfo

Аргументы

Нет.

Результат

WebhookInfo. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.getWebhookInfo()

Описание Telegram

giftPremiumSubscription

Аргументы

• month_count: Integer, обязательный.
• star_count: Integer, обязательный.
• text: String, необязательный.
• text_entities: Array of MessageEntity, необязательный.
• text_parse_mode: String, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.giftPremiumSubscription(month_count=month_count, star_count=star_count, user_id=user_id)

Описание Telegram

hideGeneralForumTopic

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.hideGeneralForumTopic(chat_id=chat_id)

Описание Telegram

leaveChat

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.leaveChat(chat_id=chat_id)

Описание Telegram

logOut

Аргументы

Нет.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.logOut()

Описание Telegram

pinChatMessage

Аргументы

• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• disable_notification: Boolean, необязательный.
• message_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.pinChatMessage(chat_id=chat_id, message_id=message_id)

Описание Telegram

postStory

Аргументы

• active_period: Integer, обязательный.
• areas: Array of StoryArea, необязательный.
• business_connection_id: String, обязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• content: InputStoryContent, обязательный.
• parse_mode: String, необязательный.
• post_to_chat_page: Boolean, необязательный.
• protect_content: Boolean, необязательный.

Результат

Story. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.postStory(active_period=active_period, business_connection_id=business_connection_id, content=content)

Описание Telegram

promoteChatMember

Аргументы

• can_change_info: Boolean, необязательный.
• can_delete_messages: Boolean, необязательный.
• can_delete_stories: Boolean, необязательный.
• can_edit_messages: Boolean, необязательный.
• can_edit_stories: Boolean, необязательный.
• can_invite_users: Boolean, необязательный.
• can_manage_chat: Boolean, необязательный.
• can_manage_direct_messages: Boolean, необязательный.
• can_manage_tags: Boolean, необязательный.
• can_manage_topics: Boolean, необязательный.
• can_manage_video_chats: Boolean, необязательный.
• can_pin_messages: Boolean, необязательный.
• can_post_messages: Boolean, необязательный.
• can_post_stories: Boolean, необязательный.
• can_promote_members: Boolean, необязательный.
• can_restrict_members: Boolean, необязательный.
• can_send_welcome_messages: Boolean, необязательный.
• chat_id: Integer or String, обязательный.
• is_anonymous: Boolean, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.promoteChatMember(chat_id=chat_id, user_id=user_id)

Описание Telegram

readBusinessMessage

Аргументы

• business_connection_id: String, обязательный.
• chat_id: Integer, обязательный.
• message_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.readBusinessMessage(business_connection_id=business_connection_id, chat_id=chat_id, message_id=message_id)

Описание Telegram

refundStarPayment

Аргументы

• telegram_payment_charge_id: String, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.refundStarPayment(telegram_payment_charge_id=telegram_payment_charge_id, user_id=user_id)

Описание Telegram

removeBusinessAccountProfilePhoto

Аргументы

• business_connection_id: String, обязательный.
• is_public: Boolean, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.removeBusinessAccountProfilePhoto(business_connection_id=business_connection_id)

Описание Telegram

removeChatVerification

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.removeChatVerification(chat_id=chat_id)

Описание Telegram

removeMyProfilePhoto

Аргументы

Нет.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.removeMyProfilePhoto()

Описание Telegram

removeUserVerification

Аргументы

• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.removeUserVerification(user_id=user_id)

Описание Telegram

reopenForumTopic

Аргументы

• chat_id: Integer or String, обязательный.
• message_thread_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.reopenForumTopic(chat_id=chat_id, message_thread_id=message_thread_id)

Описание Telegram

reopenGeneralForumTopic

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.reopenGeneralForumTopic(chat_id=chat_id)

Описание Telegram

replaceManagedBotToken

Аргументы

• user_id: Integer, обязательный.

Результат

str. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.replaceManagedBotToken(user_id=user_id)

Описание Telegram

replaceStickerInSet

Аргументы

• name: String, обязательный.
• old_sticker: String, обязательный.
• sticker: InputSticker, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.replaceStickerInSet(name=name, old_sticker=old_sticker, sticker=sticker, user_id=user_id)

Описание Telegram

repostStory

Аргументы

• active_period: Integer, обязательный.
• business_connection_id: String, обязательный.
• from_chat_id: Integer, обязательный.
• from_story_id: Integer, обязательный.
• post_to_chat_page: Boolean, необязательный.
• protect_content: Boolean, необязательный.

Результат

Story. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.repostStory(active_period=active_period, business_connection_id=business_connection_id, from_chat_id=from_chat_id, from_story_id=from_story_id)

Описание Telegram

restrictChatMember

Аргументы

• chat_id: Integer or String, обязательный.
• permissions: ChatPermissions, обязательный.
• until_date: Integer, необязательный.
• use_independent_chat_permissions: Boolean, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.restrictChatMember(chat_id=chat_id, permissions=permissions, user_id=user_id)

Описание Telegram

revokeChatInviteLink

Аргументы

• chat_id: Integer or String, обязательный.
• invite_link: String, обязательный.

Результат

ChatInviteLink. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.revokeChatInviteLink(chat_id=chat_id, invite_link=invite_link)

Описание Telegram

savePreparedInlineMessage

Аргументы

• allow_bot_chats: Boolean, необязательный.
• allow_channel_chats: Boolean, необязательный.
• allow_group_chats: Boolean, необязательный.
• allow_user_chats: Boolean, необязательный.
• result: InlineQueryResult, обязательный.
• user_id: Integer, обязательный.

Результат

PreparedInlineMessage. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.savePreparedInlineMessage(result=result, user_id=user_id)

Описание Telegram

savePreparedKeyboardButton

Аргументы

• button: KeyboardButton, обязательный.
• user_id: Integer, обязательный.

Результат

PreparedKeyboardButton. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.savePreparedKeyboardButton(button=button, user_id=user_id)

Описание Telegram

sendAnimation

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• animation: InputFile or String, обязательный.
• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• duration: Integer, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• has_spoiler: Boolean, необязательный.
• height: Integer, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• show_caption_above_media: Boolean, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• thumbnail: InputFile or String, необязательный.
• width: Integer, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendAnimation(animation=animation, chat_id=chat_id)

Описание Telegram

sendAudio

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• audio: InputFile or String, обязательный.
• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• duration: Integer, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• performer: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• thumbnail: InputFile or String, необязательный.
• title: String, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendAudio(audio=audio, chat_id=chat_id)

Описание Telegram

sendChatAction

Аргументы

• action: String, обязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• message_thread_id: Integer, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendChatAction(action=action, chat_id=chat_id)

Описание Telegram

sendChatJoinRequestWebApp

Аргументы

• chat_join_request_query_id: String, обязательный.
• web_app_url: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendChatJoinRequestWebApp(chat_join_request_query_id=chat_join_request_query_id, web_app_url=web_app_url)

Описание Telegram

sendChecklist

Аргументы

• business_connection_id: String, обязательный.
• chat_id: Integer or String, обязательный.
• checklist: InputChecklist, обязательный.
• disable_notification: Boolean, необязательный.
• message_effect_id: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.
• reply_parameters: ReplyParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendChecklist(business_connection_id=business_connection_id, chat_id=chat_id, checklist=checklist)

Описание Telegram

sendContact

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• first_name: String, обязательный.
• last_name: String, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• phone_number: String, обязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• vcard: String, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendContact(chat_id=chat_id, first_name=first_name, phone_number=phone_number)

Описание Telegram

sendDice

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• emoji: String, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendDice(chat_id=chat_id)

Описание Telegram

sendDocument

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_content_type_detection: Boolean, необязательный.
• disable_notification: Boolean, необязательный.
• document: InputFile or String, обязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• thumbnail: InputFile or String, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendDocument(chat_id=chat_id, document=document)

Описание Telegram

sendGame

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• disable_notification: Boolean, необязательный.
• game_short_name: String, обязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.
• reply_parameters: ReplyParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendGame(chat_id=chat_id, game_short_name=game_short_name)

Описание Telegram

sendGift

Аргументы

• chat_id: Integer or String, необязательный.
• gift_id: String, обязательный.
• pay_for_upgrade: Boolean, необязательный.
• text: String, необязательный.
• text_entities: Array of MessageEntity, необязательный.
• text_parse_mode: String, необязательный.
• user_id: Integer, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendGift(gift_id=gift_id)

Описание Telegram

sendInvoice

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• chat_id: Integer or String, обязательный.
• currency: String, обязательный.
• description: String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• is_flexible: Boolean, необязательный.
• max_tip_amount: Integer, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• need_email: Boolean, необязательный.
• need_name: Boolean, необязательный.
• need_phone_number: Boolean, необязательный.
• need_shipping_address: Boolean, необязательный.
• payload: String, обязательный.
• photo_height: Integer, необязательный.
• photo_size: Integer, необязательный.
• photo_url: String, необязательный.
• photo_width: Integer, необязательный.
• prices: Array of LabeledPrice, обязательный.
• protect_content: Boolean, необязательный.
• provider_data: String, необязательный.
• provider_token: String, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• send_email_to_provider: Boolean, необязательный.
• send_phone_number_to_provider: Boolean, необязательный.
• start_parameter: String, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• suggested_tip_amounts: Array of Integer, необязательный.
• title: String, обязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendInvoice(chat_id=chat_id, currency=currency, description=description, payload=payload, prices=prices, title=title)

Описание Telegram

sendLivePhoto

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• has_spoiler: Boolean, необязательный.
• live_photo: InputFile or String, обязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• photo: InputFile or String, обязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• show_caption_above_media: Boolean, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendLivePhoto(chat_id=chat_id, live_photo=live_photo, photo=photo)

Описание Telegram

sendLocation

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• heading: Integer, необязательный.
• horizontal_accuracy: Float, необязательный.
• latitude: Float, обязательный.
• live_period: Integer, необязательный.
• longitude: Float, обязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• proximity_alert_radius: Integer, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendLocation(chat_id=chat_id, latitude=latitude, longitude=longitude)

Описание Telegram

sendMediaGroup

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• media: Array of InputMediaAudio, InputMediaDocument, InputMediaLivePhoto, InputMediaPhoto and InputMediaVideo, обязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• reply_parameters: ReplyParameters, необязательный.

Результат

list[Message]. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendMediaGroup(chat_id=chat_id, media=media)

Описание Telegram

sendMessage

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• entities: Array of MessageEntity, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• link_preview_options: LinkPreviewOptions, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• text: String, обязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendMessage(chat_id=chat_id, text=text)

Описание Telegram

sendMessageDraft

Аргументы

• can_stop: Boolean, необязательный.
• chat_id: Integer, обязательный.
• draft_id: Integer, обязательный.
• entities: Array of MessageEntity, необязательный.
• keep_on_stop: Boolean, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• text: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendMessageDraft(chat_id=chat_id, draft_id=draft_id)

Описание Telegram

sendPaidMedia

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• media: Array of InputPaidMedia, обязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• payload: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• show_caption_above_media: Boolean, необязательный.
• star_count: Integer, обязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendPaidMedia(chat_id=chat_id, media=media, star_count=star_count)

Описание Telegram

sendPhoto

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• has_spoiler: Boolean, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• photo: InputFile or String, обязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• show_caption_above_media: Boolean, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendPhoto(chat_id=chat_id, photo=photo)

Описание Telegram

sendPoll

Аргументы

• allow_adding_options: Boolean, необязательный.
• allow_paid_broadcast: Boolean, необязательный.
• allows_multiple_answers: Boolean, необязательный.
• allows_revoting: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• close_date: Integer, необязательный.
• correct_option_ids: Array of Integer, необязательный.
• country_codes: Array of String, необязательный.
• description: String, необязательный.
• description_entities: Array of MessageEntity, необязательный.
• description_parse_mode: String, необязательный.
• disable_notification: Boolean, необязательный.
• explanation: String, необязательный.
• explanation_entities: Array of MessageEntity, необязательный.
• explanation_media: InputPollMedia, необязательный.
• explanation_parse_mode: String, необязательный.
• hide_results_until_closes: Boolean, необязательный.
• is_anonymous: Boolean, необязательный.
• is_closed: Boolean, необязательный.
• media: InputPollMedia, необязательный.
• members_only: Boolean, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• open_period: Integer, необязательный.
• options: Array of InputPollOption, обязательный.
• protect_content: Boolean, необязательный.
• question: String, обязательный.
• question_entities: Array of MessageEntity, необязательный.
• question_parse_mode: String, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• shuffle_options: Boolean, необязательный.
• type: String, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendPoll(chat_id=chat_id, options=options, question=question)

Описание Telegram

sendRichMessage

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• rich_message: InputRichMessage, обязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendRichMessage(chat_id=chat_id, rich_message=rich_message)

Описание Telegram

sendRichMessageDraft

Аргументы

• can_stop: Boolean, необязательный.
• chat_id: Integer, обязательный.
• draft_id: Integer, обязательный.
• keep_on_stop: Boolean, необязательный.
• message_thread_id: Integer, необязательный.
• rich_message: InputRichMessage, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendRichMessageDraft(chat_id=chat_id, draft_id=draft_id, rich_message=rich_message)

Описание Telegram

sendSticker

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• emoji: String, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• sticker: InputFile or String, обязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendSticker(chat_id=chat_id, sticker=sticker)

Описание Telegram

sendVenue

Аргументы

• address: String, обязательный.
• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• foursquare_id: String, необязательный.
• foursquare_type: String, необязательный.
• google_place_id: String, необязательный.
• google_place_type: String, необязательный.
• latitude: Float, обязательный.
• longitude: Float, обязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• title: String, обязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendVenue(address=address, chat_id=chat_id, latitude=latitude, longitude=longitude, title=title)

Описание Telegram

sendVideo

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• cover: InputFile or String, необязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• duration: Integer, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• has_spoiler: Boolean, необязательный.
• height: Integer, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• show_caption_above_media: Boolean, необязательный.
• start_timestamp: Integer, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• supports_streaming: Boolean, необязательный.
• thumbnail: InputFile or String, необязательный.
• video: InputFile or String, обязательный.
• width: Integer, необязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendVideo(chat_id=chat_id, video=video)

Описание Telegram

sendVideoNote

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• duration: Integer, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• length: Integer, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• thumbnail: InputFile or String, необязательный.
• video_note: InputFile or String, обязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendVideoNote(chat_id=chat_id, video_note=video_note)

Описание Telegram

sendVoice

Аргументы

• allow_paid_broadcast: Boolean, необязательный.
• business_connection_id: String, необязательный.
• caption: String, необязательный.
• caption_entities: Array of MessageEntity, необязательный.
• chat_id: Integer or String, обязательный.
• direct_messages_topic_id: Integer, необязательный.
• disable_notification: Boolean, необязательный.
• duration: Integer, необязательный.
• ephemeral_message_parameters: EphemeralMessageParameters, необязательный.
• message_effect_id: String, необязательный.
• message_thread_id: Integer, необязательный.
• parse_mode: String, необязательный.
• protect_content: Boolean, необязательный.
• reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply, необязательный.
• reply_parameters: ReplyParameters, необязательный.
• suggested_post_parameters: SuggestedPostParameters, необязательный.
• voice: InputFile or String, обязательный.

Результат

Message. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full для общего вызова. Выделенный путь может использовать bot.send при допустимых параметрах и числовом chat_id.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.sendVoice(chat_id=chat_id, voice=voice)

Описание Telegram

setBusinessAccountBio

Аргументы

• bio: String, необязательный.
• business_connection_id: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setBusinessAccountBio(business_connection_id=business_connection_id)

Описание Telegram

setBusinessAccountGiftSettings

Аргументы

• accepted_gift_types: AcceptedGiftTypes, обязательный.
• business_connection_id: String, обязательный.
• show_gift_button: Boolean, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setBusinessAccountGiftSettings(accepted_gift_types=accepted_gift_types, business_connection_id=business_connection_id, show_gift_button=show_gift_button)

Описание Telegram

setBusinessAccountName

Аргументы

• business_connection_id: String, обязательный.
• first_name: String, обязательный.
• last_name: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setBusinessAccountName(business_connection_id=business_connection_id, first_name=first_name)

Описание Telegram

setBusinessAccountProfilePhoto

Аргументы

• business_connection_id: String, обязательный.
• is_public: Boolean, необязательный.
• photo: InputProfilePhoto, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setBusinessAccountProfilePhoto(business_connection_id=business_connection_id, photo=photo)

Описание Telegram

setBusinessAccountUsername

Аргументы

• business_connection_id: String, обязательный.
• username: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setBusinessAccountUsername(business_connection_id=business_connection_id)

Описание Telegram

setChatAdministratorCustomTitle

Аргументы

• chat_id: Integer or String, обязательный.
• custom_title: String, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setChatAdministratorCustomTitle(chat_id=chat_id, custom_title=custom_title, user_id=user_id)

Описание Telegram

setChatDescription

Аргументы

• chat_id: Integer or String, обязательный.
• description: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setChatDescription(chat_id=chat_id)

Описание Telegram

setChatMemberTag

Аргументы

• chat_id: Integer or String, обязательный.
• tag: String, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setChatMemberTag(chat_id=chat_id, user_id=user_id)

Описание Telegram

setChatMenuButton

Аргументы

• chat_id: Integer, необязательный.
• menu_button: MenuButton, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setChatMenuButton()

Описание Telegram

setChatPermissions

Аргументы

• chat_id: Integer or String, обязательный.
• permissions: ChatPermissions, обязательный.
• use_independent_chat_permissions: Boolean, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setChatPermissions(chat_id=chat_id, permissions=permissions)

Описание Telegram

setChatPhoto

Аргументы

• chat_id: Integer or String, обязательный.
• photo: InputFile, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setChatPhoto(chat_id=chat_id, photo=photo)

Описание Telegram

setChatStickerSet

Аргументы

• chat_id: Integer or String, обязательный.
• sticker_set_name: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setChatStickerSet(chat_id=chat_id, sticker_set_name=sticker_set_name)

Описание Telegram

setChatTitle

Аргументы

• chat_id: Integer or String, обязательный.
• title: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setChatTitle(chat_id=chat_id, title=title)

Описание Telegram

setCustomEmojiStickerSetThumbnail

Аргументы

• custom_emoji_id: String, необязательный.
• name: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setCustomEmojiStickerSetThumbnail(name=name)

Описание Telegram

setGameScore

Аргументы

• chat_id: Integer, необязательный.
• disable_edit_message: Boolean, необязательный.
• force: Boolean, необязательный.
• inline_message_id: String, необязательный.
• message_id: Integer, необязательный.
• score: Integer, обязательный.
• user_id: Integer, обязательный.

Результат

Message | bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setGameScore(score=score, user_id=user_id)

Описание Telegram

setManagedBotAccessSettings

Аргументы

• added_user_ids: Array of Integer, необязательный.
• is_access_restricted: Boolean, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setManagedBotAccessSettings(is_access_restricted=is_access_restricted, user_id=user_id)

Описание Telegram

setMessageReaction

Аргументы

• chat_id: Integer or String, обязательный.
• is_big: Boolean, необязательный.
• message_id: Integer, обязательный.
• reaction: Array of ReactionType, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setMessageReaction(chat_id=chat_id, message_id=message_id)

Описание Telegram

setMyCommands

Аргументы

• commands: Array of BotCommand, обязательный.
• language_code: String, необязательный.
• scope: BotCommandScope, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setMyCommands(commands=commands)

Описание Telegram

setMyDefaultAdministratorRights

Аргументы

• for_channels: Boolean, необязательный.
• rights: ChatAdministratorRights, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setMyDefaultAdministratorRights()

Описание Telegram

setMyDescription

Аргументы

• description: String, необязательный.
• language_code: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setMyDescription()

Описание Telegram

setMyName

Аргументы

• language_code: String, необязательный.
• name: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setMyName()

Описание Telegram

setMyProfilePhoto

Аргументы

• photo: InputProfilePhoto, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setMyProfilePhoto(photo=photo)

Описание Telegram

setMyShortDescription

Аргументы

• language_code: String, необязательный.
• short_description: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setMyShortDescription()

Описание Telegram

setPassportDataErrors

Аргументы

• errors: Array of PassportElementError, обязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setPassportDataErrors(errors=errors, user_id=user_id)

Описание Telegram

setStickerEmojiList

Аргументы

• emoji_list: Array of String, обязательный.
• sticker: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setStickerEmojiList(emoji_list=emoji_list, sticker=sticker)

Описание Telegram

setStickerKeywords

Аргументы

• keywords: Array of String, необязательный.
• sticker: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setStickerKeywords(sticker=sticker)

Описание Telegram

setStickerMaskPosition

Аргументы

• mask_position: MaskPosition, необязательный.
• sticker: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setStickerMaskPosition(sticker=sticker)

Описание Telegram

setStickerPositionInSet

Аргументы

• position: Integer, обязательный.
• sticker: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setStickerPositionInSet(position=position, sticker=sticker)

Описание Telegram

setStickerSetThumbnail

Аргументы

• format: String, обязательный.
• name: String, обязательный.
• thumbnail: InputFile or String, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setStickerSetThumbnail(format=format, name=name, user_id=user_id)

Описание Telegram

setStickerSetTitle

Аргументы

• name: String, обязательный.
• title: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setStickerSetTitle(name=name, title=title)

Описание Telegram

setUserEmojiStatus

Аргументы

• emoji_status_custom_emoji_id: String, необязательный.
• emoji_status_expiration_date: Integer, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setUserEmojiStatus(user_id=user_id)

Описание Telegram

setWebhook

Аргументы

• allowed_updates: Array of String, необязательный.
• certificate: InputFile, необязательный.
• drop_pending_updates: Boolean, необязательный.
• ip_address: String, необязательный.
• max_connections: Integer, необязательный.
• secret_token: String, необязательный.
• url: String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

Метод заблокирован для модулей.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.setWebhook(url=url)

Описание Telegram

stopMessageLiveLocation

Аргументы

• business_connection_id: String, необязательный.
• chat_id: Integer or String, необязательный.
• inline_message_id: String, необязательный.
• message_id: Integer, необязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.

Результат

Message | bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.stopMessageLiveLocation()

Описание Telegram

stopPoll

Аргументы

• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• message_id: Integer, обязательный.
• reply_markup: InlineKeyboardMarkup, необязательный.

Результат

Poll. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.stopPoll(chat_id=chat_id, message_id=message_id)

Описание Telegram

transferBusinessAccountStars

Аргументы

• business_connection_id: String, обязательный.
• star_count: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.transferBusinessAccountStars(business_connection_id=business_connection_id, star_count=star_count)

Описание Telegram

transferGift

Аргументы

• business_connection_id: String, обязательный.
• new_owner_chat_id: Integer, обязательный.
• owned_gift_id: String, обязательный.
• star_count: Integer, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.transferGift(business_connection_id=business_connection_id, new_owner_chat_id=new_owner_chat_id, owned_gift_id=owned_gift_id)

Описание Telegram

unbanChatMember

Аргументы

• chat_id: Integer or String, обязательный.
• only_if_banned: Boolean, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.unbanChatMember(chat_id=chat_id, user_id=user_id)

Описание Telegram

unbanChatSenderChat

Аргументы

• chat_id: Integer or String, обязательный.
• sender_chat_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.unbanChatSenderChat(chat_id=chat_id, sender_chat_id=sender_chat_id)

Описание Telegram

unhideGeneralForumTopic

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.unhideGeneralForumTopic(chat_id=chat_id)

Описание Telegram

unpinAllChatMessages

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.unpinAllChatMessages(chat_id=chat_id)

Описание Telegram

unpinAllForumTopicMessages

Аргументы

• chat_id: Integer or String, обязательный.
• message_thread_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.unpinAllForumTopicMessages(chat_id=chat_id, message_thread_id=message_thread_id)

Описание Telegram

unpinAllGeneralForumTopicMessages

Аргументы

• chat_id: Integer or String, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.unpinAllGeneralForumTopicMessages(chat_id=chat_id)

Описание Telegram

unpinChatMessage

Аргументы

• business_connection_id: String, необязательный.
• chat_id: Integer or String, обязательный.
• message_id: Integer, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.unpinChatMessage(chat_id=chat_id)

Описание Telegram

upgradeGift

Аргументы

• business_connection_id: String, обязательный.
• keep_original_details: Boolean, необязательный.
• owned_gift_id: String, обязательный.
• star_count: Integer, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.upgradeGift(business_connection_id=business_connection_id, owned_gift_id=owned_gift_id)

Описание Telegram

uploadStickerFile

Аргументы

• sticker: InputFile, обязательный.
• sticker_format: String, обязательный.
• user_id: Integer, обязательный.

Результат

File. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.uploadStickerFile(sticker=sticker, sticker_format=sticker_format, user_id=user_id)

Описание Telegram

verifyChat

Аргументы

• chat_id: Integer or String, обязательный.
• custom_description: String, необязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.verifyChat(chat_id=chat_id)

Описание Telegram

verifyUser

Аргументы

• custom_description: String, необязательный.
• user_id: Integer, обязательный.

Результат

bool. JSON-результат Telegram; описание структуры см. в каталоге типов Bot API.

Права

bot.full; ограничения должны допускать общий запрос.

Ошибки

ValueError при несовпадении набора параметров со схемой; для отправки также действуют ошибки ядра и Telegram, описанные в каталоге. Типы с неверной вложенной структурой могут быть отклонены только при отправке. Метод не проверяет доступность адресата или действия заранее.

Пример

Параметры справа являются подготовленными значениями указанных выше типов. Пример показывает форму вызова; он не выполняется при чтении документации.

result = await app.bot.api.verifyUser(user_id=user_id)

Описание Telegram