Telegram.Bot.API.Methods

Available methods

getMe

type GetMe = "getMe" :> Get '[JSON] (Response User)

getMe :: ClientM (Response User)

A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.

deleteMessage

type DeleteMessage = "deleteMessage" :> (RequiredQueryParam "chat_id" ChatId :> (RequiredQueryParam "message_id" MessageId :> Get '[JSON] (Response Bool)))

Notice that deleting by POST method was bugged, so we use GET

deleteMessage :: ChatId -> MessageId -> ClientM (Response Bool)

Use this method to delete message in chat. On success, the sent Bool is returned.

sendMessage

type SendMessage = "sendMessage" :> (ReqBody '[JSON] SendMessageRequest :> Post '[JSON] (Response Message))

sendMessage :: SendMessageRequest -> ClientM (Response Message)

Use this method to send text messages. On success, the sent Message is returned.

forwardMessage

type ForwardMessage = "forwardMessage" :> (ReqBody '[JSON] ForwardMessageRequest :> Post '[JSON] (Response Message))

forwardMessage :: ForwardMessageRequest -> ClientM (Response Message)

Use this method to forward messages of any kind. On success, the sent Message is returned.

data SomeChatId

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

Constructors

SomeChatId ChatId

Unique chat ID.

SomeChatUsername Text

Username of the target channel.

Instances

Generic SomeChatId

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep SomeChatId :: Type -> Type

Methods

from :: SomeChatId -> Rep SomeChatId x

to :: Rep SomeChatId x -> SomeChatId

FromJSON SomeChatId

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser SomeChatId

parseJSONList :: Value -> Parser [SomeChatId]

ToJSON SomeChatId

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: SomeChatId -> Value

toEncoding :: SomeChatId -> Encoding

toJSONList :: [SomeChatId] -> Value

toEncodingList :: [SomeChatId] -> Encoding

type Rep SomeChatId

Defined in Telegram.Bot.API.Methods

type Rep SomeChatId = D1 ('MetaData "SomeChatId" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.3-inplace" 'False) (C1 ('MetaCons "SomeChatId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatId)) :+: C1 ('MetaCons "SomeChatUsername" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data SomeReplyMarkup

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.

Constructors

SomeInlineKeyboardMarkup InlineKeyboardMarkup

SomeReplyKeyboardMarkup ReplyKeyboardMarkup

SomeReplyKeyboardRemove ReplyKeyboardRemove

SomeForceReply ForceReply

Instances

Generic SomeReplyMarkup

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep SomeReplyMarkup :: Type -> Type

Methods

from :: SomeReplyMarkup -> Rep SomeReplyMarkup x

to :: Rep SomeReplyMarkup x -> SomeReplyMarkup

FromJSON SomeReplyMarkup

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser SomeReplyMarkup

parseJSONList :: Value -> Parser [SomeReplyMarkup]

ToJSON SomeReplyMarkup

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: SomeReplyMarkup -> Value

toEncoding :: SomeReplyMarkup -> Encoding

toJSONList :: [SomeReplyMarkup] -> Value

toEncodingList :: [SomeReplyMarkup] -> Encoding

type Rep SomeReplyMarkup

Defined in Telegram.Bot.API.Methods

type Rep SomeReplyMarkup = D1 ('MetaData "SomeReplyMarkup" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.3-inplace" 'False) ((C1 ('MetaCons "SomeInlineKeyboardMarkup" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InlineKeyboardMarkup)) :+: C1 ('MetaCons "SomeReplyKeyboardMarkup" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplyKeyboardMarkup))) :+: (C1 ('MetaCons "SomeReplyKeyboardRemove" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplyKeyboardRemove)) :+: C1 ('MetaCons "SomeForceReply" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ForceReply))))

data ParseMode

Constructors

Markdown

HTML

MarkdownV2

Instances

Generic ParseMode

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep ParseMode :: Type -> Type

Methods

from :: ParseMode -> Rep ParseMode x

to :: Rep ParseMode x -> ParseMode

FromJSON ParseMode

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser ParseMode

parseJSONList :: Value -> Parser [ParseMode]

ToJSON ParseMode

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: ParseMode -> Value

toEncoding :: ParseMode -> Encoding

toJSONList :: [ParseMode] -> Value

toEncodingList :: [ParseMode] -> Encoding

type Rep ParseMode

Defined in Telegram.Bot.API.Methods

type Rep ParseMode = D1 ('MetaData "ParseMode" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.3-inplace" 'False) (C1 ('MetaCons "Markdown" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HTML" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MarkdownV2" 'PrefixI 'False) (U1 :: Type -> Type)))

data SendMessageRequest

Request parameters for sendMessage.

Constructors

SendMessageRequest

Fields

• sendMessageChatId :: SomeChatId

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

• sendMessageText :: Text

  Text of the message to be sent.

• sendMessageParseMode :: Maybe ParseMode

  Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.

• sendMessageDisableWebPagePreview :: Maybe Bool

  Disables link previews for links in this message.

• sendMessageDisableNotification :: Maybe Bool

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

• sendMessageReplyToMessageId :: Maybe MessageId

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

• sendMessageReplyMarkup :: Maybe SomeReplyMarkup

  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

Generic SendMessageRequest

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep SendMessageRequest :: Type -> Type

Methods

from :: SendMessageRequest -> Rep SendMessageRequest x

to :: Rep SendMessageRequest x -> SendMessageRequest

FromJSON SendMessageRequest

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser SendMessageRequest

parseJSONList :: Value -> Parser [SendMessageRequest]

ToJSON SendMessageRequest

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: SendMessageRequest -> Value

toEncoding :: SendMessageRequest -> Encoding

toJSONList :: [SendMessageRequest] -> Value

toEncodingList :: [SendMessageRequest] -> Encoding

type Rep SendMessageRequest

Defined in Telegram.Bot.API.Methods

type Rep SendMessageRequest = D1 ('MetaData "SendMessageRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.3-inplace" 'False) (C1 ('MetaCons "SendMessageRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sendMessageChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: (S1 ('MetaSel ('Just "sendMessageText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sendMessageParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)))) :*: ((S1 ('MetaSel ('Just "sendMessageDisableWebPagePreview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendMessageDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "sendMessageReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 ('MetaSel ('Just "sendMessageReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup))))))

data ForwardMessageRequest

Request parameters for forwardMessage.

Constructors

ForwardMessageRequest

Fields

• forwardMessageChatId :: SomeChatId

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

• forwardMessageFromChatId :: SomeChatId

  Unique identifier for the chat where the original message was sent (or channel username in the format @@channelusername)

• forwardMessageDisableNotification :: Maybe Bool

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

• forwardMessageMessageId :: MessageId

  Message identifier in the chat specified in from_chat_id

Instances

Generic ForwardMessageRequest

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep ForwardMessageRequest :: Type -> Type

Methods

from :: ForwardMessageRequest -> Rep ForwardMessageRequest x

to :: Rep ForwardMessageRequest x -> ForwardMessageRequest

FromJSON ForwardMessageRequest

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser ForwardMessageRequest

parseJSONList :: Value -> Parser [ForwardMessageRequest]

ToJSON ForwardMessageRequest

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: ForwardMessageRequest -> Value

toEncoding :: ForwardMessageRequest -> Encoding

toJSONList :: [ForwardMessageRequest] -> Value

toEncodingList :: [ForwardMessageRequest] -> Encoding

type Rep ForwardMessageRequest

Defined in Telegram.Bot.API.Methods

type Rep ForwardMessageRequest = D1 ('MetaData "ForwardMessageRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.3-inplace" 'False) (C1 ('MetaCons "ForwardMessageRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "forwardMessageChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "forwardMessageFromChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)) :*: (S1 ('MetaSel ('Just "forwardMessageDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "forwardMessageMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageId))))

sendMessage

type SendDocumentContent = "sendDocument" :> (MultipartForm Tmp SendDocumentRequest :> Post '[JSON] (Response Message))

type SendDocumentLink = "sendDocument" :> (ReqBody '[JSON] SendDocumentRequest :> Post '[JSON] (Response Message))

sendDocument :: SendDocumentRequest -> ClientM (Response Message)

Use this method to send text messages. On success, the sent Message is returned.

https://core.telegram.org/bots/api#senddocument

data SendDocumentRequest

Request parameters for sendDocument

Constructors

SendDocumentRequest

Fields

• sendDocumentChatId :: SomeChatId

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

• sendDocumentDocument :: DocumentFile

  Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data

• sendDocumentThumb :: Maybe FilePath

  Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipartform-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach:file_attach_name” if the thumbnail was uploaded using multipartform-data under file_attach_name

• sendDocumentCaption :: Maybe Text

  Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing

• sendDocumentParseMode :: Maybe ParseMode

  Mode for parsing entities in the document caption.

• sendDocumentDisableNotification :: Maybe Bool

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

• sendDocumentReplyToMessageId :: Maybe MessageId
• sendDocumentReplyMarkup :: Maybe SomeReplyMarkup

  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

Generic SendDocumentRequest

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep SendDocumentRequest :: Type -> Type

Methods

from :: SendDocumentRequest -> Rep SendDocumentRequest x

to :: Rep SendDocumentRequest x -> SendDocumentRequest

ToJSON SendDocumentRequest

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: SendDocumentRequest -> Value

toEncoding :: SendDocumentRequest -> Encoding

toJSONList :: [SendDocumentRequest] -> Value

toEncodingList :: [SendDocumentRequest] -> Encoding

ToMultipart Tmp SendDocumentRequest

Defined in Telegram.Bot.API.Methods

Methods

toMultipart :: SendDocumentRequest -> MultipartData Tmp

type Rep SendDocumentRequest

Defined in Telegram.Bot.API.Methods

type Rep SendDocumentRequest = D1 ('MetaData "SendDocumentRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.3-inplace" 'False) (C1 ('MetaCons "SendDocumentRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendDocumentChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "sendDocumentDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DocumentFile)) :*: (S1 ('MetaSel ('Just "sendDocumentThumb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "sendDocumentCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sendDocumentParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :*: S1 ('MetaSel ('Just "sendDocumentDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "sendDocumentReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 ('MetaSel ('Just "sendDocumentReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup))))))

data DocumentFile

Constructors

DocumentFileId Int

DocumentUrl Text

DocumentFile FilePath ContentType

Instances

ToJSON DocumentFile

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: DocumentFile -> Value

toEncoding :: DocumentFile -> Encoding

toJSONList :: [DocumentFile] -> Value

toEncodingList :: [DocumentFile] -> Encoding

type ContentType = Text

toSendDocument :: SomeChatId -> DocumentFile -> SendDocumentRequest

Generate send document structure.