stories.startLive

Start a live story, optionally using RTMP livestream mode, see here » for the full flow.

updatesTooLong#e317af7e = Updates;
updateShortMessage#313bc7f8 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:int user_id:long message:string pts:int pts_count:int date:int fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?long reply_to:flags.3?MessageReplyHeader entities:flags.7?Vector<MessageEntity> ttl_period:flags.25?int = Updates;
updateShortChatMessage#4d6deea5 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:int from_id:long chat_id:long message:string pts:int pts_count:int date:int fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?long reply_to:flags.3?MessageReplyHeader entities:flags.7?Vector<MessageEntity> ttl_period:flags.25?int = Updates;
updateShort#78d4dec1 update:Update date:int = Updates;
updatesCombined#725b04c3 updates:Vector<Update> users:Vector<User> chats:Vector<Chat> date:int seq_start:int seq:int = Updates;
updates#74ae4240 updates:Vector<Update> users:Vector<User> chats:Vector<Chat> date:int seq:int = Updates;
updateShortSentMessage#9015e101 flags:# out:flags.1?true id:int pts:int pts_count:int date:int media:flags.9?MessageMedia entities:flags.7?Vector<MessageEntity> ttl_period:flags.25?int = Updates;
---functions---
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;

Parameters

Name Type Description
flags # Flags, see TL conditional fields
pinned flags.2?true Whether to pin the live story on the peer's profile
noforwards flags.4?true Whether viewers must be prevented from forwarding or saving the live story
rtmp_stream flags.5?true Create the live story in RTMP livestream mode », where one external streamer publishes all audio and video
peer InputPeer User, supergroup or channel that will own the live story; basic groups cannot post live stories
caption flags.0?string Live story caption
entities flags.1?Vector<MessageEntity> Message entities for styled text
privacy_rules Vector<InputPrivacyRule> Privacy rules defining who can view the live story
random_id long Client-generated random ID used to prevent duplicate live stories
messages_enabled flags.6?Bool Whether the in-call message overlay » should be enabled
send_paid_messages_stars flags.7?long Minimum Telegram Stars donation required from users other than the live story owner for each comment; the owner may always comment without donating, and 0 allows free comments for everyone

Result

Updates

Only users can use this method

Possible errors

Code Type Description
400 CHANNEL_MONOFORUM_UNSUPPORTED Monoforums do not support this feature.
400 CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this.
400 PEER_ID_INVALID The provided peer id is invalid.
400 STORY_LIVE_ALREADY_%d This peer already has an active live story, and its ID is equal to %d.

Related pages

Group calls

Styled text with message entities

How to create styled text with message entities

Channels, supergroups, gigagroups and basic groups

How to handle channels, supergroups, gigagroups, basic groups, and what's the difference between them.