Interface SendStory

Sends a new story to a chat; requires can_post_stories right for supergroup and channel chats. Returns a temporary story. Request type for Tdjson#sendStory.

interface SendStory {
    @type: "sendStory";
    active_period: number;
    areas: InputStoryAreas;
    caption: FormattedText;
    chat_id: number;
    content: InputStoryContent;
    from_story_full_id: StoryFullId;
    is_posted_to_chat_page?: boolean;
    privacy_settings: StoryPrivacySettings;
    protect_content?: boolean;
}

Properties

@type: "sendStory"
active_period: number

Period after which the story is moved to archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 for Telegram Premium users, and 86400 otherwise.

Clickable rectangle areas to be shown on the story media; pass null if none.

caption: FormattedText

Story caption; pass null to use an empty caption; 0-getOption("story_caption_length_max") characters; can have entities only if getOption("can_use_text_entities_in_story_caption").

chat_id: number

Identifier of the chat that will post the story. Pass Saved Messages chat identifier when posting a story on behalf of the current user.

Content of the story.

from_story_full_id: StoryFullId

Full identifier of the original story, which content was used to create the story; pass null if the story isn't repost of another story.

is_posted_to_chat_page?: boolean

Pass true to keep the story accessible after expiration.

privacy_settings: StoryPrivacySettings

The privacy settings for the story; ignored for stories sent to supergroup and channel chats.

protect_content?: boolean

Pass true if the content of the story must be protected from forwarding and screenshotting.