teleproto - v1.229.0
    Preparing search index...

    Interface StoriesSendStoryParams

    interface StoriesSendStoryParams {
        albums?: number[];
        caption?: string;
        entities?: TypeMessageEntityIn[];
        fwdFromId?: EntityLike;
        fwdFromStory?: number;
        fwdModified?: boolean;
        media: TypeInputMediaIn;
        mediaAreas?: TypeMediaAreaIn[];
        music?: TypeInputDocumentIn;
        noforwards?: boolean;
        peer: EntityLike;
        period?: number;
        pinned?: boolean;
        privacyRules: TypeInputPrivacyRuleIn[];
        randomId?: BigInteger;
    }
    Index
    albums? caption? entities? fwdFromId? fwdFromStory? fwdModified? media mediaAreas? music? noforwards? peer period? pinned? privacyRules randomId?
    albums?: number[]

    If set, adds the story to the specified albums.

    caption?: string

    Story caption.

    entities?: TypeMessageEntityIn[]

    Message entities for styled text , if allowed by the stories_entities client configuration parameter » .

    fwdFromId?: EntityLike

    If set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id .

    fwdFromStory?: number

    If set, indicates that this story is a repost of story with ID fwd_from_story posted by the peer in fwd_from_id .

    fwdModified?: boolean

    Set this flag when reposting stories with fwd_from_id + fwd_from_id , if the media was modified before reposting.

    media: TypeInputMediaIn

    The story media.

    mediaAreas?: TypeMediaAreaIn[]

    Media areas associated to the story, see here » for more info.

    music?: TypeInputDocumentIn
    noforwards?: boolean

    If set, disables forwards, screenshots, and downloads.

    peer: EntityLike

    The peer to send the story as.

    period?: number

    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.

    pinned?: boolean

    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.

    privacyRules: TypeInputPrivacyRuleIn[]

    Privacy rules for the story, indicating who can or can't view the story.

    randomId?: BigInteger

    Unique client message ID required to prevent message resending.

    Settings
    Member Visibility

    On This Page
    Properties