ChimeSDKMessaging / Client / get_channel_message_status

get_channel_message_status#

ChimeSDKMessaging.Client.get_channel_message_status(**kwargs)#

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

Messasge denied by the processor

Note

  • 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 AppInstanceUserArn of the user that makes the API call as the value in the header

See also: AWS API Documentation

Request Syntax

response = client.get_channel_message_status(
    ChannelArn='string',
    MessageId='string',
    ChimeBearer='string',
    SubChannelId='string'
)
Parameters:

  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel

  • MessageId (string) –

    [REQUIRED]

    The ID of the message.

  • ChimeBearer (string) –

    [REQUIRED]

    The AppInstanceUserArn of the user making the API call.

  • SubChannelId (string) –

    The ID of the SubChannel in the request.

    Note

    Only required when getting message status in a SubChannel that the user belongs to.

Return type:

dict

Returns:

Response Syntax

{
    'Status': {
        'Value': 'SENT'|'PENDING'|'FAILED'|'DENIED',
        'Detail': 'string'
    }
}

Response Structure

  • (dict) –

    • Status (dict) –

      The message status and details.

      • Value (string) –

        The message status value.

      • Detail (string) –

        Contains more details about the messasge status.

Exceptions

  • ChimeSDKMessaging.Client.exceptions.BadRequestException

  • ChimeSDKMessaging.Client.exceptions.ForbiddenException

  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException

  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException