Push Devices
Confused about "Push Devices"?
Let us know how we can improve our documentation:
LAST EDIT May 19 2022
Once your app has push enabled, you can use the APIs to register user devices such as iPhones and Android phones.
Each chat user has a limit of 25 unique devices. Once this limit is reached, the oldest device will be removed and replaced by the new device.
Device Parameters
Copied!Confused about "Device Parameters"?
Let us know how we can improve our documentation:
name | type | description | default | optional |
---|---|---|---|---|
user_id | string | The user ID for this device | - | |
id | string | The device ID. | - | |
push_provider | string | The push provider for this device. Either apn, firebase, huawei or xiaomi. | - | |
disabled | boolean | Set if device is disabled | - | ✓ |
disabled_reason | string | Explanation if device is disabled | - | ✓ |
push_provider_name | string | The push provider name for this device if multi-bundle configuration is added. | - | ✓ |
Register a Device
Copied!Confused about "Register a Device"?
Let us know how we can improve our documentation:
Registering a device associates it with a user and tells the push provider to send new message notifications to the device.
Unregister a Device
Copied!Confused about "Unregister a Device"?
Let us know how we can improve our documentation:
Unregistering a device removes the device from the user and stops further new message notifications.
List Devices
Copied!Confused about "List Devices"?
Let us know how we can improve our documentation:
Provides a list of all devices associated with a user.