Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket.

Messages can have any one of these statuses.

SENT

Message processed successfully

PENDING

Ongoing processing

FAILED

Processing failed

DENIED

Message denied by the processor

  • This API does not return statuses for denied messages, because we don't store them once the processor denies them.

  • Only the message sender can invoke this API.

  • 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/{messageId}#scope=message-status&x-amz-chime-bearer

Path parameters

channelArnstring required

The ARN of the channel

messageIdstring required

The ID of the message.

Query parameters

sub-channel-idstring
<p>The ID of the SubChannel in the request.</p> <note> <p>Only required when getting message status in a SubChannel that the user belongs to.</p> </note>
scope'message-status' required

Headers

x-amz-chime-bearerstring required

The <code>AppInstanceUserArn</code> of the user making the API call.

Response

Success