判断用户是否在会话中 IsUserInConversation--实时音视频-火山引擎

文档中心

立即注册

实时音视频

请输入

会话成员查询

判断用户是否在会话中 IsUserInConversation

你可以使用此接口判断用户是否在会话中。

接口行为

你可以调用IsUserInConversation接口，指定你所属的AppId、会话 ID 和会话成员 UserId，判断该用户是否在会话中。

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
ConversationShortId	Int	是	`000001`	会话 ID
ParticipantUserId	Int	是	`10001`	查询用户 UserId

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ConversationShortId":000001,
    "ParticipantUserId":10001  
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

参数名	类型	描述
IsUserInConversation	Bool	用户是否在会话中。 `true`：是。 `false`：否。

正常返回示例

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

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

这个页面对您有帮助吗？

有用

无用

实时音视频

接口行为 #

调用接口 #

接口限制 #

请求方式 #

请求参数 #

Query

Body

请求示例代码 #

Query

Body

返回调用结果 #

返回参数说明 #

正常返回示例 #

接口行为

调用接口

接口限制

请求方式

请求参数

请求示例代码

返回调用结果

返回参数说明

正常返回示例