跳到主要内容

删除用户所有消息

简要描述

  • 从服务端删除用户所有消息,不影响客户端已同步消息。

请求方式

  • post

请求URL

  • {API_ADDRESS}/msg/user_clear_all_msg
header名示例值选填类型说明
operationID1646445464564必填string用于全局链路追踪,建议使用时间戳,在每个请求中独立
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例

{
"userID": "3034068043",
"deleteSyncOpt": {
"isSyncSelf": true,
"isSyncOther": true
}
}
字段名选填类型说明
userID必填string用户ID
deleteSyncOpt必填object删除同步选项
deleteSyncOpt.isSyncSelf选填string是否同步自身消息
deleteSyncOpt.isSyncOther选填string是否同步对方消息

成功返回示例

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

成功返回示例的参数说明

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

失败返回示例

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

失败返回示例的参数说明

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