You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

删除用户消息 DeleteMessage

最近更新时间：2024.04.08 19:49:51

首次发布时间：2023.04.24 11:11:46

我的收藏

你可以使用此接口删除用户消息。

使用说明

接口行为

你可以调用DeleteMessage接口，指定你所属的AppId和，会话 ID、会话成员 ID 和消息 ID，删除指定的用户消息。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

QPS 不得超过 50。

请求说明

  • 请求方式：POST
  • 请求地址：https://rtc.volcengineapi.com?Action=DeleteMessage&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是DeleteMessage接口名称。当前 API 的名称为 DeleteMessage。
VersionString是2020-12-01接口版本。当前 API 的版本为 2020-12-01。

Body

参数类型是否必选示例值描述
AppIdInteger是000000应用的唯一标志
ConversationShortIdLong是000001会话 ID
ParticipantUserIdLong是10001群成员 ID
MessageIdLong是10003消息 ID

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://rtc.volcengineapi.com?Action=DeleteMessage&Version=2020-12-01
{
    "AppId": 000000,
    "ConversationShortId": 000001,
    "ParticipantUserId": 10001,
    "MessageId": 10003,
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "DeleteMessage",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

您可访问公共错误码，获取更多错误码信息。