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

接口行为

你可以调用GetConversationSetting接口，指定你所属的AppId、会话 ID和会话成员 UserId，查询会话成员对会话的设置。

调用接口

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

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
ParticipantUserId	Int	是	`10001`	会话成员 UserId，UserId 必须大于 `0`。
ConversationShortId	Int	是	`000001`	会话 ID
NoReadIndex	Bool	否	`false`	是否需要该成员在会话中的已读位置。 `true`：不需要。 `false`：需要。

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ParticipantUserId":10001,
    "ConversationShortId":000001,    
    "ReadIndex":false
}
json

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	描述
ConversationSettingInfo	ConversationSettingInfo	用户会话设置

正常返回示例

{
    "ResponseMetadata": {
	      "RequestId": "Your_RequestId",    
        "Action": "BatchModifyConversationParticipant",
        "Version": "2020-12-01",
        "Service": "rtc",        
        "Region": "cn-north-1"
    },
    "Result": {
        "ConversationSettingInfo": {
            "AppId": 000000,
            "ParticipantUserId": 10001,
            "ConversationShortId": 000001,
            "ConversationType": 1,
            "InboxType": 0,
            "StickTopTime": 0,
            "IsStickTop": false,
            "SetFavoriteTime": 0,
            "IsSetFavorite": false,
            "IsMute": false,
            "Ext": {
                    "key": "value",
                    "s:from": "biz"
                },
            "MinIndex": 0
        }
    }
}
json