Do Not Disturb Feature Overview
The IM service supports multi-dimensional, multi-level fine-grained Do Not Disturb settings.
Dimensions of Do Not Disturb Settings in IM
The IM service allows for multi-dimensional control over the Do Not Disturb feature. Developers can configure Do Not Disturb settings at the App Key level and user level.
tip
- The Android/iOS client SDKs have provided full support for the following dimensions of Do Not Disturb settings since version 5.2.2.
- The Web client SDK has provided full support for the following dimensions of Do Not Disturb settings since version 5.3.0.
| Dimension of Do Not Disturb Configuration | Applicable Scenarios | Description | Server API |
|---|---|---|---|
| App Key Level Settings | One-to-one chat, group chat, system conversation | Set the default Do Not Disturb level for the entire application by App Key. By default, no settings are applied, which means all messages will trigger notifications. This level of configuration is not yet available in the Console. If needed, please submit a ticket. | Not provided by the server. |
| Conversation Type Settings (User Level) | One-to-one chat, group chat, and system conversation | Allow users to set the Do Not Disturb level for specified conversation types. | See Set Do Not Disturb by Conversation Type. |
| Conversation Settings (User Level) | One-to-one chat, group chat, and system conversation | Allow users to set the Do Not Disturb level for specified conversations. | See Set Do Not Disturb by Conversation ID. |
| Application Global Settings (User Level) | One-to-one chat, group chat, and system conversation | Allow users to set the global Do Not Disturb level for a specified time period. | Not provided by the server. |
Priority of Do Not Disturb Settings
-
For one-to-one chat, group chat, and system conversations, the IM server will search for Do Not Disturb configurations in the following order. Priority decreases from left to right, and the highest priority configuration is used to determine whether to trigger a push notification:
Global Do Not Disturb Settings (User Level) > Specific Conversation Do Not Disturb Settings (User Level) > Specific Conversation Type Do Not Disturb Settings (User Level) > App-Level Do Not Disturb Settings