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

接口行为

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

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
ConversationCoreInfo	ConversationCoreInfo	是	/	会话信息

ConversationCoreInfo

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

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ConversationCoreInfo":{
        "ConversationShortId":000001,
            "Ext": {
                "key": "value"
            },
        "OwnerUserId":100001,
        "CreatorUserId":100001,                        
    }
}
json

返回调用结果

返回参数说明

正常返回示例

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