Available methods

getBusinessConnection()

Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

parameters

parametertyperequireddescription
business_connection_idstringrequiredUnique identifier of the business connection

returns

BusinessConnection

usage in yaebal

getBusinessConnection is directly typed on Api — call it straight off bot.api.

bot.ts
import type { GetBusinessConnectionParams } from "@yaebal/types";

await bot.api.getBusinessConnection({
  business_connection_id: "...",
} satisfies GetBusinessConnectionParams);

context shortcut

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

context shortcut
/** Use this method to get information about the connection of the bot with a business account. Returns a [BusinessConnection](https://core.telegram.org/bots/api/#businessconnection) object on success. */
ctx.getBusinessConnection(params?: Omit<GetBusinessConnectionParams, "business_connection_id"> & { business_connection_id?: string })