Available methods

postStory()

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.

parameters

parametertyperequireddescription
business_connection_idstringrequiredUnique identifier of the business connection
contentInputStoryContentrequiredContent of the story
active_periodnumberrequiredPeriod after which the story is moved to the archive, in seconds; must be one of 6 3600, 12 3600, 86400, or 2 * 86400
captionstringoptionalCaption of the story, 0-2048 characters after entities parsing
parse_modestringoptionalMode for parsing entities in the story caption. See formatting options for more details.
caption_entitiesMessageEntity[]optionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
areasStoryArea[]optionalA JSON-serialized list of clickable areas to be shown on the story
post_to_chat_pagebooleanoptionalPass True to keep the story accessible after it expires
protect_contentbooleanoptionalPass True if the content of the story must be protected from forwarding and screenshotting

returns

Story

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts
import type { PostStoryParams, Story } from "@yaebal/types";

await bot.api.call<Story>("postStory", {
  business_connection_id: "...",
  content: {} /* InputStoryContent */,
  active_period: 1,
} satisfies PostStoryParams);