Get Message Status¶
Backendless server handles message publishing as an autonomous task. As a result, the final status of the message publishing operation is not available right away. To retrieve the status, the client application must make a separate API call as documented below:
Backendless.Messaging.getMessageStatus( messageId )
.then( function( status ) {
})
.catch( function( error ) {
});
where:
Argument | Description |
---|---|
messageId |
ID of the message assigned to the message and returned by the Message Publishing API request. |
Return Value¶
Method returns a JS object with the following structure:
{
messageId:<messageId>,
status:<status>,
errorMessage:<errorMessage>
}
where:
Argument | Description |
---|---|
<messageId> |
ID of the message for which the publishing status is retrieved. |
<status> |
can be one of the following "published" , "scheduled" , "cancelled" , "failed" or "unknown" . |
<errorMessage> |
contains a detailed error message when the status property is "failed" . |
Codeless Reference¶
where:
Argument | Description |
---|---|
message id |
ID of the message for which the publishing status is retrieved. |
Returns an object containing message status details. The object contains the following properties:
where:
Argument | Description |
---|---|
messageId |
ID of the message for which the publishing status is retrieved. |
status |
can be one of the following values: FAILED , PUBLISHED , SCHEDULED , CANCELLED , UNKNOWN |
errorMessage |
contains a detailed error message when status is "failed" . |
The example below checks the message status with the following identifier: "message:6052643A-F96C-4253-BCF0-F606A4BBB794"
.