ListLiveMessageGroupUsers API 概要 - LIVE

操作説明

この操作を呼び出す前に、CreateLiveMessageGroup 操作を呼び出してインタラクティブメッセージンググループを作成済みであることを確認してください。
ユーザー数が 2,000 を超えるスーパーグループの場合、ユーザーリストはクエリできません。さらに、ユーザーのグループへの参加または退出に関する通知は、少なくとも 5 秒の間隔で送信されます。これらの通知は、現時点でのグループ内の正確なユーザー数を表示しますが、グループに参加または退出したすべてのユーザーのリストは表示しません。グループがスーパーグループにアップグレードされると、そのグループのユーザーリストは直ちにクリアされます。スーパーグループは、グループ内のすべてのユーザーがグループから退出する (つまり、グループが閉鎖される) まで、通常のグループに戻すことはできません。グループを再度開くと、通常のグループに戻ります。

QPS 制限

1 つのアカウントで、毎秒 50 回までこの操作を呼び出すことができます。この制限を超えたリクエストはドロップされ、サービス中断が発生します。この操作を呼び出す際は、この制限に注意することを推奨します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:ListLiveMessageGroupUsers

list

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	クエリ対象のインタラクティブメッセージングアプリケーションの ID。	demo
GroupId	string	必須	クエリ対象のグループの ID。	grouptest
PageSize	integer	必須	1 ページあたりのエントリ数。有効な値：10～50。	10
SortType	integer	必須	ユーザーがグループに参加した時間に基づくソート順。有効な値： 1：昇順 2：降順	1
NextPageToken	integer	任意	クエリの開始ページ番号。このパラメーターを空のままにすると、クエリは最初のページから開始されます。	1
DataCenter	string	任意	データセンター。インタラクティブメッセージングアプリケーションを作成するために CreateLiveMessageApp 操作を呼び出すときに指定したデータセンターと同じである必要があります。有効な値：cn-shanghai および ap-southeast-1 (シンガポール)。	cn-shanghai

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	A1D75BEA-1329-116F-B29C-76F3F200****
GroupId	string	クエリされたグループの ID。	grouptest
NextPageToken	integer	次のクエリの開始ページ番号。値が 0 の場合は、これ以上クエリできるページがないことを示します。	0
Hasmore	boolean	現在のページの後に別のページが続くかどうかを示します。	false
UserList	array<object>	ユーザーに関する詳細。
	object
UserId	string	ユーザーの ID。	uid1
UserInfo	string	ユーザーに関する追加情報。	info1

例

成功レスポンス

JSONJSON

{
  "RequestId": "A1D75BEA-1329-116F-B29C-76F3F200****",
  "GroupId": "grouptest",
  "NextPageToken": 0,
  "Hasmore": false,
  "UserList": [
    {
      "UserId": "uid1",
      "UserInfo": "info1"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
420	SuperLargeGroup	%s.
400	InputInvalid	%s.
500	ServerError	%s.
403	NoAuth	%s.
404	ResourceNotExist	%s.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。