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

接口行为

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

调用接口

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

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`RecallMessage`	接口名称，本接口取值：`RecallMessage`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
ConversationShortId	Int	是	`000001`	会话 ID
MessageId	Int	是	`10003`	消息 ID
ParticipantUserId	Int	是	`10001`	撤回消息的会话成员 ID
RecallRole	Int	否	`0`	撤回消息的会话成员角色。 `0`：普通会话成员。 `1`：群主。 `2`：管理员。

请求示例代码

Query

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

Body

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

返回调用结果

返回结果参看 BaseResponse。

正常返回示例

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