インタラクティブなメッセージグループのリストをページネーション付きで照会します。
操作説明
この操作を呼び出す前に、 CreateLiveMessageGroup を呼び出してインタラクティブなメッセージグループを作成しておく必要があります。
QPS 制限
この操作の単一ユーザー QPS 制限は、1 秒あたり 50 回の呼び出しです。制限を超えると API の呼び出しがスロットリングされ、ビジネスに影響が出る可能性があります。この操作は適切に呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:ListLiveMessageGroupByPage |
list |
*Rtc
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
アプリケーション ID。 |
demo |
| SortType |
integer |
必須 |
グループ作成時間に基づくソート順序。有効な値:
列挙値:
|
1 |
| PageSize |
integer |
任意 |
ページサイズ。有効な値: [1,50]。 デフォルト値: 20。 |
20 |
| PageNumber |
integer |
任意 |
ページ番号。有効な値: [1,10000]。 デフォルト値: 1。 |
1 |
| GroupStatus |
integer |
任意 |
グループのステータス。デフォルト値: 0。有効な値:
列挙値:
|
1 |
| DataCenter |
string |
任意 |
データセンター。この値は CreateLiveMessageApp で指定したデータセンターと同じである必要があります。現在サポートされているデータセンターは、上海 (cn-shanghai) およびシンガポール (ap-southeast-1) です。 |
cn-shanghai |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
B5D95365-5A46-1A6A-BBF5-C7B6BDED**** |
| TotalCount |
integer |
エントリの総数。 |
50 |
| PageNumber |
integer |
返されたデータの現在のページ番号。 |
1 |
| PageSize |
integer |
ページサイズ。 |
20 |
| GroupList |
array<object> |
グループリスト。 |
|
|
object |
グループオブジェクト。 |
||
| GroupId |
string |
グループの ID。 |
cU9MeBqf**** |
| CreatorId |
string |
作成者の ID。 |
user_77 |
| AdminList |
array |
管理者ユーザー ID のリスト。 |
|
|
string |
管理者ユーザー ID。 |
uid1 |
|
| Createtime |
integer |
作成時間。UNIX タイムスタンプで表されます。単位: 秒。 |
1698299727 |
| GroupName |
string |
グループ名。 |
mytestgroup |
| GroupInfo |
string |
グループの拡張情報。 |
testgroupinfo |
| Delete |
boolean |
グループが削除されているかどうかを示します。 |
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
"TotalCount": 50,
"PageNumber": 1,
"PageSize": 20,
"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. | リクエストされたリソースが存在しません。リクエストを確認して再試行してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。