Uploads a Telegram Story.
Method schema is available as of layer 161. Switch »
| Name | Type | Description |
|---|---|---|
| flags | # | Flags, see TL conditional fields |
| pinned | flags.2?true | Whether to add the story to the profile automatically upon expiration. If not set, the story will only be added to the archive, see here » for more info. |
| noforwards | flags.4?true | If set, disables forwards, screenshots, and downloads. |
| fwd_modified | flags.7?true | Set this flag when reposting stories with fwd_from_id+fwd_from_id, if the media was modified before reposting. |
| peer | InputPeer | The peer to send the story as. |
| media | InputMedia | The story media. |
| media_areas | flags.5?Vector<MediaArea> | Media areas associated to the story, see here » for more info. |
| caption | flags.0?string | Story caption. |
| entities | flags.1?Vector<MessageEntity> | Message entities for styled text, if allowed by the stories_entities client configuration parameter ». |
| privacy_rules | Vector<InputPrivacyRule> | Privacy rules for the story, indicating who can or can't view the story. |
| random_id | long | Unique client message ID required to prevent message resending. |
| period | flags.3?int | Period after which the story is moved to archive (and to the profile if pinned is set), in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise. |
| fwd_from_id | flags.6?InputPeer | If set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id. |
| fwd_from_story | flags.6?int | If set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id. |
| Code | Type | Description |
|---|---|---|
| 400 | IMAGE_PROCESS_FAILED | Failure while processing image. |
| 400 | MEDIA_EMPTY | The provided media object is invalid. |
| 400 | MEDIA_FILE_INVALID | The specified media file is invalid. |
| 400 | MEDIA_TYPE_INVALID | The specified media type cannot be used in stories. |
| 400 | MEDIA_VIDEO_STORY_MISSING | A non-story video cannot be repubblished as a story (emitted when trying to resend a non-story video as a story using inputDocument). |
| 400 | PEER_ID_INVALID | The provided peer id is invalid. |
| 400 | PREMIUM_ACCOUNT_REQUIRED | A premium account is required to execute this action. |
| 400 | STORIES_TOO_MUCH | You have hit the maximum active stories limit as specified by the story_expiring_limit_* client configuration parameters: you should buy a Premium subscription, delete an active story, or wait for the oldest story to expire. |
| 400 | STORY_PERIOD_INVALID | The specified story period is invalid for this account. |
| 400 | VENUE_ID_INVALID | The specified venue ID is invalid. |
Telegram users and channels can easily post and view stories through the API.
How to create styled text with message entities
The MTProto API has multiple configuration parameters that can be fetched with the appropriate methods.
Telegram allows users to specify granular privacy settings, choosing which users can or can't interact with them in certain ways.
Telegram Premium is an optional subscription service that unlocks additional exclusive client-side and API-side features, while helping support the development of the app.