Get push notification preferences
You can retrieves a user's notifications preferences. A push notification is a message that is immediately delivered to a user's device when the device is either idle or running the client app in the background.
Note: Push notifications are only available for group channels.
The following table lists the parameters that this action supports.
Specifies the unique ID of a user.
If successful, this action returns the notifications preferences of a user in the response body.
List of response properties
The type of notifications trigger applies to group channels when the user is disconnected from Sendbird server. Valid values are the following:
Indicates whether to repeatedly pause notifications for a set period of time on a daily basis. (Default:
The start hour for pausing notifications when
The start minute for pausing notifications when
The end hour for pausing notifications when
The end minute for pausing notifications when
Indicates whether to snooze notifications for a set period of time. (Default:
The timestamp when snoozing notifications starts, in Unix milliseconds.
The timestamp when snoozing notifications ends, in Unix milliseconds.
The timezone applied when setting preferences for notifications. Valid values include
The name of the sound file played when a notification is delivered to a client app.
In the case of an error, an error object like below is returned. See the error codes section for more details.