You need to enable JavaScript to run this app.
导航
判断用户是否在会话中 IsUserInConversation
最近更新时间:2023.06.07 19:19:08首次发布时间:2023.04.24 11:11:46

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

接口行为

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

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
ConversationShortIdInt000001会话 ID
ParticipantUserIdInt10001查询用户 UserId

请求示例代码

Query

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

Body

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

返回调用结果

返回参数说明

返回结果参看 BaseResponse

其中 Result 的结构如下:

参数名类型描述
IsUserInConversationBool用户是否在会话中。
  • true:是。
  • false:否。

正常返回示例

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