Methods

api.getChatInviteLinks()

Returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links

Parameters GetChatInviteLinksParams:

Parameters

Interface

Name	Type	Description
`chatId`	`number`	Chat identifier
`creatorUserId`	`number`	User identifier of a chat administrator. Must be an identifier of the current user for non-owner
`isRevoked`	`boolean`	Pass true if revoked links needs to be returned instead of active or expired
`offsetDate`	`number`	Creation date of an invite link starting after which to return invite links; use 0 to get results from the beginning
`offsetInviteLink`	`string`	Invite link starting after which to return invite links; use empty string to get results from the beginning
`limit`	`number`	The maximum number of invite links to return; up to 100

Returns ApiResponse interface:

interface ApiResponse {
  _: 'getChatInviteLinks' | 'error'
  airgram: Airgram
  request: {
    method: 'getChatInviteLinks'
    params: GetChatInviteLinksParams
  }
  response: ChatInviteLinksUnion
 | Error
  setState: (nextState: Record<string, unknown>) => void
  getState: () => Record<string, unknown>
}