Skip to content

GramIO API Reference / gramio/dist / PostStoryParams

Interface: PostStoryParams

Defined in: @gramio/types/out/params.d.ts:3195

Params object for postStory method

Properties

PropertyTypeDescriptionDefined in
active_periodPostStoryActivePeriodPeriod 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:3207
areas?TelegramStoryArea[]A JSON-serialized list of clickable areas to be shown on the story@gramio/types/out/params.d.ts:3223
business_connection_idstringUnique identifier of the business connection@gramio/types/out/params.d.ts:3199
caption?string | { toString: string; }Caption of the story, 0-2048 characters after entities parsing@gramio/types/out/params.d.ts:3211
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:3219
contentTelegramInputStoryContentContent of the story@gramio/types/out/params.d.ts:3203
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:3215
post_to_chat_page?booleanPass True to keep the story accessible after it expires@gramio/types/out/params.d.ts:3227
protect_content?booleanPass True if the content of the story must be protected from forwarding and screenshotting@gramio/types/out/params.d.ts:3231