Telegram.Bot.API.Methods.SendMediaGroup

sendMediaGroup

data SendMediaGroupRequest

Request parameters for sendMediaGroup.

Constructors

SendMediaGroupRequest

Fields

• sendMediaGroupBusinessConnectionId :: Maybe BusinessConnectionId

  Unique identifier of the business connection on behalf of which the message will be sent.

• sendMediaGroupChatId :: SomeChatId

  Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• sendMediaGroupMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

• sendMediaGroupMedia :: [InputMedia]

  A JSON-serialized array describing messages to be sent, must include 2-10 items. InputMediaAudio, InputMediaDocument, InputMediaPhoto or InputMediaVideo.

• sendMediaGroupDisableNotification :: Maybe Bool

  Sends the message silently. Users will receive a notification with no sound.

• sendMediaGroupProtectContent :: Maybe Bool

  Protects the contents of the sent message from forwarding and saving.

• sendMediaGroupMessageEffectId :: Maybe Text

  Unique identifier of the message effect to be added to the message; for private chats only.

• sendMediaGroupReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message.

• sendMediaGroupReplyParameters :: Maybe ReplyParameters

  Description of the message to reply to.

• sendMediaGroupReplyMarkup :: Maybe InlineKeyboardMarkup

  Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Instances

ToJSON SendMediaGroupRequest

Defined in Telegram.Bot.API.Methods.SendMediaGroup

Methods

toJSON :: SendMediaGroupRequest -> Value

toEncoding :: SendMediaGroupRequest -> Encoding

toJSONList :: [SendMediaGroupRequest] -> Value

toEncodingList :: [SendMediaGroupRequest] -> Encoding

omitField :: SendMediaGroupRequest -> Bool

Generic SendMediaGroupRequest

Defined in Telegram.Bot.API.Methods.SendMediaGroup

Associated Types

type Rep SendMediaGroupRequest :: Type -> Type

Methods

from :: SendMediaGroupRequest -> Rep SendMediaGroupRequest x

to :: Rep SendMediaGroupRequest x -> SendMediaGroupRequest

type Rep SendMediaGroupRequest

Defined in Telegram.Bot.API.Methods.SendMediaGroup

type Rep SendMediaGroupRequest = D1 ('MetaData "SendMediaGroupRequest" "Telegram.Bot.API.Methods.SendMediaGroup" "telegram-bot-api-7.4.3-38UQu7GyDDHHZ1He0cP5zf" 'False) (C1 ('MetaCons "SendMediaGroupRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendMediaGroupBusinessConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BusinessConnectionId)) :*: S1 ('MetaSel ('Just "sendMediaGroupChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)) :*: (S1 ('MetaSel ('Just "sendMediaGroupMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :*: (S1 ('MetaSel ('Just "sendMediaGroupMedia") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [InputMedia]) :*: S1 ('MetaSel ('Just "sendMediaGroupDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "sendMediaGroupProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendMediaGroupMessageEffectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sendMediaGroupReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: (S1 ('MetaSel ('Just "sendMediaGroupReplyParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReplyParameters)) :*: S1 ('MetaSel ('Just "sendMediaGroupReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendMediaGroup = "sendMediaGroup" :> (ReqBody '[JSON] SendMediaGroupRequest :> Post '[JSON] (Response [Message]))

sendMediaGroup :: SendMediaGroupRequest -> ClientM (Response [Message])

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

defSendMediaGroup :: SomeChatId -> [InputMedia] -> SendMediaGroupRequest