Set Do Not Disturb for a Specific Conversation

Set the Do Not Disturb logic for a specific conversation (targetId) for a specific user (requestId). Supported conversation types include: one-to-one chat, group chat, ultra group, and system conversation. After setting, the SDK can retrieve the latest Do Not Disturb status of the conversation in real-time.

tip

• The current setting is at the user level.

Request Method

POST: https://data center domain/conversation/notification/set.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require signature verification. For details, refer to API Request Signature.

Body Parameters

The HTTP request body data format is application/x-www-form-urlencoded. The following HTTP form parameters are supported:

Parameter	Type	Required	Description
conversationType	String	Yes	Conversation type. Supported conversation types include: 1 (one-to-one chat), 3 (group chat), 6 (system conversation), 10 (ultra group chat).
requestId	String	Yes	The user ID for whom the Do Not Disturb setting is being configured.
targetId	String	Yes	The target ID, which could be a user ID, group ID, ultra group ID, etc., depending on the conversation type (ConversationType).
isMuted	Int	Yes	The Do Not Disturb setting status, where 0 means off and 1 means on. This field is deprecated. It is recommended to use unpushLevel. Only one of isMuted or unpushLevel needs to be passed. If both are passed, unpushLevel will be used.
busChannel	String	No	The channel ID of the ultra group conversation. If a channel ID is passed, the Do Not Disturb level will be set for that specific channel. Note: For customers who activated the ultra group service before 2022.09.01, if no channel ID is specified, an empty string "" will be passed by default, meaning the Do Not Disturb level will only be set for messages in the specified ultra group conversation (targetId) that do not belong to any channel. To modify this, please submit a ticket.
unpushLevel	Int	Yes	-1: Notify for all messages 0: Not set (if the user has not set this, the default setting at the group or app level will apply. If no default is set, all messages will be notified.) 1: Notify only for @ messages 2: Notify only for @ specific user For example: @ZhangSan will notify ZhangSan, but @all will not notify anyone. 4: Notify only for @ all group members, only receiving push notifications for @all. 5: Do not receive notifications

Request Example

POST /conversation/notification/set.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

conversationType=1&requestId=b5NwvIrW8&targetId=UAhIaLkR0&unpushLevel=0

Response

The HTTP response body contains a JSON object with the following structure:

Return Value	Type	Description
code	Number	Return code, 200 indicates success.

Response Example

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

{"code":200}