forward_story()

Client.forward_story()

Forward story.

Usable by Users Bots
Parameters:

  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

  • from_chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

  • story_id (int) – Unique identifier of story.

  • disable_notification (bool, optional) – Sends the message with story silently. Users will receive a notification with no sound.

  • message_thread_id (int, optional) – Unique identifier for the target message thread (topic) of the forum. For supergroups only.

  • schedule_date (datetime, optional) – Date when the message will be automatically sent.

  • repeat_period (int, optional) – Period after which the message will be sent again in seconds.

  • paid_message_star_count (int, optional) – The number of Telegram Stars the user agreed to pay to send the messages.

  • protect_content (bool, optional) – Pass True if the content of the message must be protected from forwarding and saving; for bots only.

  • allow_paid_broadcast (bool, optional) – Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only

  • reply_parameters (ReplyParameters, optional) – Description of the message to reply to.

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • message_effect_id (int 64-bit, optional) – Unique identifier of the message effect to be added to the message; for private chats only.

Returns:

Message – On success, the sent story message is returned.

Example

# Send your story to chat_id
await app.forward_story(to_chat, from_chat, 123)