start_live_story()

async Client.start_live_story()

Start a live stream broadcast in a story.

Usable by Users Bots
Parameters:
  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat.

  • caption (str, optional) – Caption for the live stream story.

  • privacy_rules (List of InputPrivacyRule, optional) – Privacy rules for who can view the live story.

  • pinned (bool, optional) – Whether to pin the story to the profile.

  • noforwards (bool, optional) – Whether to disable forwarding and saving of the live story.

  • rtmp_stream (bool, optional) – Whether to use RTMP stream.

  • messages_enabled (bool, optional) – Whether comments / live chat messages are enabled.

  • send_paid_messages_stars (int, optional) – Stars required to send live messages.

Returns:

Updates – On success, updates object is returned.

Example

await app.start_live_story(chat_id, caption="Going live!")