getChat()

Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.

parameters

parameter	type	required	description
`chat_id`	number \| string	required	Unique identifier for the target chat or username of the target supergroup or channel in the format `@username`

returns

ChatFullInfo

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts

import type { ChatFullInfo, GetChatParams } from "@yaebal/types";

await bot.api.call<ChatFullInfo>("getChat", {
  chat_id: 123456789,
} satisfies GetChatParams);

context shortcut

also available as ctx.getChat() on 16 context types — see @yaebal/contexts.

context shortcut

/** Use this method to get up-to-date information about the chat. Returns a [ChatFullInfo](https://core.telegram.org/bots/api/#chatfullinfo) object on success. */
ctx.getChat(params?: Omit<GetChatParams, "chat_id">)

official Bot API docs: https://core.telegram.org/bots/api/#getchat