修改会话信息 ModifyConversation--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

修改会话信息 ModifyConversation

最近更新时间：2024.01.29 15:25:31首次发布时间：2023.04.24 11:11:46

你可以使用此接口修改会话信息。

使用说明

接口行为

你可以调用ModifyConversation接口，指定你所属的AppId和会话信息修改会话的详细信息。

调用接口

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

注意事项

QPS 不得超过 50。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ModifyConversation`	接口名称。当前 API 的名称为 `ModifyConversation`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
ConversationCoreInfo	Object of ConversationCoreInfo	是	`-`	会话信息

ConversationCoreInfo

参数	类型	是否必选	示例值	描述
ConversationShortId	Long	是	`000001`	需要修改的会话 ID
Name	String	否	`Conversation`	会话名
AvatarUrl	String	否	`http://xxx.com`	会话头像 url
Description	String	否	`Your_Description`	会话描述
Notice	String	否	`Your_Notice`	会话公告
Ext	JSON Map	否	`{"key":"value"}`	会话的扩展字段。`key` 的数据类型为 `String`，`value` 的数据类型为 `String`。
OwnerUserId	Long	否	`100001`	会话拥有人 UserId

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=ModifyConversation&Version=2020-12-01
{
    "AppId": 000000,
    "ConversationCoreInfo": {
        "ConversationShortId": 000001,
        "Ext": {
            "key": "value"
        },
        "OwnerUserId": 100001
    }
}

返回示例

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

错误码

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