StoriesUSER-ONLY

User clients can post photo and video stories with createStory.

Posting a Photo Story

const story = await client.createStory(chatId, {
  type: "photo",
  photo: "./story.jpg",
}, {
  caption: "A new story",
});

The photo and video fields accept any supported FileSource except a URL.

Provide the video’s duration in seconds when posting a video story.

const story = await client.createStory(chatId, {
  type: "video",
  video: "./story.mp4",
  duration: 15,
});

Stories are visible to everyone by default. Use privacy to limit who can see one.

await client.createStory(chatId, {
  type: "photo",
  photo: "./story.jpg",
}, {
  privacy: { type: "closeFriends" },
});

See StoryPrivacy for the available privacy choices.

The story update contains a posted story.

client.on("story", (ctx) => {
  console.log(ctx.update.story);
});

The deletedStory update contains the chat and story identifiers of a deleted story.

client.on("deletedStory", (ctx) => {
  console.log(ctx.update.deletedStory);
});

await client.editStory(chatId, story.id, {
  caption: "Updated caption",
});

await client.deleteStory(chatId, story.id);

Use getStory to retrieve a story by its chat and story identifiers.

await client.addStoryToHighlights(chatId, story.id);
await client.removeStoryFromHighlights(chatId, story.id);

Refer to the methods reference for all story-related methods.