Start a live story, optionally using RTMP livestream mode, see here » for the full flow.
API section: Working with live stories »
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;
| Name | Type | Description |
|---|---|---|
| flags | # | Bit mask: a field written flags.N?T is present only when bit N is set. |
| pinned | flags.2?true | Whether it is pinned. |
| noforwards | flags.4?true | |
| rtmp_stream | flags.5?true | |
| peer | InputPeer | The user or chat the request is about. |
| caption | flags.0?string | Caption for the attachment. |
| entities | flags.1?Vector<MessageEntity> | Text markup — bold, links, mentions and so on, as a list of ranges. |
| privacy_rules | Vector<InputPrivacyRule> | |
| random_id | long | A random number from the client. The server uses it to discard duplicates when a request goes out twice. |
| messages_enabled | flags.6?Bool | |
| send_paid_messages_stars | flags.7?long |
This method has no errors of its own: it either answers or fails on the shared checks below.
| Code | Type | What it means |
|---|---|---|
| 401 | AUTH_KEY_UNREGISTERED |
The server does not know this session: the key was revoked, expired, or the call was made before authorisation. |
| 401 | API_ID_INVALID |
This api_id was never issued or has been blocked. Keys come from my.ansible.su. |
| 400 | CONNECTION_LAYER_INVALID |
The client did not declare a layer, or declared one the server does not know. |
| 420 | FLOOD_WAIT_X |
Too often. Do not retry for X seconds — the number arrives in the error text. |
| 500 | INTERNAL |
A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours. |