set_global_msg_recv_opt
Brief Description
- Modify the global do not disturb status for a specified user.
Request Method
post
Request URL
{API_ADDRESS}/user/set_global_msg_recv_opt
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | operationID for global link tracking |
token | eyJhbxxxx3Xs | Required | string | Administrator token |
Request Parameter Example
{
"userID": "11111112",
"globalRecvMsgOpt": 0
}
Field Name | Optional | Type | Description |
---|---|---|---|
userID | Required | string | User ID |
globalRecvMsgOpt | Required | int | Global message reception setting, 0 for normal reception and push, 2 for normal reception but no offline push. |
Successful Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
Explanation for Successful Response Parameters
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 means success |
errMsg | string | Brief error message, empty if no error |
errDlt | errDlt | Detailed error information, empty if no error |
data | object | General data object, specific structure below |
Failed Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": "userID not found[1004]RecordNotFoundError"
}
Explanation for Failed Response Parameters
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, refer to the global error code document |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error information |