Documentation - v0.27.0
    Preparing search index...
    • Send a story

      Parameters

      • client: ITelegramClient
      • params: {
            addToAlbums?: number[];
            caption?: InputText;
            forbidForwards?: boolean;
            interactiveElements?: TypeMediaArea[];
            media: string | InputMediaLike;
            peer?: InputPeerLike;
            period?: number;
            pinned?: boolean;
            privacyRules?: InputPrivacyRule[];
        }
        • OptionaladdToAlbums?: number[]

          IDs of albums to add the story to

        • Optionalcaption?: InputText

          Override caption for media

        • OptionalforbidForwards?: boolean

          Whether to disallow sharing this story

        • OptionalinteractiveElements?: TypeMediaArea[]

          Interactive elements to add to the story

        • media: string | InputMediaLike

          Media contained in a story. Currently can only be a photo or a video.

          You can also pass TDLib and Bot API compatible File ID, which will be wrapped in InputMedia.auto

        • Optionalpeer?: InputPeerLike

          Peer ID to send story as

          self

        • Optionalperiod?: number

          TTL period of the story, in seconds

          86400
          
        • Optionalpinned?: boolean

          Whether to automatically pin this story to the profile

        • OptionalprivacyRules?: InputPrivacyRule[]

          Privacy rules to apply to the story

          "Everyone"
          

      Returns Promise<Story>

      Created story