調用ListLiveMessageGroups查詢互動訊息群組列表。
介面說明
調用本介面前,您必須已經調用 CreateLiveMessageGroup 建立互動訊息群組。
QPS 限制
本介面的單使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:ListLiveMessageGroups |
list |
*Rtc
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
應用 ID。 |
demo |
| SortType |
integer |
是 |
排序方式,按群組建立時間先後進行排序。取值:
|
1 |
| NextPageToken |
integer |
否 |
查詢頁的起始位置,若為空白或-1,則預設為首頁。 |
1001 |
| GroupStatus |
integer |
否 |
群組狀態,預設值為 0。取值:
|
1 |
| DataCenter |
string |
否 |
資料中心,需要與 CreateLiveMessageApp 中的資料中心一致,當前支援上海(取值為 cn-shanghai)、新加坡(取值為 ap-southeast-1)。 |
cn-shanghai |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數。 |
||
| RequestId |
string |
請求 ID。 |
B5D95365-5A46-1A6A-BBF5-C7B6BDED**** |
| Hasmore |
boolean |
是否有下一頁。 |
false |
| NextpageToken |
string |
下一頁的起始位置,當 Hasmore 為 false 時,不返回該欄位。 |
1001 |
| GroupList |
array<object> |
群組列表。 |
|
|
object |
群組資料。 |
||
| GroupId |
string |
群組 ID。 |
cU9MeBqf**** |
| CreatorId |
string |
建立者 ID。 |
user_77 |
| AdminList |
array |
管理員列表。 |
|
|
string |
管理員。 |
uid1 |
|
| Createtime |
integer |
建立時間,用 UNIX 時間戳記表示,單位:秒。 |
1698299727 |
| GroupName |
string |
群組名。 |
mytestgroup |
| GroupInfo |
string |
群組擴充資訊。 |
testgroupinfo |
| Delete |
boolean |
是否已刪除。 |
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
"Hasmore": false,
"NextpageToken": "1001",
"GroupList": [
{
"GroupId": "cU9MeBqf****",
"CreatorId": "user_77",
"AdminList": [
"uid1"
],
"Createtime": 1698299727,
"GroupName": "mytestgroup",
"GroupInfo": "testgroupinfo",
"Delete": true
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InputInvalid | %s. | 輸入參數不合法 |
| 500 | ServerError | %s. | 未知錯誤,請稍後重試或提交工單諮詢。 |
| 403 | NoAuth | %s. | 沒有許可權 |
| 404 | ResourceNotExist | %s. | 請求資源不存在,請檢查後重新嘗試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。