Skip to main content

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 NameExample ValueRequiredTypeDescription
operationID1646445464564RequiredstringUsed for global traceability, suggested as a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"userID": "11111112",
"globalRecvMsgOpt": 0
}
Field NameRequiredTypeDescription
userIDRequiredstringUser ID
globalRecvMsgOptRequiredintGlobal 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

ParameterTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if successful
errDltstringDetailed error information, empty if successful

Failure Response Example

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Failure Response Parameter Description

ParameterTypeDescription
errCodeintError code; refer to global error code documentation
errMsgstringBrief error message
errDltstringDetailed error information