即时通信 IM 单向删除单聊历史消息-服务端 API-文档中心-腾讯云

功能说明
App 管理员调用该接口单向删除一个单聊会话的多条消息。
只能以消息的发送方或接收方的身份去删除单聊会话的历史消息。
只能单向删除（以会话其中一方的身份去删除某条消息后，自己看不到这条消息，会话的对方仍然可以看到这条消息）
删除的消息的 MsgKey 可通过以下方式获取：
开通 发单聊消息之前回调 或 发单聊消息之后回调 ，通过该回调接口记录每条单聊消息的 MsgKey 。
通过 查询单聊消息 查询出待删除的单聊消息的 MsgKey 。
由 REST API 单发单聊消息 和 批量发单聊消息 接口发出的单聊消息，记录回包里的 MsgKey 字段 。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/openim/delete_c2c_msg_ramble?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
孟买：adminapiind.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/openim/delete_c2c_msg_ramble
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig﻿
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json
最高调用频率
200次/秒。
请求包示例
指定以 user0 的身份将会话 user1 中的两条单聊消息删除。
{
   "Operator_Account": "user0",
   "Peer_Account": "user1",
   "MsgKeyList": [
       "1472765512_1000001_1697790495",
       "1085536171_2000001_1697790694"
   ]
}
请求包字段说明
字段
类型
属性
说明
Operator_Account
String
必填
发起删除操作的账号，即以 Operator_Account 的身份删除消息。
Peer_Account
String
必填
会话的另一方账号。
MsgKeyList
Array
必填
待删除消息的 MsgKey 数组。
一次最多删除30条消息。
应答包体示例
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
应答包字段说明
字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码：
0：表示成功
非0：表示失败
ErrorInfo
String
错误信息

InvalidMsgKeyList
Array
请求中格式非法的 MsgKey
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
90001
JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90003
JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 账号不存在。
90008
JSON 格式请求包体中缺少 From_Account 字段或者 From_Account 账号不存在。
接口调试工具
通过 REST API 在线调试工具 调试本接口。
﻿

参数	说明
xxxxxx	SDKAppID 所在国家/地区对应的专属域名：中国：`console.tim.qq.com` 新加坡：`adminapisgp.im.qcloud.com` 首尔： `adminapikr.im.qcloud.com` 法兰克福：`adminapiger.im.qcloud.com` 孟买：`adminapiind.im.qcloud.com` 硅谷：`adminapiusa.im.qcloud.com` 雅加达：`adminapiidn.im.qcloud.com`
v4/openim/delete_c2c_msg_ramble	请求接口
sdkappid	创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier	必须为 App 管理员账号，更多详情请参见 App 管理员
usersig	App 管理员账号生成的签名，具体操作请参见生成 UserSig
random	请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype	请求格式固定值为`json`

字段	类型	属性	说明
Operator_Account	String	必填	发起删除操作的账号，即以 Operator_Account 的身份删除消息。
Peer_Account	String	必填	会话的另一方账号。
MsgKeyList	Array	必填	待删除消息的 MsgKey 数组。一次最多删除30条消息。

错误码	描述
90001	JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90003	JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 账号不存在。
90008	JSON 格式请求包体中缺少 From_Account 字段或者 From_Account 账号不存在。

单向删除单聊历史消息

本页目录：

功能说明

接口调用说明

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具