API 参考
在线调试

撤回/删除消息

更新时间: 2024/07/17 16:53:40

功能描述

该接口可以在会话中撤回或删除一条单聊/群聊消息。会话类型包括单聊、群聊、超大群会话。其中撤回消息包括单向撤回和双向撤回两种类型。

操作类型 描述
单向撤回 支持单向撤回单聊消息和高级群消息。
  • 撤回之后,消息接收者会收到一条单向撤回的通知,并删除对应的离线消息、漫游消息、历史消息。
  • 撤回之后,消息发送者无感知,可以正常使用漫游消息、历史消息。
  • 双向撤回 在一定时间内(默认 2 分钟),支持双向撤回单聊消息与群聊消息。撤回之后,消息接收者和发送者都将收到一条消息撤回通知,并删除对应的离线消息、漫游消息和历史消息。
  • 您可登录云信控制台,选择应用,然后进入IM 即时通讯 > 功能配置 > 基础功能 > 消息撤回时长配置 IM 消息的可撤回时长,最长可配置 604800 秒(7天)。
  • 超大群只能撤回 2 分钟以内的消息,且仅群主和管理员或者消息发送者可以撤回。
  • 删除消息 支持删除 30 天内的单聊消息和高级群消息。删除某一条消息时,会删除对应的离线消息、漫游消息和历史消息。删除消息时,客户端无感知。

    调用频率

    单个应用默认最高调用频率请参考 频控说明

    请求

    URL

    DELETE https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages/:{message_server_id}
    

    请求 Header 的参数说明请参见请求 Header

    路径参数

    参数名称 类型 是否必选 描述 示例
    conversation_id String 必选 会话 ID。会话 ID 需要用户自行拼装,拼装规则:
    owner_id|conversation_type|other_idowner_id|conversation_type|team_id
    • owner_id:操作者账号 ID
    • conversation_type:会话类型,1:单聊会话;2:高级群会话;3:超大群会话
    • other_id:对方账号 ID(单聊对话)
    • team_id:群组 ID(群组会话)
    单聊会话:Accid1|1|Accid2
    高级群会话:Accid1|2|tid
    超大群会话:Accid1|3|tid
    message_server_id Long 必选 要撤回或删除的服务端消息 ID。 -

    查询参数

    参数名称 类型 是否必选 描述
    type Integer 必选 操作类型。
  • 1:单向撤回消息,支持单聊消息和高级群消息。
  • 2:双向撤回消息,支持单聊消息、高级群消息以及超大群消息。
  • 3:删除消息,支持单聊消息和高级群消息。
  • description String 可选 消息撤回的相应描述,长度上限 128 位字符。默认为“撤回了一条信息”。
    push_content String 可选 双向撤回的推送文案,只有 type = 2 时该字段才有效。
  • Android 以该字段内容为推送显示文案。
  • iOS 优先使用 push_payload 字段内容为推送文案。若未填写 push_payload,推送文案以 push_content 为准。
  • 超过 500 位字符后,会对文本进行截断。
  • push_payload String 可选 推送对应的 payload,JSON 格式,只有 type = 2 时该字段才有效,长度上限 2048 位字符。更多说明请参见推送 payload 配置
    route_environment String 可选 消息双向撤回事件需要抄送到环境名称,对应您在云信控制台中配置的自定义抄送的环境名称。只有 type = 2 时该字段才有效,且该字段仅对单聊会话和高级群会话生效。长度上限 32 位字符。
    attach String 可选 双向消息撤回的通知字段,只有 type = 2 时该字段才有效且该字段仅对单聊会话和高级群会话生效。长度上限 5000 位字符。

    响应

    Header

    响应 Header 的参数说明请参见响应 Header

    响应体参数

    参数名称 类型 描述 是否必返回
    code Integer 状态码,200 表示请求成功。
    msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
    data Object 返回的 JSON 数据对象,请求失败则返回空对象。

    响应体示例

    json{
        "code": 200,
        "msg": "success",
        "data": {}
    }
    

    错误码

    错误码 错误码描述 错误信息示例
    200 请求成功 success
    414 参数错误 parameter error
    102404 用户不存在 account not exist
    107429 不允许撤回发给自己的消息 revoke message to self not allowed
    107328 不允许删除发给自己的消息 delete self message not allowed
    107301 不允许撤回第三方业务消息 revoke third party message not allowed
    107303 仅允许发送者或管理员撤回消息 only sender or manager can revoke message
    107404 消息不存在 message not exist
    108404 群不存在 team not exist
    108311 超大群服务未开通 super team service disabled
    109404 群成员不存在 team member not exist
    500 服务器内部错误 internal server error
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能描述
    • 调用频率
    • 请求
    • URL
    • Header
    • 路径参数
    • 查询参数
    • 响应
    • Header
    • 响应体参数
    • 响应体示例
    • 错误码