Skip to content

Subscribe for All Messages

This API subscribes to a channel to receive all channel messages. Message retrieval requires a separate API call documented in the Retrieve Messages section of this guide.

Method

POST

URL

https://api.backendless.com/<application-id>/<REST-api-key>/messaging/<channel-name>/subscribe

where:

Argument                Description
<application-id> the ID of your application generated upon its creation. You can get the value in the Manage > App Settings section of the Backendless Console.
<REST-api-key> REST API key of your application. You can get the value from the Manage > App Settings section of the Backendless Console.
<channel-name> name of the channel to subscribe to.

Request Headers

Content-Type: application/json  
user-token: optional value obtained as a result of the login operation.

where:

Argument                Description
Content-Type Must be set to application/json. This header is mandatory.
user-token Optional header. Contains a value returned by Backendless in a preceding user Login API call. If user-token is set in the request, the operation will be executed with the security policy associated with the currently logged in user. This means all permissions associated with the user and the roles assigned to the user will be enforced by Backendless.

Request Body:

Optional parameter is shown in [square brackets]:

{  
  ["subscriberId" : value]  
}

Response Body

{  
  "subscriptionId" : value  
}

Returned subscriptionId must be used in the API call to retrieve messages for the subscription.

Errors

When the server-side reports an error, it returns a JSON object in the following format:

{  
  "message":error-message,  
  "code":error-code  
}