Start a live story, optionally using RTMP livestream mode, see here » for the full flow.
Method schema is available as of layer 217. Switch »
| 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 |
| 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. |
How to start, join and manage group calls and video chats.
How to create styled text with message entities
How to handle channels, supergroups, gigagroups, basic groups, and what's the difference between them.