Available methods

getUserProfileAudios()

Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

parameters

parametertyperequireddescription
user_idnumberrequiredUnique identifier of the target user
offsetnumberoptionalSequential number of the first audio to be returned. By default, all audios are returned.
limitnumberoptionalLimits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.

returns

UserProfileAudios

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

await bot.api.call<UserProfileAudios>("getUserProfileAudios", {
  user_id: 123456789,
} satisfies GetUserProfileAudiosParams);

context shortcut

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

context shortcut
/** Use this method to get a list of profile audios for a user. Returns a [UserProfileAudios](https://core.telegram.org/bots/api/#userprofileaudios) object. */
ctx.getUserProfileAudios(params: Omit<GetUserProfileAudiosParams, "user_id">)