MessageContext<TTools, TRaw>

Defined in: core/provider.ts:972 The ergonomic context handed to every handler. Generic over TRaw. The reply helpers keep IDENTICAL signatures to v1 — internally each now builds an OutboundContent descriptor and calls provider.send, instead of hand-rolling Baileys JSON. from/sender/body/type/isGroup are read straight off the normalized InboundMessage, so user code and keyFor are unchanged.

Type Parameters

Type Parameter	Default type
`TTools` extends `object`	`DefaultTools`
`TRaw`	`unknown`

Properties

body

body: string;

Defined in: core/provider.ts:974

from

from: string;

Defined in: core/provider.ts:975

sender

sender: string;

Defined in: core/provider.ts:976

senderInfo

senderInfo: SenderInfo;

Defined in: core/provider.ts:977

pushName?

pushName?: string;

Defined in: core/provider.ts:978

chat

chat: ChatInfo;

Defined in: core/provider.ts:979

type

type: MessageType;

Defined in: core/provider.ts:980

isGroup

isGroup: boolean;

Defined in: core/provider.ts:981

isPrivate

isPrivate: boolean;

Defined in: core/provider.ts:982

isFromMe

isFromMe: boolean;

Defined in: core/provider.ts:983

mentions

mentions: string[];

Defined in: core/provider.ts:984

quoted?

quoted?: QuotedRef;

Defined in: core/provider.ts:985

media?

media?: MediaPayload;

Defined in: core/provider.ts:986

sharedLocation?

sharedLocation?: InboundLocation;

Defined in: core/provider.ts:991 The location the user shared (type === 'location'), normalized by the provider; undefined otherwise. Named sharedLocation because ctx.location() SENDS one.

ref

ref: MessageRef;

Defined in: core/provider.ts:992

raw

raw: TRaw;

Defined in: core/provider.ts:993

timestamp

timestamp: number;

Defined in: core/provider.ts:998 When the message was sent, in epoch milliseconds (new Date(ctx.timestamp) works). A provider that still reports epoch seconds is converted.

interaction?

interaction?: object;

Defined in: core/provider.ts:1007 Present only when this context projects an interaction (Telegram/Discord). acknowledge() is a safe no-op on transports without ack (WhatsApp). On a transport with capabilities.interactionsRequireAck the core acks on its own; once that ack went out (after the first send or near the deadline), acknowledge(text) sends text as a regular reply instead.

id

id: string;

data

data: string;

respondBy?

respondBy?: number;

call?

call?: CallEvent;

Defined in: core/provider.ts:1014 Present only on the context the CALL trigger receives (type === 'call'): the provider’s normalized call notification.

capabilities?

capabilities?: ProviderCapabilities;

Defined in: core/provider.ts:1093 Capabilities of the provider this message came from (set on contexts built by a Bot).

textFormat?

textFormat?: TextFormat;

Defined in: core/provider.ts:1099 Rich-text dialect of THIS chat: the provider’s textFormatFor(chatId), else capabilities.textFormat. Unset = unknown (send Markdown untouched). Use it, not capabilities.textFormat, to format text for the chat (@botmesh/ai does).

user

user: UserData;

Defined in: core/provider.ts:1126 Persistent profile of the sender (ctx.sender), shared across chats — see UserData. ctx.user.ns('game') scopes it to a namespace.

lang

lang: string;

Defined in: core/provider.ts:1132 Resolved language of this message (normalized locale code, e.g. 'es', 'en'). Order: ctx.user preference → provider-reported language → i18n.detect → default.

defaultLang?

readonly defaultLang?: string;

Defined in: core/provider.ts:1138 The bot’s default locale (lang / i18n.defaultLocale, 'en' unless configured), whatever lang resolved to. Plugins that ship their own built-in texts for a few languages use it as the fallback for a lang they do not cover.

langSource?

langSource?: LangSource;

Defined in: core/provider.ts:1145 Where lang came from ('user' | 'provider' | 'detector' | 'default'); undefined while i18n is off (then lang is just the default locale). Plugins that want a real language signal (e.g. a speech-to-text hint) should ignore 'default'. A hook that assigns ctx.lang directly does not update it.

tools

tools: TTools;

Defined in: core/provider.ts:1162

Methods

acknowledge()

acknowledge(text?): Promise<void>;

Defined in: core/provider.ts:1008

Parameters

Parameter	Type
`text?`	`string`

Returns

Promise<void>

say()

say(text, opts?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1023 Send text to this chat. Same as MessageContext.reply.

Parameters

Parameter	Type
`text`	`string`
`opts?`	`ReplyOptions`

Returns

Promise<SentMessage<unknown>>

Deprecated

Use MessageContext.reply (ctx.reply(text)). The flow DSL’s .say() step is not affected.

reply()

reply(text, opts?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1025 Send text to this chat (ctx.from). The canonical text reply.

Parameters

Parameter	Type
`text`	`string`
`opts?`	`ReplyOptions`

Returns

Promise<SentMessage<unknown>>

answer()

answer(text, opts?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1027

Parameters

Parameter	Type
`text`	`string`
`opts?`	`ReplyOptions`

Returns

Promise<SentMessage<unknown>>

Deprecated

Use MessageContext.reply (ctx.reply(text)).

text()

text(t, opts?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1029

Parameters

Parameter	Type
`t`	`string`
`opts?`	`ReplyOptions`

Returns

Promise<SentMessage<unknown>>

Deprecated

Use MessageContext.reply (ctx.reply(text)).

photo()

photo(source, caption?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1030

Parameters

Parameter	Type
`source`	`MediaSource`
`caption?`	`string`

Returns

Promise<SentMessage<unknown>>

video()

video(
   source, 
   caption?, 
   opts?
): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1031

Parameters

Parameter	Type
`source`	`MediaSource`
`caption?`	`string`
`opts?`	{ `gifPlayback?`: `boolean`; `ptv?`: `boolean`; }
`opts.gifPlayback?`	`boolean`
`opts.ptv?`	`boolean`

Returns

Promise<SentMessage<unknown>>

audio()

audio(source): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1032

Parameters

Parameter	Type
`source`	`MediaSource`

Returns

Promise<SentMessage<unknown>>

voice()

voice(source): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1033

Parameters

Parameter	Type
`source`	`MediaSource`

Returns

Promise<SentMessage<unknown>>

file()

file(
   source, 
   filename?, 
   caption?
): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1034

Parameters

Parameter	Type
`source`	`MediaSource`
`filename?`	`string`
`caption?`	`string`

Returns

Promise<SentMessage<unknown>>

sticker()

sticker(source, opts?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1035

Parameters

Parameter	Type
`source`	`MediaSource`
`opts?`	{ `pack?`: `string`; `author?`: `string`; }
`opts.pack?`	`string`
`opts.author?`	`string`

Returns

Promise<SentMessage<unknown>>

location()

location(
   lat, 
   lng, 
   name?
): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1036

Parameters

Parameter	Type
`lat`	`number`
`lng`	`number`
`name?`	`string`

Returns

Promise<SentMessage<unknown>>

contact()

contact(phone, displayName?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1037

Parameters

Parameter	Type
`phone`	`string`
`displayName?`	`string`

Returns

Promise<SentMessage<unknown>>

poll()

poll(
   question, 
   options, 
   multiSelect?
): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1038

Parameters

Parameter	Type
`question`	`string`
`options`	`string`[]
`multiSelect?`	`boolean`

Returns

Promise<SentMessage<unknown>>

buttons()

buttons(text, buttons): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1039

Parameters

Parameter	Type
`text`	`string`
`buttons`	`Button`[]

Returns

Promise<SentMessage<unknown>>

react()

react(emoji, target?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1045 React to the inbound message (or target). On a provider without capabilities.reactions it resolves a skipped result instead of rejecting. An empty emoji removes the reaction where the transport supports it.

Parameters

Parameter	Type
`emoji`	`string`
`target?`	`MessageRef`

Returns

Promise<SentMessage<unknown>>

quote()

quote(text, opts?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1046

Parameters

Parameter	Type
`text`	`string`
`opts?`	`ReplyOptions`

Returns

Promise<SentMessage<unknown>>

edit()

Call Signature

edit(content, opts?): Promise<EditResult>;

Defined in: core/provider.ts:1056 Edit this context’s own last reply (ctx.edit(content), only when it has the same content kind and no bot.send/bot.sendTo went to the chat since; replies of other handler runs or other participants’ flows are never targeted) or a given one (ctx.edit(ref, content); a fallback send goes to ref.chatId). Native when the provider has capabilities.edit and editMessage; otherwise (or when the kind is not editable there) it falls back to sending a new message — { fallback: 'skip' } sends nothing instead. Edits run the before/after('send') hooks (payload edit: ref); a hook abort resolves skipped.

Parameters

Parameter	Type
`content`	`string` \| `OutboundContent`
`opts?`	`EditOptions`

Returns

Promise<EditResult>

Call Signature

edit(
   ref, 
   content, 
   opts?
): Promise<EditResult>;

Defined in: core/provider.ts:1057

Parameters

Parameter	Type
`ref`	`MessageRef`
`content`	`string` \| `OutboundContent`
`opts?`	`EditOptions`

Returns

Promise<EditResult>

supports()

supports(feature): MessagingSupport;

Defined in: core/provider.ts:1059 How the current provider supports a messaging feature (native / degraded / unsupported).

Parameters

Parameter	Type
`feature`	`MessagingFeature`

Returns

MessagingSupport

replyWithTyping()

replyWithTyping(text, msPerChar?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1068 Show “typing…” for about msPerChar ms per character (40 by default, capped at 5 s), then send text. Ignores BotConfig.typing.

Parameters

Parameter	Type
`text`	`string`
`msPerChar?`	`number`

Returns

Promise<SentMessage<unknown>>

Deprecated

Use ctx.reply(text, { typing: true }) (or a TypingConfig object such as { typing: { charsPerSecond: 25, maxMs: 5000 } }): it shares the bot-wide typing policy, refreshes the indicator and is dropped on stop/handoff like every paced reply.

sendNative()

sendNative(provider, payload): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1070 Escape hatch for transport-native content (templates, components).

Parameters

Parameter	Type
`provider`	`string`
`payload`	`unknown`

Returns

Promise<SentMessage<unknown>>

stream()

stream(source, opts?): Promise<StreamResult>;

Defined in: core/provider.ts:1077 Stream a reply that is still being generated (e.g. LLM tokens) to this chat, using the best strategy the provider supports (capabilities.streaming): native drafts, throttled edits, or sentence chunks with typing. Long text is split so no message exceeds capabilities.maxTextLength. See StreamOptions.

Parameters

Parameter	Type
`source`	`StreamSource`
`opts?`	`StreamOptions`

Returns

Promise<StreamResult>

form()?

form?(definition, opts?): Promise<SentMessage<unknown>>;

Defined in: core/provider.ts:1085 Send a native form (OutboundContent kind 'form'). Only meaningful when capabilities.forms === 'native'; other providers reject it with UnsupportedContentError. The submission arrives as an inbound message of type 'form' (see parseFormReply()); flow().form() handles all of this. Set on contexts built by a Bot.

Parameters

Parameter	Type
`definition`	`FormDefinition`
`opts?`	{ `token?`: `string`; `nativeId?`: `string`; }
`opts.token?`	`string`
`opts.nativeId?`	`string`

Returns

Promise<SentMessage<unknown>>

canRenderForm()?

canRenderForm?(definition, opts?): boolean;

Defined in: core/provider.ts:1091 Whether the provider can render definition natively right now (see IProvider.canRenderForm). Set on contexts built by a Bot whose provider implements it; absent = assume yes when capabilities.forms === 'native'.

Parameters

Parameter	Type
`definition`	`FormDefinition`
`opts?`	{ `nativeId?`: `string`; }
`opts.nativeId?`	`string`

Returns

boolean

markRead()

markRead(): Promise<void>;

Defined in: core/provider.ts:1102

Returns

Promise<void>

typing()

typing(): Promise<void>;

Defined in: core/provider.ts:1104 Show the typing indicator. Best-effort: never rejects (a provider failure is logged at debug).

Returns

Promise<void>

recording()

recording(): Promise<void>;

Defined in: core/provider.ts:1106 Show the recording-audio indicator. Best-effort like typing.

Returns

Promise<void>

delete()

delete(): Promise<void>;

Defined in: core/provider.ts:1107

Returns

Promise<void>

handoff()

handoff(opts?): Promise<boolean>;

Defined in: core/provider.ts:1115 Hand this chat (from) over to a human: the bot stops routing its messages until bot.resume(chatId), and any conversation in the chat is cancelled silently. Resolves true if the chat was not already handed off. Safe to call without awaiting (the state flips synchronously). See bot.handoff().

Parameters

Parameter	Type
`opts?`	`HandoffOptions`

Returns

Promise<boolean>

pass()

pass(): void;

Defined in: core/provider.ts:1118

Returns

void

abort()

abort(): void;

Defined in: core/provider.ts:1119

Returns

void

next()?

next?(): Promise<void>;

Defined in: core/provider.ts:1120

Returns

Promise<void>

t()

t(key, params?): string;

Defined in: core/provider.ts:1151 Translate key (dot path) in lang, interpolating {param} placeholders; params.count picks plural forms. Missing keys fall back to the default locale, then to the key itself. See bot.locale().

Parameters

Parameter	Type
`key`	`string`
`params?`	`TranslateParams`

Returns

string

setLang()

setLang(code): Promise<void>;

Defined in: core/provider.ts:1160 Switch the sender’s language: persists the registered locale serving code ('en-GB' → 'en' when only en exists) to ctx.user (key 'lang' by default) and updates lang for this message. Rejects with TypeError on an empty code or one no registered locale serves (nothing is stored), with Error while i18n is not enabled (no bot.locale() call and no BotConfig.i18n), and with UserDataError when the profile cannot be written.

Parameters

Parameter	Type
`code`	`string`

Returns

Promise<void>

​Type Parameters

​Properties

​body

​from

​sender

​senderInfo

​pushName?

​chat

​type

​isGroup

​isPrivate

​isFromMe

​mentions

​quoted?

​media?

​sharedLocation?

​ref

​raw

​timestamp

​interaction?

​id

​data

​respondBy?

​call?

​capabilities?

​textFormat?

​user

​lang

​defaultLang?

​langSource?

​tools

​Methods

​acknowledge()

​Parameters

​Returns

​say()

​Parameters

​Returns

​Deprecated

​reply()

​Parameters

​Returns

​answer()

​Parameters

​Returns

​Deprecated

​text()

​Parameters

​Returns

​Deprecated

​photo()

​Parameters

​Returns

​video()

​Parameters

​Returns

​audio()

​Parameters

​Returns

​voice()

​Parameters

​Returns

​file()

​Parameters

​Returns

​sticker()

​Parameters

​Returns

​location()

​Parameters

​Returns

​contact()

​Parameters

​Returns

​poll()

​Parameters

​Returns

​buttons()

​Parameters

​Returns

Type Parameters

Properties

body

from

sender

senderInfo

pushName?

chat

type

isGroup

isPrivate

isFromMe

mentions

quoted?

media?

sharedLocation?

ref

raw

timestamp

interaction?

id

data

respondBy?

call?

capabilities?

textFormat?

user

lang

defaultLang?

langSource?

tools

Methods

acknowledge()

Parameters

Returns

say()

Parameters

Returns

Deprecated

reply()

Parameters

Returns

answer()

Parameters

Returns

Deprecated

text()

Parameters

Returns

Deprecated

photo()

Parameters

Returns

video()

Parameters

Returns

audio()

Parameters

Returns

voice()

Parameters

Returns

file()

Parameters

Returns

sticker()

Parameters

Returns

location()

Parameters

Returns

contact()

Parameters

Returns

poll()

Parameters

Returns

buttons()

Parameters

Returns