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

ListChannelMessages

List all the messages in a channel. Returns a paginated list of ChannelMessages. 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Request Syntax


GET /channels/channelArn/messages?max-results=MaxResults&next-token=NextToken&not-after=NotAfter&not-before=NotBefore&sort-order=SortOrder&sub-channel-id=SubChannelId HTTP/1.1
x-amz-chime-bearer: ChimeBearer

URI Request Parameters

The request uses the following URI parameters.

channelArn

The ARN of the channel.

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 messages that you want returned.

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

NextToken

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

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

Pattern: .*

NotAfter

The final or ending time stamp for your requested messages.

NotBefore

The initial or starting time stamp for your requested messages.

SortOrder

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

Valid Values: ASCENDING | DESCENDING

SubChannelId

The ID of the SubChannel in the request.

Note

Only required when listing the messages in a SubChannel that the user belongs to.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ChannelArn": "string",
   "ChannelMessages": [ 
      { 
         "Content": "string",
         "ContentType": "string",
         "CreatedTimestamp": number,
         "LastEditedTimestamp": number,
         "LastUpdatedTimestamp": number,
         "MessageAttributes": { 
            "string" : { 
               "StringValues": [ "string" ]
            }
         },
         "MessageId": "string",
         "Metadata": "string",
         "Redacted": boolean,
         "Sender": { 
            "Arn": "string",
            "Name": "string"
         },
         "Status": { 
            "Detail": "string",
            "Value": "string"
         },
         "Target": [ 
            { 
               "MemberArn": "string"
            }
         ],
         "Type": "string"
      }
   ],
   "NextToken": "string",
   "SubChannelId": "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.

ChannelArn

The ARN of the channel containing the requested messages.

Type: String

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}

ChannelMessages

The information about, and content of, each requested message.

Type: Array of ChannelMessageSummary objects

NextToken

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

Type: String

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

Pattern: .*

SubChannelId

The ID of the SubChannel in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [-_a-zA-Z0-9]*

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