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

Endpoint URL¶

The xxxx.backendless.app is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.

https://xxxx.backendless.app/api/messaging/registrations/<device-id>

where:

Argument	Description
`<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.

Example¶

Important

Make sure to replace xxxx in the domain name in the sample request below to the one assigned to your application.

curl -X GET \  
-v https://xxxx.backendless.app/api/messaging/registration/YYYYYYYYYYY

Codeless Reference¶

push_get_device_registration_1

Returns a list with one object containing device registration details. The object contains the following properties:

where:

Argument	Description
`deviceToken`	A token assigned by the push notification service provider (Google Cloud Messaging, Apple Push Notification Service, Microsoft Push Notification Service).
`deviceId`	A unique identification of the device registered to receive push notifications.
`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.

The example below retrieves the device registration details:

push_get_device_registration_2