v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, 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.

get/channels/{channelArn}/messages#x-amz-chime-bearer

Path parameters

channelArnstring required

The ARN of the channel.

Query parameters

sort-order'ASCENDING' | 'DESCENDING'

The order in which you want messages sorted. Default is Descending, based on time created.

not-beforestring date-time

The initial or starting time stamp for your requested messages.

not-afterstring date-time

The final or ending time stamp for your requested messages.

max-resultsinteger

The maximum number of messages that you want returned.

next-tokenstring password

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

sub-channel-idstring
<p>The ID of the SubChannel in the request.</p> <note> <p>Only required when listing the messages in a SubChannel that the user belongs to.</p> </note>

Headers

x-amz-chime-bearerstring required

The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.

Response

Success

ChannelArnstring

The ARN of the channel containing the requested messages.

NextTokenstring password

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

SubChannelIdstring

The ID of the SubChannel in the response.