Get Message Status

Top  Previous  Next

Backendless server handles message publishing as an autonomous task. As a result, the status of the message publishing operation is not available right away. To retrieve publishing status, the client application must make a separate API call documented below:

Method:

GET

 

URL:

https://api.backendless.com/<version-name>/messaging/<message-id>

where:

<version-name>- name of the application's version. Application versions can be managed using Backendless Console. Login to the console, select an application, click Manage, then Versioning. Backendless automatically creates version "v1" for any new application.
<message-id>- ID of the message assigned to the message and returned by the Message Publishing API request.

 

Request Headers:

application-id: app-id-value
secret-key: secret-key-value
application-type: REST

where:

application-id- the ID of your application generated upon its creation. You can find this header in the Manage > App Settings section of the Backendless Console. This header is mandatory. Please refer to the Setup section for information on how to obtain the values for the header.
secret-key - the key of your application generated upon its creation. You can find this header in the Manage > App Settings section of the Backendless Console. This header is mandatory. Please refer to the Setup section for information on how to obtain the values for the header.
Content-Type- the static value, should be set to application/json. This header is mandatory.
application-type- the static value, should be set to REST. This header is mandatory. see the Setup section for information on how to obtain the values for the headers

Request Body:

None

 

Response Body:

{
 "status" : "failed" | "published" | "scheduled" | "cancelled" | "unknown",
 "messageId" : value,
 "errorMessage" : value
}

If the status property is "failed", the errorMessage property should contain the details of the failure.

 


Please let us know how we can improve the documentation by leaving a comment. All technical questions should be posted to the Backendless Support forum. We do not respond to the technical questions on the documentation pages.: