Link Search Menu Expand Document

Constructor: sponsoredMessage

Back to constructors index

A sponsored message.

Attributes:

NameTypeRequiredDescription
recommendedBoolOptionalWhether the message needs to be labeled as “recommended” instead of “sponsored”
show_peer_photoBoolOptionalWhether a profile photo bubble should be displayed for this message, like for messages sent in groups. The photo shown in the bubble is obtained either from the peer contained in from_id, or from chat_invite.
from_idPeerOptionalID of the sender of the message
chat_inviteChatInviteOptionalInformation about the chat invite hash specified in chat_invite_hash
chat_invite_hashstringOptionalChat invite
channel_postintOptionalOptional link to a channel post if from_id points to a channel
start_paramstringOptionalParameter for the bot start message if the sponsored chat is a chat with a bot.
webpageSponsoredWebPageOptional
messagestringYesSponsored message
entitiesArray of MessageEntityOptionalMessage entities for styled text
parse_modestringWhether to parse HTML or Markdown markup in the messageOptional
sponsor_infostringOptionalIf set, contains additional information about the sponsor to be shown along with the message.
additional_infostringOptionalIf set, contains additional information about the sponsored message to be shown along with the message.

Type: SponsoredMessage

Usage of parse_mode:

Set parse_mode to html to enable HTML parsing of the message.

Set parse_mode to Markdown to enable markown AND html parsing of the message.

The following tags are currently supported:

<br>a newline
<b><i>bold works ok, internal tags are stripped</i> </b>
<strong>bold</strong>
<em>italic</em>
<i>italic</i>
<u>underline</u>
<s>strikethrough</s>
<del>strikethrough</del>
<strike>strikethrough</strike>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<blockquote>pre-formatted fixed-width code block</blockquote>
<a href="https://github.com">URL</a>
<a href="mention:@danogentili">Mention by username</a>
<a href="mention:186785362">Mention by user id</a>
<a href="tg://user?id=186785362">Mention by user id</a>
Custom emoji: <emoji id="5368324170671202286">👍</emoji>
Custom emoji: <tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
<pre language="json">Pre tags can have a language attribute</pre>
<spoiler>Spoiler</spoiler>
<tg-spoiler>Spoiler</tg-spoiler>

You can also use normal markdown (bot API MarkdownV2 syntax), note that to create mentions you can also use the mention: syntax like in html:

*bold \*text*
_italic \*text_
__underline__
~strikethrough~
||spoiler||
*bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold*
[inline URL](http://www.example.com/)
[inline mention of a user](tg://user?id=123456789)
![👍](tg://emoji?id=5368324170671202286)
\`inline fixed-width code\`
\`\`\`
pre-formatted fixed-width code block
\`\`\`
\`\`\`php
pre-formatted fixed-width code block written in the PHP programming language
\`\`\`

[Mention by username](mention:@danogentili)
[Mention by user id](mention:186785362)
[Mention by user id](tg://user?id=186785362)
[👍](emoji:5368324170671202286)
[👍](tg://emoji?id=5368324170671202286)

Example:

$sponsoredMessage = ['_' => 'sponsoredMessage', 'recommended' => Bool, 'show_peer_photo' => Bool, 'from_id' => Peer, 'chat_invite' => ChatInvite, 'chat_invite_hash' => 'string', 'channel_post' => int, 'start_param' => 'string', 'webpage' => SponsoredWebPage, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]parse_mode: 'string', , 'sponsor_info' => 'string', 'additional_info' => 'string'];