Skip to content

Retrieve Device Registration

Backendless server returns information about device registration with the API documented below. The input parameter of the API is deviceId - the value returned by the device registration API.

Method

GET

URL

https://api.backendless.com/<application-id>/<REST-api-key>/messaging/registrations/<device-id>

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.
<device-id> ID of the device to retrieve the device registration information for. Must be the same ID used in the Device Registration call.

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:

None

Response Body

{  
  "deviceToken" : value,  
"deviceId" : value,  
"os" : "IOS" | "ANDROID" | "WP",  
"osVersion": value  
  [,"channels": [channelName1, channelName2]],  
  [,"expiration": timestamp in GMT0]  
}

where:

Argument                Description
deviceToken a token assigned by the push notification service provider (Google Cloud Messaging, Apple Push Notifications, Microsoft Push Notification Service).
deviceId a unique identification of the device where push notifications will be delivered to.
os operating system identifier
osVersion version of the operating system
channels an array of Backendless messaging channels device is registered with.
expiration a timestamp indicating when the device registration should expire.

Errors:

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

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

The following errors may occur during the device registration API call

Error Code
Description
5000
Unable to retrieve device registration - unknown device ID.

Examples

curl -X GET \  
-v https://api.backendless.com/XXXX-XXXX-XXXX/ZZZZZ-ZZZZZ-ZZZZ/messaging/registration/YYYYYYYYYYY