Media Groups (built-in)

The media group plugin helps you send media groups by letting you build InputMedia objects. Incidentally, InputMedia object are also used when editing media messages, so this plugin also helps you to edit media.

Remember that InputMedia objects are specified here.

Building an InputMedia Object

You can use this plugin like so:

TypeScript

import { InputMediaBuilder } from "grammy";

const photo = InputMediaBuilder.photo(new InputFile("/tmp/photo.mp4"));
const video = InputMediaBuilder.video(new InputFile("/tmp/video.mp4"));
// etc

JavaScript

const { InputMediaBuilder } = require("grammy");

const photo = InputMediaBuilder.photo(new InputFile("/tmp/photo.mp4"));
const video = InputMediaBuilder.video(new InputFile("/tmp/video.mp4"));
// etc

Deno

import { InputMediaBuilder } from "https://deno.land/x/grammy@v1.30.0/mod.ts";

const photo = InputMediaBuilder.photo(new InputFile("/tmp/photo.mp4"));
const video = InputMediaBuilder.video(new InputFile("/tmp/video.mp4"));
// etc

Check out all methods of InputMediaBuilder in the API reference.

You can also directly pass public URLs which Telegram fetches.

const photo = InputMediaBuilder.photo("https://grammy.dev/images/grammY.png");

Further options can be provided in an options object at the end.

const photo = InputMediaBuilder.photo("https://grammy.dev/images/grammY.png", {
  caption: "grammY is awesome",
  // etc
});

Sending a Media Group

You can send a media group as follows:

await ctx.replyWithMediaGroup([photo0, photo1, photo2, video]);

Likewise, you can pass an array of InputMedia objects to ctx.api.sendMediaGroup or bot.api.sendMediaGroup.

Editing a Media Message

Since InputMedia objects are also used to edit media messages, this plugin will assist you here, too:

const newMedia = InputMediaBuilder.photo(
  "https://grammy.dev/images/grammY.png",
);
await ctx.editMessageMedia(newMedia);

As always, this works for ctx.api.editMessageMedia and bot.api.editMessageMedia, too.

Plugin Summary

This plugin is built-in into the core of grammY. You don’t need to install anything to use it. Simply import everything from grammY itself.

Also, both the documentation and the API reference of this plugin are unified with the core package.