You need to enable JavaScript to run this app.
导航

撤回用户消息 RecallMessage

最近更新时间2023.06.07 19:19:09

首次发布时间2023.04.24 11:11:47

你可以使用此接口撤回用户的消息。

接口行为

你可以调用RecallMessage接口,指定你所属的AppId、会话 ID、消息 ID 和撤回消息的会话成员 ID,撤回指定消息。

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionStringRecallMessage接口名称,本接口取值:RecallMessage
VersionString2020-12-01接口版本,本接口取值:2020-12-01

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
ConversationShortIdInt000001会话 ID
MessageIdInt10003消息 ID
ParticipantUserIdInt10001撤回消息的会话成员 ID
RecallRoleInt0撤回消息的会话成员角色。
  • 0:普通会话成员。
  • 1:群主。
  • 2:管理员。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=RecallMessage&Version=2020-12-01

Body

{
    "AppId":000000,
    "ParticipantUserId":10001,
    "ConversationShortId":000001,
    "MessageId":10003,
    "RecallRole":0
}

返回调用结果

返回结果参看 BaseResponse

正常返回示例

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