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

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

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

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