Skip to content

/AWS1/CL_CHS=>LISTCHANNELBANS()

About ListChannelBans

Lists all the users and bots banned from a particular channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Method Signature

IMPORTING

Required arguments:

IV_CHANNELARN TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The ARN of the channel.

IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional arguments:

IV_MAXRESULTS TYPE /AWS1/CHSMAXRESULTS /AWS1/CHSMAXRESULTS

The maximum number of bans that you want returned.

IV_NEXTTOKEN TYPE /AWS1/CHSNEXTTOKEN /AWS1/CHSNEXTTOKEN

The token passed by previous API calls until all requested bans are returned.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CHSLISTCHANNELBANSRSP /AWS1/CL_CHSLISTCHANNELBANSRSP