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 AppInstanceUserArn of the user that makes the API call as the value in the header.
Query parameters
The ARN of the <code>AppInstance</code>.
The privacy setting. <code>PUBLIC</code> retrieves all the public channels. <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code> can retrieve private channels.
The maximum number of channels that you want to return.
The token passed by previous API calls until all requested channels are returned.
Pagination limit
Pagination token
Headers
The <code>AppInstanceUserArn</code> of the user that makes the API call.
Response
Success