stories.StartLive

class pyrogram.raw.functions.stories.StartLive

{schema}

Details:

  • Layer: 223

  • ID: D069CCDE

Parameters:

  • peer (InputPeer)

  • privacy_rules (List of InputPrivacyRule)

  • random_id (int 64-bit)

  • pinned (bool, optional)

  • noforwards (bool, optional)

  • rtmp_stream (bool, optional)

  • caption (str, optional)

  • entities (List of MessageEntity, optional) – Message entities for styled text

  • messages_enabled (bool, optional)

  • send_paid_messages_stars (int 64-bit, optional)

Returns:

Updates

TL Schema

stories.startLive#d069ccde
flags:#
pinned:flags.2?true
noforwards:flags.4?true
rtmp_stream:flags.5?true
peer:InputPeer
caption:flags.0?string
entities:flags.1?Vector<MessageEntity>
privacy_rules:Vector<InputPrivacyRule>
random_id:long
messages_enabled:flags.6?Bool
send_paid_messages_stars:flags.7?long

= Updates

Parameter Tree

StartLive
├── pinned → true (optional)
├── noforwards → true (optional)
├── rtmp_stream → true (optional)
├── peer → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ │ └── chat_id → long
│ ├── InputPeerUser
│ │ ├── user_id → long
│ │ └── access_hash → long
│ ├── InputPeerChannel
│ │ ├── channel_id → long
│ │ └── access_hash → long
│ ├── InputPeerUserFromMessage
│ │ ├── peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── msg_id → int
│ │ └── user_id → long
│ └── InputPeerChannelFromMessage
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── msg_id → int
│ └── channel_id → long
├── caption → string (optional)
├── entities → Vector < MessageEntity > (optional)
│ ├── MessageEntityUnknown
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityMention
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityHashtag
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBotCommand
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityUrl
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityEmail
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBold
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityItalic
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCode
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityPre
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── language → string
│ ├── MessageEntityTextUrl
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── url → string
│ ├── MessageEntityMentionName
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── user_id → long
│ ├── InputMessageEntityMentionName
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── user_id → InputUser
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ └── InputUserFromMessage
│ ├── MessageEntityPhone
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCashtag
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityUnderline
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityStrike
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBankCard
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntitySpoiler
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCustomEmoji
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── document_id → long
│ ├── MessageEntityBlockquote
│ │ ├── collapsed → true (optional)
│ │ ├── offset → int
│ │ └── length → int
│ └── MessageEntityFormattedDate
│ ├── relative → true (optional)
│ ├── short_time → true (optional)
│ ├── long_time → true (optional)
│ ├── short_date → true (optional)
│ ├── long_date → true (optional)
│ ├── day_of_week → true (optional)
│ ├── offset → int
│ ├── length → int
│ └── date → int
├── privacy_rules → Vector < InputPrivacyRule >
│ ├── InputPrivacyValueAllowContacts
│ ├── InputPrivacyValueAllowAll
│ ├── InputPrivacyValueAllowUsers
│ │ └── users → Vector < InputUser >
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ │ ├── user_id → long
│ │ │ └── access_hash → long
│ │ └── InputUserFromMessage
│ │ ├── peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── msg_id → int
│ │ └── user_id → long
│ ├── InputPrivacyValueDisallowContacts
│ ├── InputPrivacyValueDisallowAll
│ ├── InputPrivacyValueDisallowUsers
│ │ └── users → Vector < InputUser >
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ │ ├── user_id → long
│ │ │ └── access_hash → long
│ │ └── InputUserFromMessage
│ │ ├── peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── msg_id → int
│ │ └── user_id → long
│ ├── InputPrivacyValueAllowChatParticipants
│ │ └── chats → Vector < long >
│ ├── InputPrivacyValueDisallowChatParticipants
│ │ └── chats → Vector < long >
│ ├── InputPrivacyValueAllowCloseFriends
│ ├── InputPrivacyValueAllowPremium
│ ├── InputPrivacyValueAllowBots
│ └── InputPrivacyValueDisallowBots
├── random_id → long
├── messages_enabled → Bool (optional)
└── send_paid_messages_stars → long (optional)

Example

await app.invoke(
    StartLive(
        pinned=None,
        noforwards=None,
        rtmp_stream=None,
        peer=await app.resolve_peer(chat_id),
        caption="text",
        entities=[
                MessageEntityUnknown(
                    offset=0,
                    length=0
                )
            ],
        privacy_rules=[
                InputPrivacyValueAllowContacts()
            ],
        random_id=app.rnd_id(),
        messages_enabled=None,
        send_paid_messages_stars=0,
    )
)