Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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.

Note

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.

Request Syntax


GET /channels?app-instance-arn=AppInstanceArn&max-results=MaxResults&next-token=NextToken&privacy=Privacy HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

AppInstanceArn

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

ChimeBearer

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

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

MaxResults

The maximum number of channels that you want to return.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken

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

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Privacy

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

Valid Values: PUBLIC | PRIVATE

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Channels": [ 
      { 
         "ChannelArn": "string",
         "LastMessageTimestamp": number,
         "Metadata": "string",
         "Mode": "string",
         "Name": "string",
         "Privacy": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Channels

The information about each channel.

Type: Array of ChannelSummary objects

NextToken

The token returned from previous API requests until the number of channels is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401