インタラクティブメッセージングアプリケーション内のインタラクティブメッセージンググループをクエリします。
操作説明
この操作を呼び出す前に、CreateLiveMessageGroup 操作を呼び出してインタラクティブメッセージンググループを作成済みであることを確認してください。
QPS 制限
1 アカウントあたり、毎秒 50 回までこの操作を呼び出すことができます。 この制限を超えたリクエストはドロップされ、サービスが中断されます。 この操作を呼び出す際は、この制限に注意することを推奨します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:ListLiveMessageGroups |
list |
*Rtc
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
アプリケーション ID。 |
demo |
| SortType |
integer |
必須 |
グループが作成された時間に基づくソート順。有効な値:
|
1 |
| NextPageToken |
integer |
任意 |
クエリの開始ページ番号。このパラメーターを空のままにすると、クエリは最初のページから開始されます。 |
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 の値が true の場合にのみ返されます。 |
1001 |
| GroupList |
array<object> |
グループの詳細。 |
|
|
object |
グループの詳細。 |
||
| GroupId |
string |
グループの ID。 |
cU9MeBqf**** |
| CreatorId |
string |
グループ作成者の ID。 |
user_77 |
| AdminList |
array |
グループ管理者の ID のリスト。 |
|
|
string |
管理者。 |
uid1 |
|
| Createtime |
integer |
グループが作成された時間。値は UNIX タイムスタンプです。単位:秒。 |
1698299727 |
| GroupName |
string |
グループの名前。 |
mytestgroup |
| GroupInfo |
string |
グループに関する追加情報。 |
testgroupinfo |
| Delete |
boolean |
グループが削除されたかどうかを示します。 |
true |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InputInvalid | %s. | |
| 500 | ServerError | %s. | |
| 403 | NoAuth | %s. | |
| 404 | ResourceNotExist | %s. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。