批量查询会话成员详细信息 BatchGetConversationParticipant--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

批量查询会话成员详细信息 BatchGetConversationParticipant

最近更新时间：2023.06.07 19:19:08首次发布时间：2023.04.24 11:11:46

你可以使用此接口批量查询会话成员的详细信息。

接口行为

你可以调用BatchGetConversationParticipant接口，指定你所属的AppId、会话 ID 和查询会话成员 UserId 进行批量查询会话成员的详细信息。

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
ConversationShortId	Int	是	`000001`	会话 ID
ParticipantUserIds	Array of Int	是	`[10001,10002]`	需要查询会话成员的 UserId

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ConversationShortId":000001,
    "ParticipantUserIds":[000002,000003]
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	描述
Participants	Array of Participant	成功时返回查询会话成员信息，失败时为空。

正常返回示例

{
    "ResponseMetadata": {
	      "RequestId": "Your_RequestId",    
        "Action": "BatchModifyConversationParticipant",
        "Version": "2020-12-01",
        "Service": "rtc",        
        "Region": "cn-north-1"
    },
    "Result": {
        "Participants": [
            {
                "ConversationShortId": 000001,
                "ParticipantUserId": 10001,
                "Level": 1,
                "NickName": "NickName1",
                "Operator": 000010,
                "Status": 0,
                "CreateTime": 1669694619,
                "Ext": {
                    "key": "value",
                    "s:from": "biz"
                },
                "Role": 1,
                "BlockTime": 0
            },
            {
                "ConversationShortId": 000001,
                "ParticipantUserId": 10002,
                "Level": 20,
                "NickName": "NickName2",
                "Operator": 000010,
                "Status": 0,
                "CreateTime": 1669694619,
                "Ext": {
                    "key": "value",
                    "s:from": "biz"
                },
                "Role": 0,
                "BlockTime": 0
            }
        ]
    }
}