GramIO API Reference / gramio/dist / PostStoryParams
Interface: PostStoryParams
Defined in: @gramio/types/out/params.d.ts:3147
Params object for postStory method
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
active_period | PostStoryActivePeriod | Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400 | @gramio/types/out/params.d.ts:3159 |
areas? | TelegramStoryArea[] | A JSON-serialized list of clickable areas to be shown on the story | @gramio/types/out/params.d.ts:3175 |
business_connection_id | string | Unique identifier of the business connection | @gramio/types/out/params.d.ts:3151 |
caption? | string | { toString: string; } | Caption of the story, 0-2048 characters after entities parsing | @gramio/types/out/params.d.ts:3163 |
caption_entities? | TelegramMessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | @gramio/types/out/params.d.ts:3171 |
content | TelegramInputStoryContent | Content of the story | @gramio/types/out/params.d.ts:3155 |
parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | Mode for parsing entities in the story caption. See formatting options for more details. | @gramio/types/out/params.d.ts:3167 |
post_to_chat_page? | boolean | Pass True to keep the story accessible after it expires | @gramio/types/out/params.d.ts:3179 |
protect_content? | boolean | Pass True if the content of the story must be protected from forwarding and screenshotting | @gramio/types/out/params.d.ts:3183 |