getUserChatBoosts()

Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

parameters

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

returns

UserChatBoosts

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 { GetUserChatBoostsParams, UserChatBoosts } from "@yaebal/types";

await bot.api.call<UserChatBoosts>("getUserChatBoosts", {
  chat_id: 123456789,
  user_id: 123456789,
} satisfies GetUserChatBoostsParams);

context shortcut

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

context shortcut

/** Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a [UserChatBoosts](https://core.telegram.org/bots/api/#userchatboosts) object. */
ctx.getUserChatBoosts(params?: Omit<GetUserChatBoostsParams, "chat_id" | "user_id">)

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