You need to enable JavaScript to run this app.
导航
修改用户对会话的设置 ModifyConversationSetting
最近更新时间:2023.06.07 19:19:09首次发布时间:2023.04.24 11:11:46

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

接口行为

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

调用接口

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

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionStringModifyConversationSetting接口名称,本接口取值:ModifyConversationSetting
VersionString2020-12-01接口版本,本接口取值:2020-12-01

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
ConversationSettingInfoConversationSettingInfo/

ConversationSettingInfo

参数名类型必填示例值描述
ConversationShortIdInt000001需要修改的会话 ID
ParticipantUserIdInt10001需要修改的会话成员UserId
IsMuteBoolfalse是否开启免打扰。
  • true:开启。
  • false:不开启
默认值为 false
IsStickTopBoolfalse是否需要修改置顶时间
StickTopTimeInt0置顶时间戳,单位为毫秒
IsSetFavoriteBoolfalse是否需要修改收藏时间
SetFavoriteTimeInt0收藏时间戳,单位为毫秒
Extmap-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": {
    }
}