Skip to content

GramIO API Reference / gramio/dist / BanChatMemberParams

Interface: BanChatMemberParams

Defined in: @gramio/types/out/params.d.ts:1721

Params object for banChatMember method

Properties

PropertyTypeDescriptionDefined in
chat_idstring | numberUnique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)@gramio/types/out/params.d.ts:1725
revoke_messages?booleanPass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.@gramio/types/out/params.d.ts:1737
until_date?numberDate when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.@gramio/types/out/params.d.ts:1733
user_idnumberUnique identifier of the target user@gramio/types/out/params.d.ts:1729