Link Search Menu Expand Document

Method: stories.editStory

Back to methods index

Edit an uploaded story

Parameters:

NameTypeDescriptionRequired
peerUsername, chat ID, Update, Message or InputPeerPeer where the story was posted.Optional
idintID of story to edit.Optional
mediaMessageMedia, Update, Message or InputMediaIf specified, replaces the story media.Optional
media_areasArray of MediaAreaMedia areas associated to the story, see here ยป for more info.Optional
captionstringIf specified, replaces the story caption.Optional
entitiesArray of MessageEntityMessage entities for styled text in the caption, if allowed by the stories_entities client configuration parameter ยป.Optional
parse_modestringWhether to parse HTML or Markdown markup in the messageOptional
privacy_rulesArray of InputPrivacyRuleIf specified, alters the privacy settings ยป of the story, changing who can or can’t view the story.Optional

Return type: Updates

Can userbots use this method: YES

Can bots use this method: NO

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

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

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

$Updates = $MadelineProto->stories->editStory(peer: $InputPeer, id: $int, media: $InputMedia, media_areas: [$MediaArea, $MediaArea], caption: 'string', entities: [$MessageEntity, $MessageEntity], parse_mode: 'string', privacy_rules: [$InputPrivacyRule, $InputPrivacyRule], );

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)