Telegram.Bot.API.Methods.SendChatAction

Documentation

data SendChatActionRequest

Constructors

SendChatActionRequest

Fields

• sendChatActionBusinessConnectionId :: Maybe BusinessConnectionId

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

• sendChatActionChatId :: ChatId

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

• sendChatActionMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread; for supergroups only.

• sendChatActionAction :: Text

  Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.

Instances

ToJSON SendChatActionRequest

Defined in Telegram.Bot.API.Methods.SendChatAction

Methods

toJSON :: SendChatActionRequest -> Value

toEncoding :: SendChatActionRequest -> Encoding

toJSONList :: [SendChatActionRequest] -> Value

toEncodingList :: [SendChatActionRequest] -> Encoding

omitField :: SendChatActionRequest -> Bool

Generic SendChatActionRequest

Defined in Telegram.Bot.API.Methods.SendChatAction

Associated Types

type Rep SendChatActionRequest :: Type -> Type

Methods

from :: SendChatActionRequest -> Rep SendChatActionRequest x

to :: Rep SendChatActionRequest x -> SendChatActionRequest

type Rep SendChatActionRequest

Defined in Telegram.Bot.API.Methods.SendChatAction

type Rep SendChatActionRequest = D1 ('MetaData "SendChatActionRequest" "Telegram.Bot.API.Methods.SendChatAction" "telegram-bot-api-7.4-KOlBWK6xJMuBW3gGLpeCBR" 'False) (C1 ('MetaCons "SendChatActionRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sendChatActionBusinessConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BusinessConnectionId)) :*: S1 ('MetaSel ('Just "sendChatActionChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatId)) :*: (S1 ('MetaSel ('Just "sendChatActionMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :*: S1 ('MetaSel ('Just "sendChatActionAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

type SendChatAction = "sendChatAction" :> (ReqBody '[JSON] SendChatActionRequest :> Post '[JSON] (Response Bool))

sendChatAction :: SendChatActionRequest -> ClientM (Response Bool)

Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.

Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.

We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.