Link Search Menu Expand Document

Method: stories.sendStory

Back to methods index

Uploads a Telegram Story.


pinnedBoolWhether to add the story to the profile automatically upon expiration. If not set, the story will only be added to the archive, see here » for more info.Optional
noforwardsBoolIf set, disables forwards, screenshots, and downloads.Optional
fwd_modifiedBoolSet this flag when reposting stories with fwd_from_id+fwd_from_id, if the media was modified before reposting.Optional
peerUsername, chat ID, Update, Message or InputPeerThe peer to send the story as.Optional
mediaMessageMedia, Update, Message or InputMediaThe story media.Optional
media_areasArray of MediaAreaMedia areas associated to the story, see here » for more info.Optional
captionstringStory caption.Optional
entitiesArray of MessageEntityMessage entities for styled text, if allowed by the stories_entities client configuration parameter ».Optional
parse_modestringWhether to parse HTML or Markdown markup in the messageOptional
privacy_rulesArray of InputPrivacyRulePrivacy rules for the story, indicating who can or can’t view the story.Yes
periodintPeriod after which the story is moved to archive (and to the profile if pinned is set), in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise.Optional
fwd_from_idUsername, chat ID, Update, Message or InputPeerIf set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id.Optional
fwd_from_storyintIf set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id.Optional

Return type: Updates

Can bots use this method: NO

MadelineProto Example (now async for huge speed and parallelism!):

if (!file_exists('madeline.php')) {
    copy('', 'madeline.php');
include 'madeline.php';

$MadelineProto = new \danog\MadelineProto\API('session.madeline');

$Updates = $MadelineProto->stories->sendStory(pinned: $Bool, noforwards: $Bool, fwd_modified: $Bool, peer: $InputPeer, media: $InputMedia, media_areas: [$MediaArea, $MediaArea], caption: 'string', entities: [$MessageEntity, $MessageEntity], parse_mode: 'string', privacy_rules: [$InputPrivacyRule, $InputPrivacyRule], period: $int, fwd_from_id: $InputPeer, fwd_from_story: $int, );

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>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>
<blockquote>pre-formatted fixed-width code block</blockquote>
<a href="">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>

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_
*bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold*
[inline URL](
[inline mention of a user](tg://user?id=123456789)
\`inline fixed-width code\`
pre-formatted fixed-width code block
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)