修改用户对会话的设置 ModifyConversationSetting--实时音视频-火山引擎

文档中心

立即注册

实时音视频

请输入

会话管理

修改用户对会话的设置 ModifyConversationSetting

你可以使用此接口查询会话成员对会话的设置

接口行为

你可以调用ModifyConversationSetting接口，指定你所属的AppId、会话 ID 和会话成员 UserId 修改该成员对会话的设置。

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

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

ConversationSettingInfo

参数名	类型	必填	示例值	描述
ConversationShortId	Int	是	`000001`	需要修改的会话 ID
ParticipantUserId	Int	是	`10001`	需要修改的会话成员UserId
IsMute	Bool	否	`false`	是否开启免打扰。 `true`：开启。 `false`：不开启默认值为 `false`。
IsStickTop	Bool	否	`false`	是否需要修改置顶时间
StickTopTime	Int	否	`0`	置顶时间戳，单位为毫秒
IsSetFavorite	Bool	否	`false`	是否需要修改收藏时间
SetFavoriteTime	Int	否	`0`	收藏时间戳，单位为毫秒
Ext	map-key(string)-value(string)	否	{"key":"value"}	扩展字段

请求示例代码

Query

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

Body

{
  "AppId": 000000,
  "ConversationSettingInfo": {
    "ConversationShortId": 000001,
    "ParticipantUserId": 10001,
    "IsMute":true, 
    "IsStickTop":true,     
    "StickTopTime":0
  }
}

返回调用结果

返回结果参看 BaseResponse。

正常返回示例

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

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

这个页面对您有帮助吗？

有用

无用