Methods

api.banChatMember()

Bans a member in a chat. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first

Parameters BanChatMemberParams:

Parameters

Interface

Name	Type	Description
`chatId`	`number`	Chat identifier
`memberId`	MessageSenderInputUnion	Member identifier
`bannedUntilDate`	`number`	Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Ignored in basic groups and if a chat is banned
`revokeMessages`	`boolean`	Pass true to delete all messages in the chat for the user that is being removed. Always true for supergroups and channels

Returns ApiResponse interface:

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