調用ListLiveMessageGroupUsers查詢群組使用者列表。
介面說明
調用本介面前,您必須已經調用 CreateLiveMessageGroup 建立互動訊息群組。
對於超級大群(超過 2000 人的群組),不再提供成員列表查詢。並且群成員進出群組通知之間會至少間隔 5s,通知中不顯示全部進出使用者列表,但顯示精確群人數。群組一旦升級為超級大群,群成員列表會馬上清空,無法再恢複為普通群組,直到所有群成員退出群組(群組關閉),重新開啟時才會恢複為普通群組。
QPS 限制
本介面的單使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:ListLiveMessageGroupUsers |
list |
*Rtc
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
需要查詢的直播互動應用 ID。 |
demo |
| GroupId |
string |
是 |
需要查詢的群組的 GroupID。 |
grouptest |
| PageSize |
integer |
是 |
一次顯示的使用者數量,取值範圍**[10,50]**。 |
10 |
| SortType |
integer |
是 |
排序方式,按使用者加入群組時間先後進行排序。取值:
|
1 |
| NextPageToken |
integer |
否 |
查詢頁的起始位置,若為空白則預設為首頁。 |
1 |
| DataCenter |
string |
否 |
資料中心,需要與 CreateLiveMessageApp 中的資料中心一致,當前支援上海(取值為 cn-shanghai)、新加坡(取值為 ap-southeast-1)。 |
cn-shanghai |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
A1D75BEA-1329-116F-B29C-76F3F200**** |
| GroupId |
string |
需要查詢的群組的 GroupID。 |
grouptest |
| NextPageToken |
integer |
下一頁的起始位置,若沒有下一頁則為 0。 |
0 |
| Hasmore |
boolean |
是否有下一頁。 |
false |
| UserList |
array<object> |
對象數組。 |
|
|
object |
數組詳情。 |
||
| UserId |
string |
查詢的使用者識別碼。 |
uid1 |
| UserInfo |
string |
使用者擴充資訊。 |
info1 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "A1D75BEA-1329-116F-B29C-76F3F200****",
"GroupId": "grouptest",
"NextPageToken": 0,
"Hasmore": false,
"UserList": [
{
"UserId": "uid1",
"UserInfo": "info1"
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 420 | SuperLargeGroup | %s. | 當群成員超過2000人時,群組升級為超級大群,不再支援查詢使用者列表 |
| 400 | InputInvalid | %s. | 輸入參數不合法 |
| 500 | ServerError | %s. | 未知錯誤,請稍後重試或提交工單諮詢。 |
| 403 | NoAuth | %s. | 沒有許可權 |
| 404 | ResourceNotExist | %s. | 請求資源不存在,請檢查後重新嘗試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。