Telegram.Bot.API.Methods.AnswerCallbackQuery

answerCallbackQuery

data AnswerCallbackQueryRequest

Request parameters for answerCallbackQuery.

Constructors

AnswerCallbackQueryRequest

Fields

• answerCallbackQueryCallbackQueryId :: CallbackQueryId

  Unique identifier for the query to be answered

• answerCallbackQueryText :: Maybe Text

  Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters

• answerCallbackQueryShowAlert :: 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.

• answerCallbackQueryUrl :: 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 t.me/your_bot?start=XXXX that open your bot with a parameter.

• answerCallbackQueryCacheTime :: Maybe Integer

  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

FromJSON AnswerCallbackQueryRequest

Defined in Telegram.Bot.API.Methods.AnswerCallbackQuery

Methods

parseJSON :: Value -> Parser AnswerCallbackQueryRequest

parseJSONList :: Value -> Parser [AnswerCallbackQueryRequest]

ToJSON AnswerCallbackQueryRequest

Defined in Telegram.Bot.API.Methods.AnswerCallbackQuery

Methods

toJSON :: AnswerCallbackQueryRequest -> Value

toEncoding :: AnswerCallbackQueryRequest -> Encoding

toJSONList :: [AnswerCallbackQueryRequest] -> Value

toEncodingList :: [AnswerCallbackQueryRequest] -> Encoding

Generic AnswerCallbackQueryRequest

Defined in Telegram.Bot.API.Methods.AnswerCallbackQuery

Associated Types

type Rep AnswerCallbackQueryRequest :: Type -> Type

Methods

from :: AnswerCallbackQueryRequest -> Rep AnswerCallbackQueryRequest x

to :: Rep AnswerCallbackQueryRequest x -> AnswerCallbackQueryRequest

type Rep AnswerCallbackQueryRequest

Defined in Telegram.Bot.API.Methods.AnswerCallbackQuery

type Rep AnswerCallbackQueryRequest = D1 ('MetaData "AnswerCallbackQueryRequest" "Telegram.Bot.API.Methods.AnswerCallbackQuery" "telegram-bot-api-6.7-8B5O9jcStFh8aacJiwZZeM" 'False) (C1 ('MetaCons "AnswerCallbackQueryRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "answerCallbackQueryCallbackQueryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CallbackQueryId) :*: S1 ('MetaSel ('Just "answerCallbackQueryText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "answerCallbackQueryShowAlert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "answerCallbackQueryUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "answerCallbackQueryCacheTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))))))

type AnswerCallbackQuery = "answerCallbackQuery" :> (ReqBody '[JSON] AnswerCallbackQueryRequest :> Post '[JSON] (Response Bool))

answerCallbackQuery :: AnswerCallbackQueryRequest -> ClientM (Response Bool)

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @Botfather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

defAnswerCallbackQuery :: CallbackQueryId -> AnswerCallbackQueryRequest