Set DND for a channel

Set the Do Not Disturb (DND) notification level for a specific channel for a given user. Supports direct, group, community, and system channels. The SDK receives the updated DND status in real time.

Request

POST: https://Base URL/v4/channel/push/set

Rate limit: 100 requests per second

Authentication: All server API requests require signature verification. See API request signing.

Request body

Content type: application/json

Parameter	Type	Required	Description
channelType	String	Yes	Channel type. 1: direct. 3: group. 6: system. 10: community.
requestId	String	Yes	User ID to configure DND for.
channelId	String	Yes	Target channel ID (user ID, group ID, or community ID depending on channelType).
isMuted	Number	Yes	DND status. 0: off. 1: on. Deprecated — use notificationLevel instead. If both are provided, notificationLevel takes precedence.
subchannelId	String	No	Community subchannel ID. If provided, DND is set for the specified subchannel.
noDisturbLevel	Number	Yes	DND notification level. -1: notify for all messages. 0: not set; follows the default group- or app-level setting. If no default is set, all messages trigger notifications. 1: notify only for @mentions. 2: notify only for @mentions of the specified user, for example @Alice. @all does not trigger this level. 4: notify only for @all mentions. 5: receive no notifications.

Request example

HTTP

POST /v4/channel/push/set HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
   "channelType": 1,
   "requestId": "b5NwvIrW8",
   "channelId": "UAhIaLkR0",
   "noDisturbLevel": 0
}

Response

Field	Type	Description
code	Number	Status code. 0 indicates success.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
   "code": 0
}