Set User Do Not Disturb Period
Set the user's Do Not Disturb period and level.
- This API sets a Do Not Disturb time window. The set Do Not Disturb time window will repeat daily until it is reset or deleted. For example, if an app user wants to set permanent all-day Do Not Disturb, they can set
startTimeto00:00:00andperiodto1439. - A single user can only set one time period. Repeated settings will overwrite the previously set time window.
Method Description
POST: https://data center domain/user/blockPushPeriod/set.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests must be validated according to the rules. For details, see API Request Signature.
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and it supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | User ID |
| startTime | String | Yes | Start time, accurate to seconds. The format is HH:MM:SS, example: 22:00:00. Note: startTime is related to the data center where the app is located. If your app uses the China (Beijing) Data Center, use Beijing time. If your app uses the global data center, use UTC time. |
| period | Number | Yes | The duration of the Do Not Disturb time window in minutes. Supported range is [0-1439]. 0 means not set. |
| level | Number | Yes | Do Not Disturb level. 1: Only @mentions are notified, regular messages are not notified. 5: All messages are not notified. |
Request Example
POST /user/blockPushPeriod/set.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0soslx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7as7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX(max length 36)
userId=userId&startTime=23:59:59&period=120&level=1
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}