GET

/channels/{channelArn}/messages

http://service.chime.aws.amazon.com/channels/{channelArn}/messages

List all the messages in a channel. Returns a paginated list of <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending order. <note> 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 <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </note>

Access Token Required: API Key

Path Parameters

channelArnstringrequired

The ARN of the channel.

Query Params

sort-orderstring

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

Allowed:

not-beforestring

The initial or starting time stamp for your requested messages.

not-afterstring

The final or ending time stamp for your requested messages.

max-resultsinteger

The maximum number of messages that you want returned.

next-tokenstring

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

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://service.chime.aws.amazon.com/channels/{channelArn}/messages' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}