SponsoredMessage
- class pyrogram.raw.types.SponsoredMessage
A sponsored message.
Constructor of
SponsoredMessage.- Details:
Layer:
223ID:
7DBF8673
- Parameters:
random_id (
bytes) – Message IDurl (
str) – Contains the URL to open when the user clicks on the sponsored message.title (
str) – Contains the title of the sponsored message.message (
str) – Sponsored messagebutton_text (
str) – Label of the sponsored message button.recommended (
bool, optional) – Whether the message needs to be labeled as “recommended” instead of “sponsored”can_report (
bool, optional) – Whether this message can be reported as specified here ».entities (List of
MessageEntity, optional) – Message entities for styled text in message.photo (
Photo, optional) – If set, contains a custom profile photo bubble that should be displayed for the sponsored message, like for messages sent in groups.media (
MessageMedia, optional) – If set, contains some media.color (
PeerColor, optional) – If set, the sponsored message should use the message accent color » specified in color.sponsor_info (
str, optional) – If set, contains additional information about the sponsor to be shown along with the message.additional_info (
str, optional) – If set, contains additional information about the sponsored message to be shown along with the message.min_display_duration (
int32-bit, optional) – For sponsored messages to show on channel videos », allow the user to hide the ad only after the specified amount of seconds.max_display_duration (
int32-bit, optional) – For sponsored messages to show on channel videos », autohide the ad after after the specified amount of seconds.
TL Schema
sponsoredMessage#7dbf8673
flags:#
recommended:flags.5?true
can_report:flags.12?true
random_id:bytes
url:string
title:string
message:string
entities:flags.1?Vector<MessageEntity>
photo:flags.6?Photo
media:flags.14?MessageMedia
color:flags.13?PeerColor
button_text:string
sponsor_info:flags.7?string
additional_info:flags.8?string
min_display_duration:flags.15?int
max_display_duration:flags.15?int
= SponsoredMessage
Parameter Tree
true (optional)true (optional)bytesstringstringstringVector < MessageEntity > (optional)MessageEntityUnknownintintMessageEntityMentionintintMessageEntityHashtagintintMessageEntityBotCommandintintMessageEntityUrlintintMessageEntityEmailintintMessageEntityBoldintintMessageEntityItalicintintMessageEntityCodeintintMessageEntityPreintintstringMessageEntityTextUrlintintstringMessageEntityMentionNameintintlongintintInputUserInputUserEmptyInputUserSelfInputUserInputUserFromMessageMessageEntityPhoneintintMessageEntityCashtagintintMessageEntityUnderlineintintMessageEntityStrikeintintMessageEntityBankCardintintMessageEntitySpoilerintintMessageEntityCustomEmojiintintlongMessageEntityBlockquotetrue (optional)intinttrue (optional)true (optional)true (optional)true (optional)true (optional)true (optional)intintintPhoto (optional)PhotoEmptylongPhototrue (optional)longlongbytesintVector < PhotoSize >PhotoSizeEmptystringPhotoSizestringintintintPhotoCachedSizestringintintbytesPhotoStrippedSizestringbytesPhotoSizeProgressivestringintintVector < int >PhotoPathSizestringbytesVector < VideoSize > (optional)VideoSizestringintintintdouble (optional)VideoSizeEmojiMarkuplongVector < int >VideoSizeStickerMarkupInputStickerSetInputStickerSetEmptyInputStickerSetIDInputStickerSetShortNameInputStickerSetAnimatedEmojiInputStickerSetDiceInputStickerSetAnimatedEmojiAnimationsInputStickerSetPremiumGiftsInputStickerSetEmojiGenericAnimationsInputStickerSetEmojiDefaultStatusesInputStickerSetEmojiDefaultTopicIconsInputStickerSetTonGiftslongVector < int >intMessageMedia (optional)MessageMediaEmptyMessageMediaPhototrue (optional)Photo (optional)PhotoEmptylongPhototrue (optional)longlongbytesintVector < PhotoSize >PhotoSizeEmptyPhotoSizePhotoCachedSizePhotoStrippedSizePhotoSizeProgressivePhotoPathSizeVector < VideoSize > (optional)VideoSizeVideoSizeEmojiMarkupVideoSizeStickerMarkupintint (optional)MessageMediaGeoGeoPointGeoPointEmptyGeoPointdoubledoublelongint (optional)MessageMediaContactstringstringstringstringlongMessageMediaUnsupportedMessageMediaDocumenttrue (optional)true (optional)true (optional)true (optional)true (optional)Document (optional)DocumentEmptylongDocumentlonglongbytesintstringlongVector < PhotoSize > (optional)PhotoSizeEmptyPhotoSizePhotoCachedSizePhotoStrippedSizePhotoSizeProgressivePhotoPathSizeVector < VideoSize > (optional)VideoSizeVideoSizeEmojiMarkupVideoSizeStickerMarkupintVector < DocumentAttribute >DocumentAttributeImageSizeDocumentAttributeAnimatedDocumentAttributeStickerDocumentAttributeVideoDocumentAttributeAudioDocumentAttributeFilenameDocumentAttributeHasStickersDocumentAttributeCustomEmojiVector < Document > (optional)DocumentEmptylongDocumentlonglongbytesintstringlongVector < PhotoSize > (optional)PhotoSizeEmptyPhotoSizePhotoCachedSizePhotoStrippedSizePhotoSizeProgressivePhotoPathSizeVector < VideoSize > (optional)VideoSizeVideoSizeEmojiMarkupVideoSizeStickerMarkupintVector < DocumentAttribute >DocumentAttributeImageSizeDocumentAttributeAnimatedDocumentAttributeStickerDocumentAttributeVideoDocumentAttributeAudioDocumentAttributeFilenameDocumentAttributeHasStickersDocumentAttributeCustomEmojiPhoto (optional)PhotoEmptylongPhototrue (optional)longlongbytesintVector < PhotoSize >PhotoSizeEmptyPhotoSizePhotoCachedSizePhotoStrippedSizePhotoSizeProgressivePhotoPathSizeVector < VideoSize > (optional)VideoSizeVideoSizeEmojiMarkupVideoSizeStickerMarkupintint (optional)int (optional)MessageMediaWebPagetrue (optional)true (optional)true (optional)true (optional)WebPageWebPageEmptylongstring (optional)WebPagePendinglongstring (optional)intWebPagetrue (optional)true (optional)longstringstringintstring (optional)string (optional)string (optional)string (optional)Photo (optional)PhotoEmptyPhotostring (optional)string (optional)int (optional)int (optional)int (optional)string (optional)Document (optional)DocumentEmptyDocumentPage (optional)PageVector < WebPageAttribute > (optional)WebPageAttributeThemeWebPageAttributeStoryWebPageAttributeStickerSetWebPageAttributeUniqueStarGiftWebPageAttributeStarGiftCollectionWebPageAttributeStarGiftAuctionWebPageNotModifiedint (optional)MessageMediaVenueGeoPointGeoPointEmptyGeoPointdoubledoublelongint (optional)stringstringstringstringstringMessageMediaGameGameGamelonglongstringstringstringPhotoPhotoEmptyPhotoDocument (optional)DocumentEmptyDocumentMessageMediaInvoicetrue (optional)true (optional)stringstringWebDocument (optional)WebDocumentstringlongintstringVector < DocumentAttribute >DocumentAttributeImageSizeDocumentAttributeAnimatedDocumentAttributeStickerDocumentAttributeVideoDocumentAttributeAudioDocumentAttributeFilenameDocumentAttributeHasStickersDocumentAttributeCustomEmojiWebDocumentNoProxystringintstringVector < DocumentAttribute >DocumentAttributeImageSizeDocumentAttributeAnimatedDocumentAttributeStickerDocumentAttributeVideoDocumentAttributeAudioDocumentAttributeFilenameDocumentAttributeHasStickersDocumentAttributeCustomEmojiint (optional)stringlongstringMessageExtendedMedia (optional)MessageExtendedMediaPreviewint (optional)int (optional)PhotoSize (optional)PhotoSizeEmptyPhotoSizePhotoCachedSizePhotoStrippedSizePhotoSizeProgressivePhotoPathSizeint (optional)MessageExtendedMediaMessageMediaMessageMediaEmptyMessageMediaPhotoMessageMediaGeoMessageMediaContactMessageMediaUnsupportedMessageMediaDocumentMessageMediaWebPageMessageMediaVenueMessageMediaGameMessageMediaInvoiceMessageMediaGeoLiveMessageMediaPollMessageMediaDiceMessageMediaStoryMessageMediaGiveawayMessageMediaGiveawayResultsMessageMediaPaidMediaMessageMediaToDoMessageMediaVideoStreamMessageMediaGeoLiveGeoPointGeoPointEmptyGeoPointdoubledoublelongint (optional)int (optional)intint (optional)MessageMediaPollPollPolllongtrue (optional)true (optional)true (optional)true (optional)TextWithEntitiesTextWithEntitiesVector < PollAnswer >PollAnswerint (optional)int (optional)PollResultsPollResultstrue (optional)Vector < PollAnswerVoters > (optional)PollAnswerVotersint (optional)Vector < Peer > (optional)PeerUserPeerChatPeerChannelstring (optional)Vector < MessageEntity > (optional)MessageEntityUnknownMessageEntityMentionMessageEntityHashtagMessageEntityBotCommandMessageEntityUrlMessageEntityEmailMessageEntityBoldMessageEntityItalicMessageEntityCodeMessageEntityPreMessageEntityTextUrlMessageEntityMentionNameInputMessageEntityMentionNameMessageEntityPhoneMessageEntityCashtagMessageEntityUnderlineMessageEntityStrikeMessageEntityBankCardMessageEntitySpoilerMessageEntityCustomEmojiMessageEntityBlockquoteMessageEntityFormattedDateMessageMediaDiceintstringmessages.EmojiGameOutcome (optional)messages.EmojiGameOutcomebyteslonglongMessageMediaStorytrue (optional)PeerPeerUserlongPeerChatlongPeerChannellongintStoryItem (optional)StoryItemDeletedintStoryItemSkippedtrue (optional)true (optional)intintintStoryItemtrue (optional)true (optional)true (optional)true (optional)true (optional)true (optional)true (optional)true (optional)true (optional)intintPeer (optional)PeerUserPeerChatPeerChannelStoryFwdHeader (optional)StoryFwdHeaderintstring (optional)Vector < MessageEntity > (optional)MessageEntityUnknownMessageEntityMentionMessageEntityHashtagMessageEntityBotCommandMessageEntityUrlMessageEntityEmailMessageEntityBoldMessageEntityItalicMessageEntityCodeMessageEntityPreMessageEntityTextUrlMessageEntityMentionNameInputMessageEntityMentionNameMessageEntityPhoneMessageEntityCashtagMessageEntityUnderlineMessageEntityStrikeMessageEntityBankCardMessageEntitySpoilerMessageEntityCustomEmojiMessageEntityBlockquoteMessageEntityFormattedDateMessageMediaMessageMediaEmptyMessageMediaPhotoMessageMediaGeoMessageMediaContactMessageMediaUnsupportedMessageMediaDocumentMessageMediaWebPageMessageMediaVenueMessageMediaGameMessageMediaInvoiceMessageMediaGeoLiveMessageMediaPollMessageMediaDiceMessageMediaStoryMessageMediaGiveawayMessageMediaGiveawayResultsMessageMediaPaidMediaMessageMediaToDoMessageMediaVideoStreamVector < MediaArea > (optional)MediaAreaVenueInputMediaAreaVenueMediaAreaGeoPointMediaAreaSuggestedReactionMediaAreaChannelPostInputMediaAreaChannelPostMediaAreaUrlMediaAreaWeatherMediaAreaStarGiftVector < PrivacyRule > (optional)PrivacyValueAllowContactsPrivacyValueAllowAllPrivacyValueAllowUsersPrivacyValueDisallowContactsPrivacyValueDisallowAllPrivacyValueDisallowUsersPrivacyValueAllowChatParticipantsPrivacyValueDisallowChatParticipantsPrivacyValueAllowCloseFriendsPrivacyValueAllowPremiumPrivacyValueAllowBotsPrivacyValueDisallowBotsStoryViews (optional)StoryViewsReaction (optional)ReactionEmptyReactionEmojiReactionCustomEmojiReactionPaidVector < int > (optional)MessageMediaGiveawaytrue (optional)true (optional)Vector < long >Vector < string > (optional)string (optional)intint (optional)long (optional)inttrue (optional)true (optional)longint (optional)intintintVector < long >int (optional)long (optional)string (optional)intMessageMediaPaidMedialongVector < MessageExtendedMedia >MessageExtendedMediaPreviewint (optional)int (optional)PhotoSize (optional)PhotoSizeEmptyPhotoSizePhotoCachedSizePhotoStrippedSizePhotoSizeProgressivePhotoPathSizeint (optional)MessageExtendedMediaMessageMediaMessageMediaEmptyMessageMediaPhotoMessageMediaGeoMessageMediaContactMessageMediaUnsupportedMessageMediaDocumentMessageMediaWebPageMessageMediaVenueMessageMediaGameMessageMediaInvoiceMessageMediaGeoLiveMessageMediaPollMessageMediaDiceMessageMediaStoryMessageMediaGiveawayMessageMediaGiveawayResultsMessageMediaPaidMediaMessageMediaToDoMessageMediaVideoStreamMessageMediaToDoTodoListTodoListtrue (optional)true (optional)TextWithEntitiesTextWithEntitiesVector < TodoItem >TodoItemVector < TodoCompletion > (optional)TodoCompletionintPeerPeerUserPeerChatPeerChannelintMessageMediaVideoStreamtrue (optional)InputGroupCallInputGroupCalllonglongInputGroupCallSlugstringintPeerColor (optional)PeerColorint (optional)long (optional)PeerColorCollectiblelonglonglongintVector < int >int (optional)Vector < int > (optional)longstringstring (optional)string (optional)int (optional)int (optional)Example
SponsoredMessage(
random_id=b"data",
url="https://google.com",
title="text",
message="Hello",
button_text="text",
)