/AWS1/CL_CHS=>LISTCHANNELS()

About ListChannels

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

• Use privacy = PUBLIC to retrieve all public channels in the account.

• Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

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_APPINSTANCEARN TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The ARN of the AppInstance.

IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

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

Optional arguments:

IV_PRIVACY TYPE /AWS1/CHSCHANNELPRIVACY /AWS1/CHSCHANNELPRIVACY

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

IV_MAXRESULTS TYPE /AWS1/CHSMAXRESULTS /AWS1/CHSMAXRESULTS

The maximum number of channels that you want to return.

IV_NEXTTOKEN TYPE /AWS1/CHSNEXTTOKEN /AWS1/CHSNEXTTOKEN

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CHSLISTCHANNELSRSP /AWS1/CL_CHSLISTCHANNELSRSP