GramIO API Reference / @gramio/contexts/dist / CallbackQueryContext

Class: CallbackQueryContext<Bot>

Defined in: contexts/index.d.ts:5481

Called when callback_query event occurs

Extends

• Context<Bot>.Constructor<CallbackQueryContext<Bot>>.CallbackQuery.SendMixin<Bot>.CloneMixin<Bot, CallbackQueryContext<Bot>, CallbackQueryContextOptions<Bot>>

Type Parameters

Type Parameter
Bot extends BotLike

Constructors

Constructor

new CallbackQueryContext<Bot>(options): CallbackQueryContext<Bot>

Defined in: contexts/index.d.ts:5484

Parameters

Parameter	Type
options	CallbackQueryContextOptions<Bot>

Returns

CallbackQueryContext<Bot>

Overrides

Context.constructor

---

Constructor

new CallbackQueryContext(...args): CallbackQueryContext

Defined in: contexts/index.d.ts:5481

Parameters

Parameter	Type
...args	any[]

Returns

CallbackQueryContext

Overrides

Context<Bot>.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
bot	public	Bot	-	Context.bot	contexts/index.d.ts:4856
isTopicMessage	public	() => boolean	-	SendMixin.isTopicMessage	contexts/index.d.ts:4993
payload	public	TelegramCallbackQuery	The raw data that is used for this Context	CallbackQuery.payload	contexts/index.d.ts:5483
update?	public	TelegramUpdate	-	Context.update	contexts/index.d.ts:4858
updateId?	public	number	-	Context.updateId	contexts/index.d.ts:4857
updateType	protected	UpdateName	-	Context.updateType	contexts/index.d.ts:4859

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Defined in: contexts/index.d.ts:4862

MDN

Returns

string

Inherited from

Context.[toStringTag]

---

businessConnectionId

Get Signature

get businessConnectionId(): string

Defined in: contexts/index.d.ts:4990

Returns

string

Inherited from

SendMixin.businessConnectionId

---

chatId

Get Signature

get chatId(): number

Defined in: contexts/index.d.ts:5496

Chat identifier of the message with the callback button that originated the query.

Returns

number

Inherited from

SendMixin.chatId

---

chatInstance

Get Signature

get chatInstance(): string

Defined in: contexts/index.d.ts:3334

Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.

Returns

string

Inherited from

CallbackQuery.chatInstance

---

data

Get Signature

get data(): string

Defined in: contexts/index.d.ts:3339

Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.

Returns

string

Set Signature

set data(data): void

Defined in: contexts/index.d.ts:3340

Parameters

Parameter	Type
data	string

Returns

void

Inherited from

CallbackQuery.data

---

from

Get Signature

get from(): User

Defined in: contexts/index.d.ts:3318

Sender

Returns

User

Inherited from

CallbackQuery.from

---

gameShortName

Get Signature

get gameShortName(): string

Defined in: contexts/index.d.ts:3345

Short name of a Game to be returned, serves as the unique identifier for the game

Returns

string

Inherited from

CallbackQuery.gameShortName

---

id

Get Signature

get id(): string

Defined in: contexts/index.d.ts:3316

Unique identifier for this query

Returns

string

Inherited from

CallbackQuery.id

---

inlineMessageId

Get Signature

get inlineMessageId(): string

Defined in: contexts/index.d.ts:3329

Identifier of the message sent via the bot in inline mode, that originated the query.

Returns

string

Inherited from

CallbackQuery.inlineMessageId

---

message

Get Signature

get message(): MessageContext<Bot>

Defined in: contexts/index.d.ts:5492

Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old

Returns

MessageContext<Bot>

Inherited from

CallbackQuery.message

---

queryPayload

Get Signature

get queryPayload(): unknown

Defined in: contexts/index.d.ts:5503

Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.

Returns

unknown

---

senderId

Get Signature

get senderId(): number

Defined in: contexts/index.d.ts:3320

Sender ID

Returns

number

Inherited from

CallbackQuery.senderId

---

threadId

Get Signature

get threadId(): number

Defined in: contexts/index.d.ts:4992

Returns

number

Inherited from

SendMixin.threadId

Methods

answer()

answer(params?): Promise<true>

Defined in: contexts/index.d.ts:5515

Answers to current callback query. An alias for answerCallbackQuery

Parameters

Parameter	Type
params?	string | Partial<AnswerCallbackQueryParams>

Returns

Promise<true>

---

answerCallbackQuery()

answerCallbackQuery(params?): Promise<true>

Defined in: contexts/index.d.ts:5511

Answers to current callback query

Parameters

Parameter	Type
params?	string | Partial<AnswerCallbackQueryParams>

Returns

Promise<true>

---

answerWebAppQuery()

answerWebAppQuery(params): Promise<TelegramSentWebAppMessage>

Defined in: contexts/index.d.ts:5513

Sets the result of an interaction with a Web App and sends a corresponding message

Parameters

Parameter	Type
params	AnswerWebAppQueryParams

Returns

Promise<TelegramSentWebAppMessage>

---

clone()

clone(options?): CallbackQueryContext

Defined in: contexts/index.d.ts:5407

Parameters

Parameter	Type
options?	CallbackQueryContextOptions

Returns

CallbackQueryContext

Inherited from

CloneMixin.clone

---

editCaption()

editCaption(caption, params?): Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

Defined in: contexts/index.d.ts:5519

Edits a callback query messages caption

Parameters

Parameter	Type
caption	NonNullable<string | { toString: string; }>
params?	Partial<EditMessageCaptionParams>

Returns

Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

---

editLiveLocation()

editLiveLocation(params): Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

Defined in: contexts/index.d.ts:5523

Edits a callback query messages live location

Parameters

Parameter	Type
params	EditMessageLiveLocationParams

Returns

Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

---

editMedia()

editMedia(media, params?): Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

Defined in: contexts/index.d.ts:5521

Edits a callback query messages media

Parameters

Parameter	Type
media	TelegramInputMedia
params?	Partial<EditMessageMediaParams>

Returns

Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

---

editReplyMarkup()

editReplyMarkup(replyMarkup, params?): Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

Defined in: contexts/index.d.ts:5527

Edits a callback query messages reply markup

Parameters

Parameter	Type
replyMarkup	TelegramInlineKeyboardMarkup | { toJSON: TelegramInlineKeyboardMarkup; }
params?	Partial<EditMessageReplyMarkupParams>

Returns

Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

---

editText()

editText(text, params?): Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

Defined in: contexts/index.d.ts:5517

Edits a callback query messages text

Parameters

Parameter	Type
text	string | { toString: string; }
params?	Partial<EditMessageTextParams>

Returns

Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

---

getChatBoosts()

getChatBoosts(userId): Promise<TelegramUserChatBoosts>

Defined in: contexts/index.d.ts:5068

Returns chat boosts by the user

Parameters

Parameter	Type
userId	number

Returns

Promise<TelegramUserChatBoosts>

Inherited from

SendMixin.getChatBoosts

---

hasData()

hasData(): this is Require<CallbackQueryContext<Bot>, "data">

Defined in: contexts/index.d.ts:5507

Checks if the query has data property

Returns

this is Require<CallbackQueryContext<Bot>, "data">

---

hasGameShortName()

hasGameShortName(): this is Require<CallbackQueryContext<Bot>, "gameShortName">

Defined in: contexts/index.d.ts:5509

Checks if the query has gameShortName property

Returns

this is Require<CallbackQueryContext<Bot>, "gameShortName">

---

hasInlineMessageId()

hasInlineMessageId(): this is Require<CallbackQueryContext<Bot>, "inlineMessageId">

Defined in: contexts/index.d.ts:5505

Checks if the query has inlineMessageId property

Returns

this is Require<CallbackQueryContext<Bot>, "inlineMessageId">

---

hasMessage()

hasMessage(): this is Require<CallbackQueryContext<Bot>, "message">

Defined in: contexts/index.d.ts:5486

Checks if the query has message property

Returns

this is Require<CallbackQueryContext<Bot>, "message">

---

hasQueryPayload()

hasQueryPayload(): this is Require<CallbackQueryContext<Bot>, "queryPayload">

Defined in: contexts/index.d.ts:5498

Checks if the query has queryPayload property

Returns

this is Require<CallbackQueryContext<Bot>, "queryPayload">

---

is()

is<T>(rawTypes): this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})

Defined in: contexts/index.d.ts:4865

Type Parameters

Type Parameter
T extends UpdateName

Parameters

Parameter	Type
rawTypes	MaybeArray<SoftString<T>>

Returns

this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})

Inherited from

Context.is

---

send()

send(text, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:4998

Sends message to current chat

Parameters

Parameter	Type
text	string | { toString: string; }
params?	Optional<SendMessageParams, "text" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.send

---

sendAnimation()

sendAnimation(animation, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5008

Sends animation to current chat

Parameters

Parameter	Type
animation	string | Blob
params?	Optional<SendAnimationParams, "animation" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendAnimation

---

sendAudio()

sendAudio(audio, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5004

Sends audio to current chat

Parameters

Parameter	Type
audio	string | Blob
params?	Optional<SendAudioParams, "audio" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendAudio

---

sendChatAction()

sendChatAction(action, params?): Promise<true>

Defined in: contexts/index.d.ts:5032

Sends chat action to current chat

Parameters

Parameter	Type
action	SendChatActionAction
params?	Optional<SendChatActionParams, "chat_id" | "action">

Returns

Promise<true>

Inherited from

SendMixin.sendChatAction

---

sendChecklist()

sendChecklist(params): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5024

Sends checklist to current chat

Parameters

Parameter	Type
params	Optional<SendChecklistParams, "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendChecklist

---

sendContact()

sendContact(params): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5020

Sends contact to current chat

Parameters

Parameter	Type
params	Optional<SendContactParams, "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendContact

---

sendDice()

sendDice(emoji, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5034

Sends dice

Parameters

Parameter	Type
emoji	SendDiceEmoji
params?	Partial<SendDiceParams>

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendDice

---

sendDocument()

sendDocument(document, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5002

Sends document to current chat

Parameters

Parameter	Type
document	string | Blob
params?	Optional<SendDocumentParams, "document" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendDocument

---

sendInvoice()

sendInvoice(params): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5016

Sends invoice to current user

Parameters

Parameter	Type
params	Optional<SendInvoiceParams, "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendInvoice

---

sendLocation()

sendLocation(latitude, longitude, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5014

Sends location to current chat

Parameters

Parameter	Type
latitude	number
longitude	number
params?	Optional<SendLocationParams, "chat_id" | "latitude" | "longitude">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendLocation

---

sendMedia()

sendMedia<T>(query): ReturnType<T extends "animation" ? (animation, params?) => Promise<MessageContext<Bot>> : T extends "audio" ? (audio, params?) => Promise<MessageContext<Bot>> : T extends "document" ? (document, params?) => Promise<MessageContext<Bot>> : T extends "photo" ? (photo, params?) => Promise<MessageContext<Bot>> : T extends "sticker" ? (sticker, params?) => Promise<MessageContext<Bot>> : T extends "video_note" ? (videoNote, params?) => Promise<MessageContext<Bot>> : T extends "video" ? (video, params?) => Promise<MessageContext<...>> : T extends "voice" ? (voice, params?) => Promise<...> : () => never>

Defined in: contexts/index.d.ts:5051

Automatically uses correct media method to send media

Type Parameters

Type Parameter
T extends string

Parameters

Parameter	Type
query	object & tSendMethods

Returns

ReturnType<T extends "animation" ? (animation, params?) => Promise<MessageContext<Bot>> : T extends "audio" ? (audio, params?) => Promise<MessageContext<Bot>> : T extends "document" ? (document, params?) => Promise<MessageContext<Bot>> : T extends "photo" ? (photo, params?) => Promise<MessageContext<Bot>> : T extends "sticker" ? (sticker, params?) => Promise<MessageContext<Bot>> : T extends "video_note" ? (videoNote, params?) => Promise<MessageContext<Bot>> : T extends "video" ? (video, params?) => Promise<MessageContext<...>> : T extends "voice" ? (voice, params?) => Promise<...> : () => never>

Example

context.sendMedia({
  type: 'photo',
  photo: MediaUpload.path('./image.png'),
  caption: 'good image yes yes'
})

Inherited from

SendMixin.sendMedia

---

sendMediaGroup()

sendMediaGroup(mediaGroup, params?): Promise<MessageContext<Bot>[]>

Defined in: contexts/index.d.ts:5038

Sends media group to current chat

Parameters

Parameter	Type
mediaGroup	(TelegramInputMediaAudio | TelegramInputMediaDocument | TelegramInputMediaPhoto | TelegramInputMediaVideo)[]
params?	Optional<SendMediaGroupParams, "chat_id" | "media">

Returns

Promise<MessageContext<Bot>[]>

Inherited from

SendMixin.sendMediaGroup

---

sendMessageDraft()

sendMessageDraft(params): Promise<true>

Defined in: contexts/index.d.ts:5030

Sends a message draft to the current private chat

Parameters

Parameter	Type
params	Optional<SendMessageDraftParams, "chat_id">

Returns

Promise<true>

Inherited from

SendMixin.sendMessageDraft

---

sendPaidMedia()

sendPaidMedia(paidMedia, starCount, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5036

Sends paid media to current chat

Parameters

Parameter	Type
paidMedia	TelegramInputPaidMedia[]
starCount	number
params?	Optional<SendPaidMediaParams, "chat_id" | "media" | "star_count">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendPaidMedia

---

sendPhoto()

sendPhoto(photo, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5000

Sends photo to current chat

Parameters

Parameter	Type
photo	string | Blob
params?	Optional<SendPhotoParams, "photo" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendPhoto

---

sendPoll()

sendPoll(params): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5022

Sends poll to current chat

Parameters

Parameter	Type
params	Optional<SendPollParams, "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendPoll

---

sendSticker()

sendSticker(sticker, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5026

Sends sticker

Parameters

Parameter	Type
sticker	string | Blob
params?	Optional<SendStickerParams, "sticker" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendSticker

---

sendVenue()

sendVenue(params): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5018

Sends venue to current chat

Parameters

Parameter	Type
params	Optional<SendVenueParams, "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendVenue

---

sendVideo()

sendVideo(video, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5006

Sends video to current chat

Parameters

Parameter	Type
video	string | Blob
params?	Optional<SendVideoParams, "video" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendVideo

---

sendVideoNote()

sendVideoNote(videoNote, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5010

Sends video note to current chat

Parameters

Parameter	Type
videoNote	string | Blob
params?	Optional<SendVideoNoteParams, "video_note" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendVideoNote

---

sendVoice()

sendVoice(voice, params?): Promise<MessageContext<Bot>>

Defined in: contexts/index.d.ts:5012

Sends voice to current chat

Parameters

Parameter	Type
voice	string | Blob
params?	Optional<SendVoiceParams, "voice" | "chat_id">

Returns

Promise<MessageContext<Bot>>

Inherited from

SendMixin.sendVoice

---

stopLiveLocation()

stopLiveLocation(params?): Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

Defined in: contexts/index.d.ts:5525

Stops a callback query messages live location

Parameters

Parameter	Type
params?	StopMessageLiveLocationParams

Returns

Promise<true | TelegramMessage> | Promise<true | MessageContext<Bot>>

---

stopPoll()

stopPoll(messageId, params?): Promise<Poll>

Defined in: contexts/index.d.ts:5028

Stops poll in current chat

Parameters

Parameter	Type
messageId	number
params?	Partial<StopPollParams>

Returns

Promise<Poll>

Inherited from

SendMixin.stopPoll

---

streamMessage()

streamMessage(stream, options?): Promise<MessageContext<Bot>[]>

Defined in: contexts/index.d.ts:5066

Streams message drafts to the current chat, finalizing each completed draft as a sent message.

Accepts an Iterable or AsyncIterable of MessageDraftPiece (strings or objects with text+entities). Uses sendMessageDraft for live typing previews and sendMessage to finalize each 4096-char segment. Returns an array of sent MessageContext objects.

Parameters

Parameter	Type
stream	Iterable<MessageDraftPiece, any, any> | AsyncIterable<MessageDraftPiece, any, any>
options?	StreamMessageOptions

Returns

Promise<MessageContext<Bot>[]>

Example

// Stream from an async generator (e.g., LLM output)
const messages = await context.streamMessage(llmStream);

Inherited from

SendMixin.streamMessage