跳到主要内容

修改指定用户全局免打扰状态

简要描述

  • 修改指定用户全局免打扰状态。

请求方式

  • post

请求 URL

  • {API_ADDRESS}/user/set_global_msg_recv_opt
header 名示例值选填类型说明
operationID1646445464564必填stringoperationID 用于全局链路追踪
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例

{
"userID": "11111112",
"globalRecvMsgOpt": 0
}
字段名选填类型说明
userID必填string用户 ID
globalRecvMsgOpt必填int全局是否接收消息,0 为正常接收和推送,2 为接收正常,但无离线推送。

成功返回示例

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

成功返回示例的参数说明

参数名类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简要信息,无错误时为空
errDlterrDlt错误详细信息,无错误时为空
dataobject通用数据对象,具体结构见下方

失败返回示例

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

失败返回示例的参数说明

参数名类型说明
errCodeint错误码,具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息