InputMedia
- class pyrogram.raw.base.InputMedia
Defines media content of a message.
- Constructors:
This base type has 20 constructors available.
Phone book contact
Send a dice-based animated sticker
Forwarded document
Document that will be downloaded by the telegram servers
Empty media content of a message.
A game
Live geolocation
Map.
Generated invoice of a bot payment
Paid media, see here » for more info.
Forwarded photo
New photo that will be uploaded by the server using the specified URL
A poll
{schema}
Forwarded story
Creates a todo list ».
New document
Photo
Can be used to send a venue geolocation.
Specifies options that will be used to generate the link preview for the caption, or even a standalone link preview without an attached message.
TL Schema
Parameter Tree
InputMedia
├──
InputMediaEmpty│ ├── spoiler →
true (optional)│ ├── file →
InputFile│ │ ├──
InputFile│ │ ├──
InputFileBig│ │ └──
InputFileStoryDocument│ ├── stickers →
Vector < InputDocument > (optional)│ │ ├──
InputDocumentEmpty│ │ └──
InputDocument│ │ ├── id →
long│ │ ├── access_hash →
long│ │ └── file_reference →
bytes│ └── ttl_seconds →
int (optional)├──
InputMediaPhoto│ ├── spoiler →
true (optional)│ ├── id →
InputPhoto│ │ ├──
InputPhotoEmpty│ │ └──
InputPhoto│ │ ├── id →
long│ │ ├── access_hash →
long│ │ └── file_reference →
bytes│ └── ttl_seconds →
int (optional)│ └── geo_point →
InputGeoPoint│ ├──
InputGeoPointEmpty│ └──
InputGeoPoint│ ├── lat →
double│ ├── long →
double│ └── accuracy_radius →
int (optional)│ ├── phone_number →
string│ ├── first_name →
string│ ├── last_name →
string│ └── vcard →
string│ ├── nosound_video →
true (optional)│ ├── force_file →
true (optional)│ ├── spoiler →
true (optional)│ ├── file →
InputFile│ │ ├──
InputFile│ │ ├──
InputFileBig│ │ └──
InputFileStoryDocument│ ├── thumb →
InputFile (optional)│ │ ├──
InputFile│ │ ├──
InputFileBig│ │ └──
InputFileStoryDocument│ ├── mime_type →
string│ ├── attributes →
Vector < DocumentAttribute >│ │ ├──
DocumentAttributeImageSize│ │ │ ├── w →
int│ │ │ └── h →
int│ │ ├──
DocumentAttributeAnimated│ │ ├──
DocumentAttributeSticker│ │ │ ├── mask →
true (optional)│ │ │ ├── alt →
string│ │ │ ├── stickerset →
InputStickerSet│ │ │ │ ├──
InputStickerSetEmpty│ │ │ │ ├──
InputStickerSetID│ │ │ │ ├──
InputStickerSetShortName│ │ │ │ ├──
InputStickerSetAnimatedEmoji│ │ │ │ ├──
InputStickerSetDice│ │ │ │ ├──
InputStickerSetAnimatedEmojiAnimations│ │ │ │ ├──
InputStickerSetPremiumGifts│ │ │ │ ├──
InputStickerSetEmojiGenericAnimations│ │ │ │ ├──
InputStickerSetEmojiDefaultStatuses│ │ │ │ ├──
InputStickerSetEmojiDefaultTopicIcons│ │ │ │ ├──
InputStickerSetEmojiChannelDefaultStatuses│ │ │ │ └──
InputStickerSetTonGifts│ │ │ └── mask_coords →
MaskCoords (optional)│ │ │ └──
MaskCoords│ │ ├──
DocumentAttributeVideo│ │ │ ├── round_message →
true (optional)│ │ │ ├── supports_streaming →
true (optional)│ │ │ ├── nosound →
true (optional)│ │ │ ├── duration →
double│ │ │ ├── w →
int│ │ │ ├── h →
int│ │ │ ├── preload_prefix_size →
int (optional)│ │ │ ├── video_start_ts →
double (optional)│ │ │ └── video_codec →
string (optional)│ │ ├──
DocumentAttributeAudio│ │ │ ├── voice →
true (optional)│ │ │ ├── duration →
int│ │ │ ├── title →
string (optional)│ │ │ ├── performer →
string (optional)│ │ │ └── waveform →
bytes (optional)│ │ ├──
DocumentAttributeFilename│ │ │ └── file_name →
string│ │ ├──
DocumentAttributeHasStickers│ │ └──
DocumentAttributeCustomEmoji│ │ ├── free →
true (optional)│ │ ├── text_color →
true (optional)│ │ ├── alt →
string│ │ └── stickerset →
InputStickerSet│ │ ├──
InputStickerSetEmpty│ │ ├──
InputStickerSetID│ │ ├──
InputStickerSetShortName│ │ ├──
InputStickerSetAnimatedEmoji│ │ ├──
InputStickerSetDice│ │ ├──
InputStickerSetPremiumGifts│ │ └──
InputStickerSetTonGifts│ ├── stickers →
Vector < InputDocument > (optional)│ │ ├──
InputDocumentEmpty│ │ └──
InputDocument│ │ ├── id →
long│ │ ├── access_hash →
long│ │ └── file_reference →
bytes│ ├── video_cover →
InputPhoto (optional)│ │ ├──
InputPhotoEmpty│ │ └──
InputPhoto│ │ ├── id →
long│ │ ├── access_hash →
long│ │ └── file_reference →
bytes│ ├── video_timestamp →
int (optional)│ └── ttl_seconds →
int (optional)│ ├── spoiler →
true (optional)│ ├── id →
InputDocument│ │ ├──
InputDocumentEmpty│ │ └──
InputDocument│ │ ├── id →
long│ │ ├── access_hash →
long│ │ └── file_reference →
bytes│ ├── video_cover →
InputPhoto (optional)│ │ ├──
InputPhotoEmpty│ │ └──
InputPhoto│ │ ├── id →
long│ │ ├── access_hash →
long│ │ └── file_reference →
bytes│ ├── video_timestamp →
int (optional)│ ├── ttl_seconds →
int (optional)│ └── query →
string (optional)├──
InputMediaVenue│ ├── geo_point →
InputGeoPoint│ │ ├──
InputGeoPointEmpty│ │ └──
InputGeoPoint│ │ ├── lat →
double│ │ ├── long →
double│ │ └── accuracy_radius →
int (optional)│ ├── title →
string│ ├── address →
string│ ├── provider →
string│ ├── venue_id →
string│ └── venue_type →
string│ ├── spoiler →
true (optional)│ ├── url →
string│ └── ttl_seconds →
int (optional)│ ├── spoiler →
true (optional)│ ├── url →
string│ ├── ttl_seconds →
int (optional)│ ├── video_cover →
InputPhoto (optional)│ │ ├──
InputPhotoEmpty│ │ └──
InputPhoto│ │ ├── id →
long│ │ ├── access_hash →
long│ │ └── file_reference →
bytes│ └── video_timestamp →
int (optional)├──
InputMediaGame│ └── id →
InputGame│ ├──
InputGameID│ │ ├── id →
long│ │ └── access_hash →
long│ └──
InputGameShortName│ ├── bot_id →
InputUser│ │ ├──
InputUserEmpty│ │ ├──
InputUserSelf│ │ ├──
InputUser│ │ └──
InputUserFromMessage│ └── short_name →
string│ ├── title →
string│ ├── description →
string│ ├── photo →
InputWebDocument (optional)│ │ └──
InputWebDocument│ │ ├── url →
string│ │ ├── size →
int│ │ ├── mime_type →
string│ │ └── attributes →
Vector < DocumentAttribute >│ │ ├──
DocumentAttributeImageSize│ │ ├──
DocumentAttributeAnimated│ │ ├──
DocumentAttributeSticker│ │ ├──
DocumentAttributeVideo│ │ ├──
DocumentAttributeAudio│ │ ├──
DocumentAttributeFilename│ │ ├──
DocumentAttributeHasStickers│ │ └──
DocumentAttributeCustomEmoji│ ├── invoice →
Invoice│ │ └──
Invoice│ │ ├── test →
true (optional)│ │ ├── name_requested →
true (optional)│ │ ├── phone_requested →
true (optional)│ │ ├── email_requested →
true (optional)│ │ ├── shipping_address_requested →
true (optional)│ │ ├── flexible →
true (optional)│ │ ├── phone_to_provider →
true (optional)│ │ ├── email_to_provider →
true (optional)│ │ ├── recurring →
true (optional)│ │ ├── currency →
string│ │ ├── prices →
Vector < LabeledPrice >│ │ │ └──
LabeledPrice│ │ ├── max_tip_amount →
long (optional)│ │ ├── suggested_tip_amounts →
Vector < long > (optional)│ │ ├── terms_url →
string (optional)│ │ └── subscription_period →
int (optional)│ ├── payload →
bytes│ ├── provider →
string (optional)│ ├── provider_data →
DataJSON│ │ └──
DataJSON│ │ └── data →
string│ ├── start_param →
string (optional)│ └── extended_media →
InputMedia (optional)│ ├──
InputMediaEmpty│ ├──
InputMediaUploadedPhoto│ ├──
InputMediaPhoto│ ├──
InputMediaGeoPoint│ ├──
InputMediaContact│ ├──
InputMediaDocument│ ├──
InputMediaVenue│ ├──
InputMediaPhotoExternal│ ├──
InputMediaGame│ ├──
InputMediaInvoice│ ├──
InputMediaGeoLive│ ├──
InputMediaPoll│ ├──
InputMediaDice│ ├──
InputMediaStory│ ├──
InputMediaWebPage│ ├──
InputMediaPaidMedia│ ├──
InputMediaTodo│ └──
InputMediaStakeDice│ ├── stopped →
true (optional)│ ├── geo_point →
InputGeoPoint│ │ ├──
InputGeoPointEmpty│ │ └──
InputGeoPoint│ │ ├── lat →
double│ │ ├── long →
double│ │ └── accuracy_radius →
int (optional)│ ├── heading →
int (optional)│ ├── period →
int (optional)│ └── proximity_notification_radius →
int (optional)├──
InputMediaPoll│ ├── poll →
Poll│ │ └──
Poll│ │ ├── id →
long│ │ ├── closed →
true (optional)│ │ ├── public_voters →
true (optional)│ │ ├── multiple_choice →
true (optional)│ │ ├── quiz →
true (optional)│ │ ├── question →
TextWithEntities│ │ │ └──
TextWithEntities│ │ ├── answers →
Vector < PollAnswer >│ │ │ └──
PollAnswer│ │ ├── close_period →
int (optional)│ │ └── close_date →
int (optional)│ ├── correct_answers →
Vector < bytes > (optional)│ ├── solution →
string (optional)│ └── solution_entities →
Vector < MessageEntity > (optional)│ ├──
MessageEntityUnknown│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityMention│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityHashtag│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityBotCommand│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityUrl│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityEmail│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityBold│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityItalic│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityCode│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityPre│ │ ├── offset →
int│ │ ├── length →
int│ │ └── language →
string│ ├──
MessageEntityTextUrl│ │ ├── offset →
int│ │ ├── length →
int│ │ └── url →
string│ ├──
MessageEntityMentionName│ │ ├── offset →
int│ │ ├── length →
int│ │ └── user_id →
long│ │ ├── offset →
int│ │ ├── length →
int│ │ └── user_id →
InputUser│ │ ├──
InputUserEmpty│ │ ├──
InputUserSelf│ │ ├──
InputUser│ │ └──
InputUserFromMessage│ ├──
MessageEntityPhone│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityCashtag│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityUnderline│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityStrike│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityBankCard│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntitySpoiler│ │ ├── offset →
int│ │ └── length →
int│ ├──
MessageEntityCustomEmoji│ │ ├── offset →
int│ │ ├── length →
int│ │ └── document_id →
long│ ├──
MessageEntityBlockquote│ │ ├── collapsed →
true (optional)│ │ ├── offset →
int│ │ └── length →
int│ ├── relative →
true (optional)│ ├── short_time →
true (optional)│ ├── long_time →
true (optional)│ ├── short_date →
true (optional)│ ├── long_date →
true (optional)│ ├── day_of_week →
true (optional)│ ├── offset →
int│ ├── length →
int│ └── date →
int├──
InputMediaDice│ └── emoticon →
string├──
InputMediaStory│ ├── peer →
InputPeer│ │ ├──
InputPeerEmpty│ │ ├──
InputPeerSelf│ │ ├──
InputPeerChat│ │ ├──
InputPeerUser│ │ ├──
InputPeerChannel│ │ ├──
InputPeerUserFromMessage│ │ └──
InputPeerChannelFromMessage│ └── id →
int│ ├── force_large_media →
true (optional)│ ├── force_small_media →
true (optional)│ ├── optional →
true (optional)│ └── url →
string│ ├── stars_amount →
long│ ├── extended_media →
Vector < InputMedia >│ │ ├──
InputMediaEmpty│ │ ├──
InputMediaUploadedPhoto│ │ │ ├── spoiler →
true (optional)│ │ │ ├── file →
InputFile│ │ │ │ ├──
InputFile│ │ │ │ ├──
InputFileBig│ │ │ │ └──
InputFileStoryDocument│ │ │ ├── stickers →
Vector < InputDocument > (optional)│ │ │ │ ├──
InputDocumentEmpty│ │ │ │ └──
InputDocument│ │ │ └── ttl_seconds →
int (optional)│ │ ├──
InputMediaPhoto│ │ │ ├── spoiler →
true (optional)│ │ │ ├── id →
InputPhoto│ │ │ │ ├──
InputPhotoEmpty│ │ │ │ └──
InputPhoto│ │ │ └── ttl_seconds →
int (optional)│ │ ├──
InputMediaGeoPoint│ │ │ └── geo_point →
InputGeoPoint│ │ │ ├──
InputGeoPointEmpty│ │ │ └──
InputGeoPoint│ │ ├──
InputMediaContact│ │ │ ├── phone_number →
string│ │ │ ├── first_name →
string│ │ │ ├── last_name →
string│ │ │ └── vcard →
string│ │ ├──
InputMediaUploadedDocument│ │ │ ├── nosound_video →
true (optional)│ │ │ ├── force_file →
true (optional)│ │ │ ├── spoiler →
true (optional)│ │ │ ├── file →
InputFile│ │ │ │ ├──
InputFile│ │ │ │ ├──
InputFileBig│ │ │ │ └──
InputFileStoryDocument│ │ │ ├── thumb →
InputFile (optional)│ │ │ │ ├──
InputFile│ │ │ │ ├──
InputFileBig│ │ │ │ └──
InputFileStoryDocument│ │ │ ├── mime_type →
string│ │ │ ├── attributes →
Vector < DocumentAttribute >│ │ │ │ ├──
DocumentAttributeImageSize│ │ │ │ ├──
DocumentAttributeAnimated│ │ │ │ ├──
DocumentAttributeSticker│ │ │ │ ├──
DocumentAttributeVideo│ │ │ │ ├──
DocumentAttributeAudio│ │ │ │ ├──
DocumentAttributeFilename│ │ │ │ ├──
DocumentAttributeHasStickers│ │ │ │ └──
DocumentAttributeCustomEmoji│ │ │ ├── stickers →
Vector < InputDocument > (optional)│ │ │ │ ├──
InputDocumentEmpty│ │ │ │ └──
InputDocument│ │ │ ├── video_cover →
InputPhoto (optional)│ │ │ │ ├──
InputPhotoEmpty│ │ │ │ └──
InputPhoto│ │ │ ├── video_timestamp →
int (optional)│ │ │ └── ttl_seconds →
int (optional)│ │ ├──
InputMediaDocument│ │ │ ├── spoiler →
true (optional)│ │ │ ├── id →
InputDocument│ │ │ │ ├──
InputDocumentEmpty│ │ │ │ └──
InputDocument│ │ │ ├── video_cover →
InputPhoto (optional)│ │ │ │ ├──
InputPhotoEmpty│ │ │ │ └──
InputPhoto│ │ │ ├── video_timestamp →
int (optional)│ │ │ ├── ttl_seconds →
int (optional)│ │ │ └── query →
string (optional)│ │ ├──
InputMediaVenue│ │ │ ├── geo_point →
InputGeoPoint│ │ │ │ ├──
InputGeoPointEmpty│ │ │ │ └──
InputGeoPoint│ │ │ ├── title →
string│ │ │ ├── address →
string│ │ │ ├── provider →
string│ │ │ ├── venue_id →
string│ │ │ └── venue_type →
string│ │ ├──
InputMediaPhotoExternal│ │ │ ├── spoiler →
true (optional)│ │ │ ├── url →
string│ │ │ └── ttl_seconds →
int (optional)│ │ ├──
InputMediaDocumentExternal│ │ │ ├── spoiler →
true (optional)│ │ │ ├── url →
string│ │ │ ├── ttl_seconds →
int (optional)│ │ │ ├── video_cover →
InputPhoto (optional)│ │ │ │ ├──
InputPhotoEmpty│ │ │ │ └──
InputPhoto│ │ │ └── video_timestamp →
int (optional)│ │ ├──
InputMediaGame│ │ │ └── id →
InputGame│ │ │ ├──
InputGameID│ │ │ └──
InputGameShortName│ │ ├──
InputMediaInvoice│ │ │ ├── title →
string│ │ │ ├── description →
string│ │ │ ├── photo →
InputWebDocument (optional)│ │ │ │ └──
InputWebDocument│ │ │ ├── invoice →
Invoice│ │ │ │ └──
Invoice│ │ │ ├── payload →
bytes│ │ │ ├── provider →
string (optional)│ │ │ ├── provider_data →
DataJSON│ │ │ │ └──
DataJSON│ │ │ ├── start_param →
string (optional)│ │ │ └── extended_media →
InputMedia (optional)│ │ │ ├──
InputMediaEmpty│ │ │ ├──
InputMediaUploadedPhoto│ │ │ ├──
InputMediaPhoto│ │ │ ├──
InputMediaGeoPoint│ │ │ ├──
InputMediaContact│ │ │ ├──
InputMediaUploadedDocument│ │ │ ├──
InputMediaDocument│ │ │ ├──
InputMediaVenue│ │ │ ├──
InputMediaPhotoExternal│ │ │ ├──
InputMediaDocumentExternal│ │ │ ├──
InputMediaGame│ │ │ ├──
InputMediaInvoice│ │ │ ├──
InputMediaGeoLive│ │ │ ├──
InputMediaPoll│ │ │ ├──
InputMediaDice│ │ │ ├──
InputMediaStory│ │ │ ├──
InputMediaWebPage│ │ │ ├──
InputMediaPaidMedia│ │ │ ├──
InputMediaTodo│ │ │ └──
InputMediaStakeDice│ │ ├──
InputMediaGeoLive│ │ │ ├── stopped →
true (optional)│ │ │ ├── geo_point →
InputGeoPoint│ │ │ │ ├──
InputGeoPointEmpty│ │ │ │ └──
InputGeoPoint│ │ │ ├── heading →
int (optional)│ │ │ ├── period →
int (optional)│ │ │ └── proximity_notification_radius →
int (optional)│ │ ├──
InputMediaPoll│ │ │ ├── poll →
Poll│ │ │ │ └──
Poll│ │ │ ├── correct_answers →
Vector < bytes > (optional)│ │ │ ├── solution →
string (optional)│ │ │ └── solution_entities →
Vector < MessageEntity > (optional)│ │ │ ├──
MessageEntityUnknown│ │ │ ├──
MessageEntityMention│ │ │ ├──
MessageEntityHashtag│ │ │ ├──
MessageEntityBotCommand│ │ │ ├──
MessageEntityUrl│ │ │ ├──
MessageEntityEmail│ │ │ ├──
MessageEntityBold│ │ │ ├──
MessageEntityItalic│ │ │ ├──
MessageEntityCode│ │ │ ├──
MessageEntityPre│ │ │ ├──
MessageEntityTextUrl│ │ │ ├──
MessageEntityMentionName│ │ │ ├──
InputMessageEntityMentionName│ │ │ ├──
MessageEntityPhone│ │ │ ├──
MessageEntityCashtag│ │ │ ├──
MessageEntityUnderline│ │ │ ├──
MessageEntityStrike│ │ │ ├──
MessageEntityBankCard│ │ │ ├──
MessageEntitySpoiler│ │ │ ├──
MessageEntityCustomEmoji│ │ │ ├──
MessageEntityBlockquote│ │ │ └──
MessageEntityFormattedDate│ │ ├──
InputMediaDice│ │ │ └── emoticon →
string│ │ ├──
InputMediaStory│ │ │ ├── peer →
InputPeer│ │ │ │ ├──
InputPeerEmpty│ │ │ │ ├──
InputPeerSelf│ │ │ │ ├──
InputPeerChat│ │ │ │ ├──
InputPeerUser│ │ │ │ ├──
InputPeerChannel│ │ │ │ ├──
InputPeerUserFromMessage│ │ │ │ └──
InputPeerChannelFromMessage│ │ │ └── id →
int│ │ ├──
InputMediaWebPage│ │ │ ├── force_large_media →
true (optional)│ │ │ ├── force_small_media →
true (optional)│ │ │ ├── optional →
true (optional)│ │ │ └── url →
string│ │ ├──
InputMediaPaidMedia│ │ │ ├── stars_amount →
long│ │ │ ├── extended_media →
Vector < InputMedia >│ │ │ │ ├──
InputMediaEmpty│ │ │ │ ├──
InputMediaUploadedPhoto│ │ │ │ ├──
InputMediaPhoto│ │ │ │ ├──
InputMediaGeoPoint│ │ │ │ ├──
InputMediaContact│ │ │ │ ├──
InputMediaUploadedDocument│ │ │ │ ├──
InputMediaDocument│ │ │ │ ├──
InputMediaVenue│ │ │ │ ├──
InputMediaPhotoExternal│ │ │ │ ├──
InputMediaDocumentExternal│ │ │ │ ├──
InputMediaGame│ │ │ │ ├──
InputMediaInvoice│ │ │ │ ├──
InputMediaGeoLive│ │ │ │ ├──
InputMediaPoll│ │ │ │ ├──
InputMediaDice│ │ │ │ ├──
InputMediaStory│ │ │ │ ├──
InputMediaWebPage│ │ │ │ ├──
InputMediaPaidMedia│ │ │ │ ├──
InputMediaTodo│ │ │ │ └──
InputMediaStakeDice│ │ │ └── payload →
string (optional)│ │ ├──
InputMediaTodo│ │ │ └── todo →
TodoList│ │ │ └──
TodoList│ │ └──
InputMediaStakeDice│ │ ├── game_hash →
string│ │ ├── ton_amount →
long│ │ └── client_seed →
bytes│ └── payload →
string (optional)├──
InputMediaTodo│ └── todo →
TodoList│ └──
TodoList│ ├── others_can_append →
true (optional)│ ├── others_can_complete →
true (optional)│ ├── title →
TextWithEntities│ │ └──
TextWithEntities│ └── list →
Vector < TodoItem >│ └──
TodoItem├── game_hash →
string├── ton_amount →
long└── client_seed →
bytes