Skip to content
Notification Settings

Get Message Notification Settings

Returns the push settings of each message group for the current Client: the available push channels with their on/off state, and the personalized push settings. Call it when the notification settings page or the settings page of one group loads.

section places message groups into sections of the settings page and maps to list[].group_id through group_ids. When the device has system notifications turned off, app notification channels such as app cannot deliver, so you can hide them or show them as off.

To change the settings, call POST /v6/message/user_config/update.

GEThttps://api.lbkrs.com/v6/message/user_config

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Message Notification Settings” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Push settings of each message group

Child attributes
group_idinteger

Message group ID

group_namestring

Message group name

available_channelarray<object>

Push channels available to the group and whether each one is on

Child attributes
codestring

Push channel code, such as app (app notification) or email. Use this value when you submit an update

textstring

Display name of the push channel

enabledboolean

Whether the channel is currently turned on

personal_configsarray<object>

Personalized push settings of the group. Empty when the group has none

Child attributes
codestring

Setting code. Send it back unchanged when you submit an update

titlestring

Setting title

channelarray<object>

Available options

Child attributes
valueinteger

Option value. Put it in values when the option is selected

textstring

Option label

descstring

Option description

channel_descstring

Description shown under the option list

moreboolean

Whether multiple options can be selected

switcherboolean

When true, show the setting as an on/off switch. The first element of values is 1 for on and 0 for off

valuesarray<integer>

Currently selected option values

sectionarray<object>

Sections of the settings page

Child attributes
titlestring

Section title

group_idsarray<string>

IDs of the message groups in this section, as strings. They match list[].group_id

Whale Docs