BatchGetOnlineUsers - 查詢使用者是否線上（舊版） - ApsaraVideo Live

介面說明

使用說明

該介面支援批量查詢，每次最多可以查詢 20 個使用者是否線上。

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。更多資訊，請參見 QPS 限制。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:BatchGetOnlineUsers

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

無

請求參數

名稱	類型	必填	描述	樣本值
AppId	string	是	互動訊息應用 ID。	a494caec-***-695ef345db77
GroupId	string	是	訊息組 ID。	23wcaec-***695ef
UserIds	string	是	使用者 UserId 列表。多個 UserId 之間用半形逗號（,）分隔。最多配置 20 個 UserId。	de1a0,hu9

返回參數

名稱	類型	描述	樣本值
	object	返回參數。
RequestId	string	請求 ID。	16A96B9A-****-CB92E68F4CD8
Result	object	返回結果
OnlineUsers	array<object>	對象數組
	object
JoinTime	integer	加入訊息組的 UTC 時間戳記。單位：毫秒	12**45
Online	boolean	是否線上，取值： true：線上。 false：不線上。	true
UserId	string	使用者 UserId。	de1**a0

樣本

正常返回樣本

JSON格式

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "OnlineUsers": [
      {
        "JoinTime": 0,
        "Online": true,
        "UserId": "de1**a0"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbidden	User not authorized to operate on the specified resource.	介面許可權不足，請您聯絡管理員，配置存取權限。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。