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”
can_reportBoolOptionalWhether this message can be reported as specified here ยป.
random_idbytesYesMessage ID
urlstringYesContains the URL to open when the user clicks on the sponsored message.
titlestringYesContains the title of the sponsored message.
messagestringYesSponsored message
entitiesArray of MessageEntityOptionalMessage entities for styled text in message.
parse_modestringWhether to parse HTML or Markdown markup in the messageOptional
photoPhotoOptionalIf set, contains a custom profile photo bubble that should be displayed for the sponsored message, like for messages sent in groups.
mediaMessageMediaOptionalIf set, contains some media.
colorPeerColorOptionalIf set, the sponsored message should use the message accent color ยป specified in color.
button_textstringYesLabel of the sponsored message button.
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 markdown 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, 'can_report' => Bool, 'random_id' => 'bytes', 'url' => 'string', 'title' => 'string', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]parse_mode: 'string', , 'photo' => Photo, 'media' => MessageMedia, 'color' => PeerColor, 'button_text' => 'string', 'sponsor_info' => 'string', 'additional_info' => 'string'];