Skip to main content

Modify Specified User's Global Do-Not-Disturb Status

Brief Description

  • Modify specified user's global do-not-disturb status.

Request Method

  • post

Request URL

  • {API_ADDRESS}/user/set_global_msg_recv_opt
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"userID": "11111112",
"globalRecvMsgOpt": 0
}
Field NameOptionalTypeDescription
userIDRequiredstringUser ID
globalRecvMsgOptRequiredintGlobal receive message opt, 0 indicates normal receipt and push, 2 indicates normal receipt without offline push.

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty

Failure Return Example

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

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message