• UIKit
  • SDK
  • 服务端 API
Chat/
服务端 API/
RESTful 接口/
消息相关/
历史消息/
服务端 API
  • 生成 UserSig
  • RESTful 接口
    • RESTful 接口概述
    • RESTful 接口列表
    • 消息相关
      • 发送消息
        • 向单个用户发送单聊消息
        • 向多个用户发送单聊消息
        • 群内发送普通消息
        • 群内发送系统消息
        • 直播群广播消息
        • 导入单聊消息
        • 导入群消息
      • 历史消息
        • 修改单聊历史消息
        • 修改群聊历史消息
        • 拉取单聊历史消息
        • 拉取群聊历史消息
      • 删除消息
        • 删除指定用户发送的消息
      • 撤回消息
        • 撤回单聊消息
        • 撤回群消息
      • 已读回执
        • 设置单聊消息已读
        • 拉取群消息已读回执详情
        • 拉取群消息已读回执
      • 消息扩展
        • 拉取单聊消息扩展
        • 设置单聊消息扩展
        • 拉取群消息扩展
        • 设置群消息扩展
      • 推送给所有用户
        • 全员推送接口
        • 推送给所有用户
        • 设置应用属性名称
        • 获取应用属性名称
        • 获取用户属性
        • 设置用户属性
        • 删除用户属性
        • 获取用户标签
        • 添加用户标签
        • 删除用户标签
        • 删除用户所有标签
    • 会话相关
      • 会话列表
        • 拉取会话列表
      • 未读会话数
        • 设置成员的未读消息数
        • 查询未读单聊消息数
      • 删除会话
        • 删除会话
      • 会话组标签
        • 创建会话组数据
        • 更新会话组数据
        • 删除会话组数据
        • 创建或更新会话标记数据
        • 查找会话组标记
        • 拉取会话组标记数据
    • 群相关
      • 群组管理
        • 获取应用内所有群组
        • 创建群组
        • 解散群组
        • 获取用户已加入的群
      • 群资料
        • 获取群资料
        • 修改群资料
        • 导入群资料
      • 群成员管理
        • 添加群成员
        • 删除群成员
        • 封禁群成员
        • 解禁群成员
        • 批量禁言和取消禁言
        • 获取被禁言群成员列表
        • 变更群主
        • 查询用户在群组中的身份
        • 导入群成员
      • 群成员信息
        • 获取群成员资料
        • 修改群成员资料
      • 群自定义属性
        • 获取群自定义属性
        • 修改群自定义属性
        • 清空群自定义属性
        • 重置群自定义属性
        • 删除群自定义属性
      • 直播群管理
        • 获取直播群在线人数
        • 获取直播群在线成员列表
        • 设置直播群成员标记
        • 获取封禁群成员列表
      • 社群管理
        • 创建话题
        • 删除话题
        • 获取话题资料
        • 修改话题资料
        • 导入话题资料
      • 群计数器
        • 获取群计数器
        • 更新群计数器
        • 删除群计数器
    • 用户管理
      • 账号管理
        • 导入单个账号
        • 导入多账号
        • 删除账号
        • 查询账号
      • 用户信息
        • 设置资料
        • 拉取资料
      • 用户状态
        • 账号登录状态失效
        • 查询账号在线状态
      • 好友管理
        • 添加好友
        • 导入好友
        • 更新好友
        • 删除好友
        • 删除所有好友
        • 验证好友
        • 拉取好友
        • 拉取指定好友
      • 好友列表
        • 添加列表
        • 删除列表
        • 拉取列表
      • 黑名单
        • 拉黑用户
        • 将用户移出黑名单
        • 拉取黑名单
        • 验证黑名单中的用户
    • 全员禁言管理
      • 设置全员禁言
      • 查询全员禁言
    • 运维管理
      • 拉取运维数据
      • 下载最新消息
      • 获取服务器 IP 地址
    • 智能机器人
      • 拉取智能机器人账号
      • 创建智能机器人账号
      • 删除智能机器人账号
  • 触发器
    • 回调概述
    • 回调命令列表
    • 运维管理回调
      • 接口超频告警回调
    • 在线状态回调
      • 状态变更回调
    • 关系链回调
      • 更新资料之后
      • 添加好友之前
      • 添加好友回应之前
      • 添加好友之后
      • 删除好友之后
      • 将用户加入黑名单后
      • 将用户移出黑名单后
    • 单聊消息回调
      • 发送单聊消息之前
      • 发送单聊消息之后
      • 设置单聊消息已读之后
      • 撤回单聊消息之后
    • 群回调
      • 创建群组之前
      • 创建群组之后
      • 申请入群之前
      • 拉人入群之前
      • 用户入群之后
      • 成员退群之后
      • 发送群消息之前
      • 发送群消息后
      • 群组满员之后
      • 群组解散之后
      • 群组资料变动之后
      • 撤回群消息之后回调
      • 直播群成员在线和离线状态回调
      • 发送群消息异常回调
      • 创建话题之前
      • 创建话题之后
      • 删除话题后
      • 话题信息变更回调
      • 群成员资料变更后回调
      • 群属性变更后回调
      • 已读回执后回调
      • 群主变更后回调
    • 回调相互认证配置指南
      • Apache 相互认证配置
      • Nginx 相互认证配置
    • 智能机器人回调
      • 智能机器人单聊消息自定义回调

修改单聊历史消息

接口调用说明

管理员修改单聊历史消息。
可以单独修改消息中的 MsgBody 或 CloudCustomData 字段,也可以同时修改这两个字段。以请求中指定的字段值覆盖历史消息对应的字段。
待修改的单聊消息的 MsgKey 可通过以下方式获取:
开启 发单聊消息之前回调发单聊消息之后回调,通过该回调接口记录每条单聊消息的 MsgKey 。
通过 查询单聊消息 查询出待修改的单聊消息的 MsgKey 。
通过 REST API 单发单聊消息批量发单聊消息 接口发出的单聊消息,回包里会返回消息的 MsgKey 。
注意
使用该接口修改消息后,被修改的消息不能恢复,请谨慎调用该接口。

请求 URL 示例

https://xxxxxx/v4/openim/modify_c2c_msg?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
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/openim/modify_c2c_msg
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

只修改消息的 MsgBody

{
"From_Account": "dramon1",
"To_Account": "dramon2",
"MsgKey": "1_2_3",
"MsgBody": [
{
"MsgType": "TIMTextElem",
"MsgContent": {
"Text": "hello"
}
}
]
}


只修改消息的 CloudCustomData

{
"From_Account": "dramon1",
"To_Account": "dramon2",
"MsgKey": "1_2_3",
"CloudCustomData": "your cloud custom data"
}


同时修改消息的 MsgBody 和 CloudCustomData

{
"From_Account": "dramon1",
"To_Account": "dramon2",
"MsgKey": "1_2_3",
"MsgBody": [
{
"MsgType": "TIMTextElem",
"MsgContent": {
"Text": "hello"
}
}
],
"CloudCustomData": "your cloud custom data"
}


请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
消息发送方 UserID
To_Account
String
必填
消息接收方 UserID
MsgKey
String
必填
待修改消息的唯一标识。获取消息 MsgKey 的方法请参见本接口的接口说明
MsgBody
Array
选填
消息内容,具体格式请参考 消息格式描述(注意,一条消息可包括多种消息元素,MsgBody 为 Array 类型)
CloudCustomData
String
选填
消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到)

应答包体示例

{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "succeed"
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
错误码,0表示成功,非0表示失败
ErrorInfo
String
错误信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
描述
20001
请求包非法
20002
UserSig 或 A2 失效
20003
消息发送方或接收方 UserID 无效或不存在,请检查 UserID 是否已导入即时通信 IM
20004
网络异常,请重试
20005
服务器内部错误,请重试
90001
JSON 格式解析失败,请检查请求包是否符合 JSON 规范
90002
JSON 格式请求包中 MsgBody 不符合消息格式描述,或者 MsgBody 不是 Array 类型,请参考 TIMMsgElement 对象 的定义
90003
JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 字段不是 String 类型
90007
JSON 格式请求包体中 MsgBody 类型不是 Array 类型,请将其修改为 Array 类型
90009
请求需要 App 管理员权限
90010
JSON 格式请求包不符合消息格式描述,请参考 TIMMsgElement 对象 的定义
90012
To_Account 没有注册或不存在,请确认 To_Account 是否导入即时通信 IM 或者是否拼写错误
91000
服务内部错误,请重试
90992
服务内部错误,请重试;如果所有请求都返回该错误码,且 App 配置了第三方回调,请检查 App 服务器是否正常向即时通信 IM 后台服务器返回回调结果

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

批量发单聊消息(v4/openim/batchsendmsg) 查询单聊消息(v4/openim/admin_getroammsg) 撤回单聊消息(v4/openim/admin_msgwithdraw