Device Object

The Device object represents a single end-user device that can receive push notifications from an associated application. Each device is identified by a unique device_sid and linked to its corresponding application through application_sid.

The object records essential details such as:

• Device operating system type (android, ios, or web),
• OS version and application version, and
• Device-specific push token issued by Apple or Google.

Additionally, the environment field distinguishes between development and production modes for APNs.

By maintaining this mapping between applications and devices, the CarrierX platform ensures accurate delivery of notifications to active user endpoints.

Device Object Attributes

This is the JSON response that gets returned when a request is successful.

Attribute	Data Type	Description
application_sid create	string	The secure ID of the application installed on the device.
application_version createupdate	string	The internal version of the application.
device_sid read only	string	The device secure ID.
environment createupdate	string	The environment to be used to send push notifications, applicable to Apple Push Notification. Values accepted in this field are development and production.
os_version createupdate	string	The device operating system version number.
partner read only	object	The Partner object associated with the device. This field is displayed if with_related is set to true when performing the GET queries.
partner_sid read only	string	The secure ID of the partner associated with the device.
token createupdate	string	The Push Notification identifying token from Google or Apple.
type createupdate	string	The type of the device operating system. Values accepted in this field are android, ios and web.

Sample Device Object

{
    "application_sid": "b3edc875-f73c-4c48-895a-8697b92b8d07",
    "application_version": "",
    "device_sid": "56d485ae-0693-421a-91eb-6b02b152573a",
    "environment": "production",
    "os_version": "",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "token": "1111",
    "type": "ios"
}