删除用户所有消息 | OpenIM Docs

跳到主要内容

删除用户所有消息

简要描述

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

请求方式

post

请求URL

{API_ADDRESS}/msg/user_clear_all_msg

header名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	用于全局链路追踪，建议使用时间戳，在每个请求中独立
token	eyJhbxxxx3Xs	必填	string	管理员 token

请求参数示例

{
  "userID": "3034068043",
  "deleteSyncOpt": {
      "isSyncSelf": true,
      "isSyncOther": true
  }
}

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

成功返回示例

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

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，0表示成功
errMsg	string	错误简要信息，为空
errDlt	errDlt	错误详细信息，为空
data	object	通用数据对象，具体结构见下方

失败返回示例

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

失败返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，具体查看全局错误码文档
errMsg	string	错误简要信息
errDlt	errDlt	错误详细信息

删除用户所有消息