Query User Do Not Disturb Period
Query the Do Not Disturb period settings for a specific user.
Method Description
POST: https://data center domain/user/blockPushPeriod/get.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests must be signed according to the rules. For details, see API Request Signature.
Body Parameters
The HTTP request body is in application/x-www-form-urlencoded format and supports the following HTTP form parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | User ID |
Request Example
POST /user/blockPushPeriod/get.json HTTP/1.1
Host: api.rong-api.com
App-Key: awd1c0sxdlx1
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7bc7307889a8e711219a47b7cf6a5b000e9
Content-Type: application/x-www-form-urlencoded
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX (max length 36)
userId=userId
Response
The HTTP response body contains a JSON object with the following structure:
| Return Value | Type | Description |
|---|---|---|
| code | Number | Return code, 200 indicates success |
| data | Object | Return value. |
| data.startTime | String | Start time, accurate to the second. Format: HH:MM:SS, example: 22:00:00. Note: startTime is related to the data center of the app. If your app uses the China (Beijing) Data Center, the time is in Beijing time. If your app uses the global data center, the time is in UTC. |
| data.period | Number | Do Not Disturb time window size, in minutes. Range: [0-1439]. 0 means not set. |
| data.unPushLevel | Number | Do Not Disturb level. 1: Only @ messages are notified, regular messages are not notified. 0: All messages are notified. 5: No messages are notified. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"code":200,"data":{"startTime":"23:59:59" ,"period":120, "unPushLevel":1 }}