調(diào)用DescribeUserInfoInChannel查詢用戶在頻道中實(shí)時(shí)信息。

使用說明

本接口用于查詢用戶在頻道中實(shí)時(shí)信息。例如：您可以查詢用戶角色類型、入會(huì)時(shí)間等信息。

QPS限制

本接口的單用戶QPS限制為100次/秒。超過限制，API調(diào)用會(huì)被限流，這可能會(huì)影響您的業(yè)務(wù)，請(qǐng)合理調(diào)用。更多信息，請(qǐng)參見QPS限制。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeUserInfoInChannel

系統(tǒng)規(guī)定參數(shù)。取值：DescribeUserInfoInChannel。

AppId String 是 4eah****

應(yīng)用ID，通過控制臺(tái)創(chuàng)建和查詢，僅支持傳單個(gè)ID。
ChannelId String 是 1234

頻道ID，僅支持傳單個(gè)ID。
UserId String 是 testId

用戶ID，僅支持傳單個(gè)ID。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
RequestId String 6159ba01-6687-4fb2-a831-f0cd8d188648

請(qǐng)求ID。
Timestamp Integer 1557909133

當(dāng)前時(shí)刻的時(shí)間戳（UTC時(shí)間）。
IsInChannel Boolean true

用戶當(dāng)前是否在頻道內(nèi)，取值：

  • true：在頻道內(nèi)。
  • false：不在頻道內(nèi)。
IsChannelExist Boolean true

頻道是否存在，取值：

  • true：存在。
  • false：不存在。
Property Array of Property

用戶在頻道內(nèi)的信息。
Session String xa744sxx8rtobgj****

Session ID（會(huì)話ID）。
Role Integer 1

會(huì)議中的角色類型，取值：

  • 0：通信模式下的用戶角色。
  • 1：interactive（參與互動(dòng)）角色。
  • 2：live（僅觀看）角色。
Join Integer 1557909133

用戶進(jìn)入會(huì)議的時(shí)間（UTC時(shí)間）。

示例

請(qǐng)求示例

https://rtc.aliyuncs.com/?Action=DescribeUserInfoInChannel
&AppId=4eah****
&ChannelId=1234
&UserId=testId
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeUserInfoInChannelResponse>
<RequestId>6159ba01-6687-4fb2-a831-f0cd8d188648</RequestId>
<TimeStamp>1557909133</TimeStamp>
<IsChannelExist>true</IsChannelExist>
<IsInChannel>true</IsInChannel>
<Property>
    <Join>1557909133</Join>
    <Session>xa744sxx8rtobgj****</Session>
    <Role>1</Role>
</Property>
</DescribeUserInfoInChannelResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6159ba01-6687-4fb2-a831-f0cd8d188648",
  "TimeStamp" : 1557909133,
  "IsChannelExist" : true,
  "IsInChannel" : true,
  "Property" : [ {
    "Join" : 1557909133,
    "Session" : "xa744sxx8rtobgj****",
    "Role" : 1
  } ]
}