set_global_msg_recv_opt
Description
- Update the global Do Not Disturb (DND) status for a specified user.
Request Method
POST
Request URL
{API_ADDRESS}/user/set_global_msg_recv_opt
Header
Header Name | Example Value | Required | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | Used for global traceability, suggested as a unique timestamp per request |
token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameters Example
{
"userID": "11111112",
"globalRecvMsgOpt": 0
}
Field Name | Required | Type | Description |
---|---|---|---|
userID | Required | string | User ID |
globalRecvMsgOpt | Required | int | Global message reception setting: 0 for normal reception and push; 2 for reception without offline push |
Success Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
Success Response Parameter Description
Parameter | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty if successful |
errDlt | string | Detailed error information, empty if successful |
Failure Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failure Response Parameter Description
Parameter | Type | Description |
---|---|---|
errCode | int | Error code; refer to global error code documentation |
errMsg | string | Brief error message |
errDlt | string | Detailed error information |