撤回/删除消息 - 即时通信

请求参数

Path 参数

conversation_id

string

必需

会话 ID。会话 ID 需要用户自行拼装，拼装规则：
sender_id|conversation_type|receiver_id
sender_id：会话消息发送者的账号 ID，String 类型
conversation_type：会话类型，1：单聊会话；2：高级群会话；3：超大群会话
receiver_id：接收会话消息的账号 ID 或群组 ID
单聊会话时为消息接收者的账号 ID；高级群会话时为接收消息的高级群 ID；超大群会话时为超大群 ID。

示例值:

apifoxtest1|1|apifoxtest2

message_server_id

integer

必需

要撤回或删除的服务端消息 ID。

示例值:

122334

Query 参数

type

integer

必需

操作类型。
1：单向撤回消息，支持单聊消息和高级群消息。
2：双向撤回消息，支持单聊消息、高级群消息以及超大群消息。
3：删除消息，支持单聊消息和高级群消息。

示例值:

1

description

string

可选

消息撤回的相应描述，长度上限 128 位字符。默认为“撤回了一条信息”。

push_content

string

可选

双向撤回的推送文案，只有 type = 2 时该字段才有效。
Android 以该字段内容为推送显示文案。
iOS 优先使用 push_payload 字段内容为推送文案。若未填写 push_payload，推送文案以 push_content 为准。
超过 500 位字符后，会对文本进行截断。

push_payload

string

可选

群主（创建者）云信账号 ID。

route_environment

string

可选

推送对应的 payload，JSON 格式，只有 type = 2 时该字段才有效，长度上限 2048 位字符。更多说明请参见推送 payload 配置。

attach

string

可选

双向消息撤回的通知字段，只有 type = 2 时该字段才有效且该字段仅对单聊会话和高级群会话生效。长度上限 5000 位字符。

check_team_member_valid

boolean

可选

是否需要验证群成员身份，true：需要；false：不需要，默认为 true

默认值:

true

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request DELETE 'https://open.yunxinapi.com/im/v2/conversations/apifoxtest1|1|apifoxtest2/messages/122334?type=1&check_team_member_valid' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

示例

{
  "code": 0,
  "msg": "string",
  "data": {}
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误