/AWS1/CL_CHS=>GETCHANNELMESSAGESTATUS()
¶
About GetChannelMessageStatus¶
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 theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CHANNELARN
TYPE /AWS1/CHSCHIMEARN
/AWS1/CHSCHIMEARN
¶
The ARN of the channel
IV_MESSAGEID
TYPE /AWS1/CHSMESSAGEID
/AWS1/CHSMESSAGEID
¶
The ID of the message.
IV_CHIMEBEARER
TYPE /AWS1/CHSCHIMEARN
/AWS1/CHSCHIMEARN
¶
The
AppInstanceUserArn
of the user making the API call.
Optional arguments:¶
IV_SUBCHANNELID
TYPE /AWS1/CHSSUBCHANNELID
/AWS1/CHSSUBCHANNELID
¶
The ID of the SubChannel in the request.
Only required when getting message status in a SubChannel that the user belongs to.