即时通信

撤回/删除聊天室历史消息

开发中

DELETE

/im/v2/chatrooms/{room_id}/messages/{message_client_id}

请求参数

Path 参数

room_id

string

聊天室 ID

必需

示例值:

1605537145

message_client_id

string

消息客户端 ID。

必需

示例值:

456456456654

Query 参数

operator_id

string

操作者账号 ID

必需

示例值:

yx6

sender_id

string

必需

发送聊天室消息的账号 ID。

示例值:

yx5

create_time

string

消息发送时间戳。

必需

示例值:

1708601500604

notification_enabled

string

必需

该操作是否需要发送通知。true：下发通知，对应撤回聊天室消息；false：不下发通知，对应删除聊天室消息。

示例值:

true

notification_extension

string

可选

消通知扩展字段，JSON 格式，长度上限 1024 位字符，仅对消息撤回生效，即只有 notification_enabled =true 时，该字段才有效。例如："{"k":"v"}"。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request DELETE 'https://open.yunxinapi.com/im/v2/chatrooms/1605537145/messages/456456456654?operator_id=yx6&sender_id=yx5&create_time=1708601500604&notification_enabled=true' \
--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": 200,
  "msg": "success",
  "data": {}
}

修改于 2024-02-29 03:03:07

批量发送聊天室消息

分页查询聊天室历史消息