解散群聊 DestroyConversation--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

解散群聊 DestroyConversation

最近更新时间：2023.06.07 19:19:09首次发布时间：2023.04.24 11:11:46

你可以使用此接口解散群聊。

接口行为

你可以调用DestroyConversation接口，指定你所属的AppId、会话 ID 和群主 ID来解散指定群聊。

单聊无法调用此接口。
只有群主可以解散群聊。

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
OwnerUserId	Int	是	`10001`	群主 UserId
ConversationShortId	Int	是	`000001`	会话 ID

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "OwnerUserId": 10001,    
    "ConversationShortId":000001
}

返回调用结果

返回参数说明

正常返回示例

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