telegram-api-0.7.0.0: Telegram Bot API bindings

Safe HaskellNone
LanguageHaskell2010

Web.Telegram.API.Bot.Requests

Contents

Description

This module contains data objects which represents requests to Telegram Bot API

Synopsis

Types

data ChatId Source #

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

Constructors

ChatId Int64 
ChatChannel Text 

data SendMessageRequest Source #

This object represents request for sendMessage

Constructors

SendMessageRequest 

Fields

Instances

Show SendMessageRequest Source # 
Generic SendMessageRequest Source # 
FromJSON SendMessageRequest Source # 
ToJSON SendMessageRequest Source # 
type Rep SendMessageRequest Source # 
type Rep SendMessageRequest = D1 (MetaData "SendMessageRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendMessageRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "message_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) ((:*:) (S1 (MetaSel (Just Symbol "message_text") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "message_parse_mode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ParseMode))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "message_disable_web_page_preview") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "message_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "message_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "message_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data ForwardMessageRequest Source #

This object represents request for forwardMessage

Constructors

ForwardMessageRequest 

Fields

Instances

Show ForwardMessageRequest Source # 
Generic ForwardMessageRequest Source # 
FromJSON ForwardMessageRequest Source # 
ToJSON ForwardMessageRequest Source # 
type Rep ForwardMessageRequest Source # 
type Rep ForwardMessageRequest = D1 (MetaData "ForwardMessageRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "ForwardMessageRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "forward_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) (S1 (MetaSel (Just Symbol "forward_from_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId))) ((:*:) (S1 (MetaSel (Just Symbol "forward_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "forward_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))))

data FileUpload Source #

This object represents data (image, video, ...) with mime type to upload.

Constructors

FileUpload 

Fields

data FileUploadContent Source #

This object represents data (image, video, ...) to upload.

data SetWebhookRequest Source #

This object represents request for setWebhookWithCertificate

Constructors

SetWebhookRequest 

Fields

SetWebhookWithoutCertRequest 

Fields

data GetUpdatesRequest Source #

Constructors

GetUpdatesRequest 

Fields

  • updates_offset :: Maybe Int

    Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.

  • updates_limit :: Maybe Int

    Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.

  • updates_timeout :: Maybe Int

    Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.

  • updates_allowed_updates :: Maybe [Text]

    List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.

data SendPhotoRequest payload Source #

This object represents request for sendPhoto

Constructors

SendPhotoRequest 

Fields

  • photo_chat_id :: ChatId

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

  • photo_photo :: payload

    Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo.

  • photo_caption :: Maybe Text

    Photo caption (may also be used when resending photos by file_id), 0-200 characters.

  • photo_disable_notification :: Maybe Bool

    Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound.

  • photo_reply_to_message_id :: Maybe Int

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

  • photo_reply_markup :: Maybe ReplyKeyboard

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

Instances

Show payload => Show (SendPhotoRequest payload) Source # 

Methods

showsPrec :: Int -> SendPhotoRequest payload -> ShowS #

show :: SendPhotoRequest payload -> String #

showList :: [SendPhotoRequest payload] -> ShowS #

Generic (SendPhotoRequest payload) Source # 

Associated Types

type Rep (SendPhotoRequest payload) :: * -> * #

Methods

from :: SendPhotoRequest payload -> Rep (SendPhotoRequest payload) x #

to :: Rep (SendPhotoRequest payload) x -> SendPhotoRequest payload #

FromJSON (SendPhotoRequest Text) Source # 
ToJSON (SendPhotoRequest Text) Source # 
type Rep (SendPhotoRequest payload) Source # 
type Rep (SendPhotoRequest payload) = D1 (MetaData "SendPhotoRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendPhotoRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "photo_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) ((:*:) (S1 (MetaSel (Just Symbol "photo_photo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 payload)) (S1 (MetaSel (Just Symbol "photo_caption") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "photo_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "photo_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "photo_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data SendAudioRequest payload Source #

This object represents request for sendAudio

Constructors

SendAudioRequest 

Fields

Instances

Show payload => Show (SendAudioRequest payload) Source # 

Methods

showsPrec :: Int -> SendAudioRequest payload -> ShowS #

show :: SendAudioRequest payload -> String #

showList :: [SendAudioRequest payload] -> ShowS #

Generic (SendAudioRequest payload) Source # 

Associated Types

type Rep (SendAudioRequest payload) :: * -> * #

Methods

from :: SendAudioRequest payload -> Rep (SendAudioRequest payload) x #

to :: Rep (SendAudioRequest payload) x -> SendAudioRequest payload #

FromJSON (SendAudioRequest Text) Source # 
ToJSON (SendAudioRequest Text) Source # 
type Rep (SendAudioRequest payload) Source # 

data SendDocumentRequest payload Source #

This object represents request for sendDocument

Constructors

SendDocumentRequest 

Fields

Instances

Show payload => Show (SendDocumentRequest payload) Source # 
Generic (SendDocumentRequest payload) Source # 

Associated Types

type Rep (SendDocumentRequest payload) :: * -> * #

Methods

from :: SendDocumentRequest payload -> Rep (SendDocumentRequest payload) x #

to :: Rep (SendDocumentRequest payload) x -> SendDocumentRequest payload #

FromJSON (SendDocumentRequest Text) Source # 
ToJSON (SendDocumentRequest Text) Source # 
type Rep (SendDocumentRequest payload) Source # 
type Rep (SendDocumentRequest payload) = D1 (MetaData "SendDocumentRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendDocumentRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "document_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) ((:*:) (S1 (MetaSel (Just Symbol "document_document") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 payload)) (S1 (MetaSel (Just Symbol "document_caption") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "document_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "document_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "document_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data SendStickerRequest payload Source #

This object represents request for sendSticker

Constructors

SendStickerRequest 

Fields

  • sticker_chat_id :: ChatId

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

  • sticker_sticker :: payload

    Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new sticker.

  • sticker_disable_notification :: Maybe Bool

    Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound.

  • sticker_reply_to_message_id :: Maybe Int

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

  • sticker_reply_markup :: Maybe ReplyKeyboard

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

Instances

Show payload => Show (SendStickerRequest payload) Source # 
Generic (SendStickerRequest payload) Source # 

Associated Types

type Rep (SendStickerRequest payload) :: * -> * #

Methods

from :: SendStickerRequest payload -> Rep (SendStickerRequest payload) x #

to :: Rep (SendStickerRequest payload) x -> SendStickerRequest payload #

FromJSON (SendStickerRequest Text) Source # 
ToJSON (SendStickerRequest Text) Source # 
type Rep (SendStickerRequest payload) Source # 
type Rep (SendStickerRequest payload) = D1 (MetaData "SendStickerRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendStickerRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "sticker_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) (S1 (MetaSel (Just Symbol "sticker_sticker") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 payload))) ((:*:) (S1 (MetaSel (Just Symbol "sticker_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "sticker_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "sticker_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data SendVideoRequest payload Source #

This object represents request for sendVideo

Constructors

SendVideoRequest 

Fields

Instances

Show payload => Show (SendVideoRequest payload) Source # 

Methods

showsPrec :: Int -> SendVideoRequest payload -> ShowS #

show :: SendVideoRequest payload -> String #

showList :: [SendVideoRequest payload] -> ShowS #

Generic (SendVideoRequest payload) Source # 

Associated Types

type Rep (SendVideoRequest payload) :: * -> * #

Methods

from :: SendVideoRequest payload -> Rep (SendVideoRequest payload) x #

to :: Rep (SendVideoRequest payload) x -> SendVideoRequest payload #

FromJSON (SendVideoRequest Text) Source # 
ToJSON (SendVideoRequest Text) Source # 
type Rep (SendVideoRequest payload) Source # 
type Rep (SendVideoRequest payload) = D1 (MetaData "SendVideoRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendVideoRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_video_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) ((:*:) (S1 (MetaSel (Just Symbol "_video_video") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 payload)) (S1 (MetaSel (Just Symbol "_video_duration") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_video_caption") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_video_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_video_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_video_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data SendVoiceRequest payload Source #

This object represents request for sendVoice

Constructors

SendVoiceRequest 

Fields

Instances

Show payload => Show (SendVoiceRequest payload) Source # 

Methods

showsPrec :: Int -> SendVoiceRequest payload -> ShowS #

show :: SendVoiceRequest payload -> String #

showList :: [SendVoiceRequest payload] -> ShowS #

Generic (SendVoiceRequest payload) Source # 

Associated Types

type Rep (SendVoiceRequest payload) :: * -> * #

Methods

from :: SendVoiceRequest payload -> Rep (SendVoiceRequest payload) x #

to :: Rep (SendVoiceRequest payload) x -> SendVoiceRequest payload #

FromJSON (SendVoiceRequest Text) Source # 
ToJSON (SendVoiceRequest Text) Source # 
type Rep (SendVoiceRequest payload) Source # 
type Rep (SendVoiceRequest payload) = D1 (MetaData "SendVoiceRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendVoiceRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_voice_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) ((:*:) (S1 (MetaSel (Just Symbol "_voice_voice") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 payload)) (S1 (MetaSel (Just Symbol "_voice_caption") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_voice_duration") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_voice_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_voice_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_voice_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data SendVideoNoteRequest payload Source #

Constructors

SendVideoNoteRequest 

Fields

Instances

Show payload => Show (SendVideoNoteRequest payload) Source # 
Generic (SendVideoNoteRequest payload) Source # 

Associated Types

type Rep (SendVideoNoteRequest payload) :: * -> * #

Methods

from :: SendVideoNoteRequest payload -> Rep (SendVideoNoteRequest payload) x #

to :: Rep (SendVideoNoteRequest payload) x -> SendVideoNoteRequest payload #

FromJSON (SendVideoNoteRequest Text) Source # 
ToJSON (SendVideoNoteRequest Text) Source # 
type Rep (SendVideoNoteRequest payload) Source # 
type Rep (SendVideoNoteRequest payload) = D1 (MetaData "SendVideoNoteRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendVideoNoteRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vid_note_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) ((:*:) (S1 (MetaSel (Just Symbol "_vid_note_video_note") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 payload)) (S1 (MetaSel (Just Symbol "_vid_note_duration") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vid_note_length") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_vid_note_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_vid_note_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_vid_note_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data SendLocationRequest Source #

This object represents request for sendLocation

Constructors

SendLocationRequest 

Fields

Instances

Show SendLocationRequest Source # 
Generic SendLocationRequest Source # 
FromJSON SendLocationRequest Source # 
ToJSON SendLocationRequest Source # 
type Rep SendLocationRequest Source # 
type Rep SendLocationRequest = D1 (MetaData "SendLocationRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendLocationRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "location_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) ((:*:) (S1 (MetaSel (Just Symbol "location_latitude") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Float)) (S1 (MetaSel (Just Symbol "location_longitude") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Float)))) ((:*:) (S1 (MetaSel (Just Symbol "location_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "location_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "location_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data SendVenueRequest Source #

This object represents request for sendVenue

Constructors

SendVenueRequest 

Fields

Instances

Show SendVenueRequest Source # 
Generic SendVenueRequest Source # 
FromJSON SendVenueRequest Source # 
ToJSON SendVenueRequest Source # 
type Rep SendVenueRequest Source # 

data SendContactRequest Source #

This object represents request for sendContact

Constructors

SendContactRequest 

Fields

Instances

Show SendContactRequest Source # 
Generic SendContactRequest Source # 
FromJSON SendContactRequest Source # 
ToJSON SendContactRequest Source # 
type Rep SendContactRequest Source # 
type Rep SendContactRequest = D1 (MetaData "SendContactRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendContactRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_contact_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) ((:*:) (S1 (MetaSel (Just Symbol "_contact_phone_number") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_contact_first_name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_contact_last_name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_contact_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_contact_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_contact_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ReplyKeyboard)))))))

data SendChatActionRequest Source #

This object represents request for sendChatAction

Constructors

SendChatActionRequest 

Fields

data SendGameRequest Source #

This object represents request for sendGame

Constructors

SendGameRequest 

Fields

Instances

Show SendGameRequest Source # 
Generic SendGameRequest Source # 
FromJSON SendGameRequest Source # 
ToJSON SendGameRequest Source # 
type Rep SendGameRequest Source # 
type Rep SendGameRequest = D1 (MetaData "SendGameRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendGameRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "game_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)) (S1 (MetaSel (Just Symbol "game_game_short_name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "game_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "game_reply_to_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "game_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

data ChatAction Source #

Type of action to broadcast.

Instances

Show ChatAction Source # 
Generic ChatAction Source # 

Associated Types

type Rep ChatAction :: * -> * #

FromJSON ChatAction Source # 
ToJSON ChatAction Source # 
type Rep ChatAction Source # 
type Rep ChatAction = D1 (MetaData "ChatAction" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "Typing" PrefixI False) U1) (C1 (MetaCons "UploadPhoto" PrefixI False) U1)) ((:+:) (C1 (MetaCons "RecordVideo" PrefixI False) U1) ((:+:) (C1 (MetaCons "UploadVideo" PrefixI False) U1) (C1 (MetaCons "RecordAudio" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "UploadAudio" PrefixI False) U1) (C1 (MetaCons "UploadDocument" PrefixI False) U1)) ((:+:) (C1 (MetaCons "FindLocation" PrefixI False) U1) ((:+:) (C1 (MetaCons "RecordVideoNote" PrefixI False) U1) (C1 (MetaCons "UploadVideoNote" PrefixI False) U1)))))

data AnswerInlineQueryRequest Source #

Constructors

AnswerInlineQueryRequest 

Fields

  • query_inline_query_id :: Text

    Unique identifier for the answered query

  • query_results :: [InlineQueryResult]

    A JSON-serialized array of results for the inline query

  • query_cache_time :: Maybe Int

    The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.

  • query_is_personal :: Maybe Bool

    Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query

  • query_next_offset :: Maybe Text

    Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.

  • query_switch_pm_text :: Maybe Text

    If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter

  • query_switch_pm_parameter :: Maybe Text

    Parameter for the start message sent to the bot when user presses the switch button

    Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.

Instances

Show AnswerInlineQueryRequest Source # 
Generic AnswerInlineQueryRequest Source # 
FromJSON AnswerInlineQueryRequest Source # 
ToJSON AnswerInlineQueryRequest Source # 
type Rep AnswerInlineQueryRequest Source # 
type Rep AnswerInlineQueryRequest = D1 (MetaData "AnswerInlineQueryRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "AnswerInlineQueryRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "query_inline_query_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "query_results") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [InlineQueryResult])) (S1 (MetaSel (Just Symbol "query_cache_time") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "query_is_personal") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "query_next_offset") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "query_switch_pm_text") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "query_switch_pm_parameter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))))

data AnswerCallbackQueryRequest Source #

Constructors

AnswerCallbackQueryRequest 

Fields

  • cq_callback_query_id :: Text

    Unique identifier for the query to be answered

  • cq_text :: Maybe Text

    Text of the notification. If not specified, nothing will be shown to the user

  • cq_show_alert :: Maybe Bool

    If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.

  • cq_url :: Maybe Text

    URL that will be opened by the user's client. If you have created a Game and accepted the conditions via `@Botfather`, specify the URL that opens your game – note that this will only work if the query comes from a callback_game button. Otherwise, you may use links like telegram.me/your_bot?start=XXXX that open your bot with a parameter.

  • cq_cache_time :: Maybe Int

    The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

Instances

Show AnswerCallbackQueryRequest Source # 
Generic AnswerCallbackQueryRequest Source # 
FromJSON AnswerCallbackQueryRequest Source # 
ToJSON AnswerCallbackQueryRequest Source # 
type Rep AnswerCallbackQueryRequest Source # 
type Rep AnswerCallbackQueryRequest = D1 (MetaData "AnswerCallbackQueryRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "AnswerCallbackQueryRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "cq_callback_query_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "cq_text") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "cq_show_alert") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "cq_url") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "cq_cache_time") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))))))

data ReplyKeyboard Source #

Constructors

ReplyInlineKeyboardMarkup

This object represents a custom keyboard with reply options

Fields

ReplyKeyboardMarkup 

Fields

  • reply_keyboard :: [[KeyboardButton]]

    Array of button rows, each represented by an Array of KeyboardButton objects

  • reply_resize_keyboard :: Maybe Bool

    Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.

  • reply_one_time_keyboard :: Maybe Bool

    Requests clients to hide the keyboard as soon as it's been used. Defaults to false.

  • reply_selective :: Maybe Bool

    Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

ReplyKeyboardHide

Upon receiving a message with this object, Telegram clients will hide the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button

Fields

  • reply_hide_keyboard :: Bool

    Requests clients to hide the custom keyboard

  • reply_selective :: Maybe Bool

    Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

ReplyKeyboardRemove 

Fields

  • reply_remove_keyboard :: Bool

    Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)

  • reply_selective :: Maybe Bool

    Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

ForceReply

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

Fields

  • reply_force_reply :: Bool

    Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'

  • reply_selective :: Maybe Bool

    Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

Instances

Show ReplyKeyboard Source # 
Generic ReplyKeyboard Source # 

Associated Types

type Rep ReplyKeyboard :: * -> * #

FromJSON ReplyKeyboard Source # 
ToJSON ReplyKeyboard Source # 
type Rep ReplyKeyboard Source # 
type Rep ReplyKeyboard = D1 (MetaData "ReplyKeyboard" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) ((:+:) ((:+:) (C1 (MetaCons "ReplyInlineKeyboardMarkup" PrefixI True) (S1 (MetaSel (Just Symbol "reply_inline_keyboard") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [[InlineKeyboardButton]]))) (C1 (MetaCons "ReplyKeyboardMarkup" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "reply_keyboard") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [[KeyboardButton]])) (S1 (MetaSel (Just Symbol "reply_resize_keyboard") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "reply_one_time_keyboard") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "reply_selective") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))))))) ((:+:) (C1 (MetaCons "ReplyKeyboardHide" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "reply_hide_keyboard") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "reply_selective") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))))) ((:+:) (C1 (MetaCons "ReplyKeyboardRemove" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "reply_remove_keyboard") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "reply_selective") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))))) (C1 (MetaCons "ForceReply" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "reply_force_reply") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "reply_selective") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))))))))

data EditMessageTextRequest Source #

Constructors

EditMessageTextRequest 

Fields

Instances

Show EditMessageTextRequest Source # 
Generic EditMessageTextRequest Source # 
FromJSON EditMessageTextRequest Source # 
ToJSON EditMessageTextRequest Source # 
type Rep EditMessageTextRequest Source # 

data EditMessageCaptionRequest Source #

Constructors

EditMessageCaptionRequest 

Fields

Instances

Show EditMessageCaptionRequest Source # 
Generic EditMessageCaptionRequest Source # 
FromJSON EditMessageCaptionRequest Source # 
ToJSON EditMessageCaptionRequest Source # 
type Rep EditMessageCaptionRequest Source # 
type Rep EditMessageCaptionRequest = D1 (MetaData "EditMessageCaptionRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "EditMessageCaptionRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "emc_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ChatId))) (S1 (MetaSel (Just Symbol "emc_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "emc_inline_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "emc_caption") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "emc_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

data EditMessageReplyMarkupRequest Source #

Constructors

EditMessageReplyMarkupRequest 

Fields

Instances

Show EditMessageReplyMarkupRequest Source # 
Generic EditMessageReplyMarkupRequest Source # 
FromJSON EditMessageReplyMarkupRequest Source # 
ToJSON EditMessageReplyMarkupRequest Source # 
type Rep EditMessageReplyMarkupRequest Source # 
type Rep EditMessageReplyMarkupRequest = D1 (MetaData "EditMessageReplyMarkupRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "EditMessageReplyMarkupRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "emrm_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ChatId))) (S1 (MetaSel (Just Symbol "emrm_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "emrm_inline_message_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "emrm_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup))))))

data SendInvoiceRequest Source #

Constructors

SendInvoiceRequest 

Fields

Instances

Show SendInvoiceRequest Source # 
Generic SendInvoiceRequest Source # 
FromJSON SendInvoiceRequest Source # 
ToJSON SendInvoiceRequest Source # 
type Rep SendInvoiceRequest Source # 
type Rep SendInvoiceRequest = D1 (MetaData "SendInvoiceRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "SendInvoiceRequest" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_chat_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)) (S1 (MetaSel (Just Symbol "snd_inv_title") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_description") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_payload") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "snd_inv_provider_token") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_start_parameter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "snd_inv_currency") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CurrencyCode))) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_prices") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [LabeledPrice])) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_photo_url") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "snd_inv_photo_size") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_photo_width") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "snd_inv_photo_height") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_need_name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_need_phone_number") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "snd_inv_need_email") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_need_shipping_address") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "snd_inv_is_flexible") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_disable_notification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "snd_inv_reply_to_message") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "snd_inv_reply_markup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))))

data AnswerShippingQueryRequest Source #

Constructors

AnswerShippingQueryRequest

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Fields

  • asq_shipping_query_id :: Text

    Unique identifier for the query to be answered

  • asq_ok :: Bool

    Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)

  • asq_shipping_options :: Maybe [ShippingOption]

    Required if ok is True. A JSON-serialized array of available shipping options.

  • asq_error_message :: Maybe Text

    Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.

Instances

Show AnswerShippingQueryRequest Source # 
Generic AnswerShippingQueryRequest Source # 
FromJSON AnswerShippingQueryRequest Source # 
ToJSON AnswerShippingQueryRequest Source # 
type Rep AnswerShippingQueryRequest Source # 
type Rep AnswerShippingQueryRequest = D1 (MetaData "AnswerShippingQueryRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "AnswerShippingQueryRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "asq_shipping_query_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "asq_ok") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) ((:*:) (S1 (MetaSel (Just Symbol "asq_shipping_options") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [ShippingOption]))) (S1 (MetaSel (Just Symbol "asq_error_message") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))))

data AnswerPreCheckoutQueryRequest Source #

Constructors

AnswerPreCheckoutQueryRequest

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Fields

  • apc_pre_checkout_query_id :: Text

    Unique identifier for the query to be answered

  • apc_ok :: Bool

    Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

  • apc_error_message :: Maybe Text

    Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.

Instances

Show AnswerPreCheckoutQueryRequest Source # 
Generic AnswerPreCheckoutQueryRequest Source # 
FromJSON AnswerPreCheckoutQueryRequest Source # 
ToJSON AnswerPreCheckoutQueryRequest Source # 
type Rep AnswerPreCheckoutQueryRequest Source # 
type Rep AnswerPreCheckoutQueryRequest = D1 (MetaData "AnswerPreCheckoutQueryRequest" "Web.Telegram.API.Bot.Requests" "telegram-api-0.7.0.0-9Z3D6e2nzOOHMeRp7flNOr" False) (C1 (MetaCons "AnswerPreCheckoutQueryRequest" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "apc_pre_checkout_query_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "apc_ok") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "apc_error_message") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))))

Functions

sendInvoiceRequest Source #

Arguments

:: Int64

Unique identifier for the target private chat

-> Text

Product name

-> Text

Product description

-> Text

Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

-> Text

Payments provider token, obtained via Botfather

-> Text

Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter

-> CurrencyCode

Three-letter ISO 4217 currency code

-> [LabeledPrice]

Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)

-> SendInvoiceRequest