forward_story()

Client.forward_story()

Forward a story.

Usable by Users Bots
Parameters:

  • from_chat_id (int | str) – Unique identifier (int) or username (str) of the target chat/user. For your personal story you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str). You can also use user profile/channel public link in form of t.me/<username> (str).

  • from_story_id (int) – Unique identifier of original story.

  • chat_id (int | str, optional) – Unique identifier (int) or username (str) of the target channel. If you want to forward story to a channel. You can also use channel public link in form of t.me/<username> (str).

  • privacy (StoriesPrivacyRules, optional) – Story privacy. Defaults to PUBLIC

  • allowed_users (List of int, optional) – List of user_id whos allowed to view the story.

  • denied_users (List of int, optional) – List of user_id whos denied to view the story.

  • pinned (bool, optional) – if True, the story will be pinned. default to False.

  • protect_content (bool, optional) – Protects the contents of the sent story from forwarding and saving. default to False.

  • caption (str, optional) – Story caption, 0-1024 characters.

  • parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • caption_entities (List of MessageEntity) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

  • period (int, optional) – How long the story will posted, in secs. only for premium users.

Returns:

Story a single story is returned.

Example

# forward a story
await app.forward_story(from_chat_id='wulan17', from_story_id=1, caption='Hello guys.')
Raises:

ValueError – In case of invalid arguments.