tencent cloud

接口调用说明

• 管理员修改单聊历史消息。
• 可以单独修改消息中的 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 简介。

最高调用频率

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"
}

请求包字段说明

应答包体示例

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

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

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

参考

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