JoinMessageGroup - ApsaraVideo Live - Alibaba Cloud ドキュメントセンター

操作説明

The QPS limit for this API is 200 calls per second per user. If this limit is exceeded, API calls will be throttled, which may affect your business. Please use this API responsibly.

今すぐお試しください

この 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:JoinMessageGroup

update

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	インタラクティブなメッセージアプリケーションの ID。	a494caec-***-695ef345db77
GroupId	string	必須	参加するメッセージグループの ID。指定する GroupId が存在することを確認してください。	AE35-****-T95F
UserId	string	必須	ユーザー ID。ユーザーがカスタマイズし、AppId 配下で一意である必要があります。ID には小文字、数字、アンダースコア (_)、ピリオド (.) を使用できます。最大値の長さは 32 文字です。異なるユーザーは異なる UserId を使用する必要があります。	de1**a0
BroadCastType	integer	任意	システムメッセージの拡散タイプ。有効な値: 0 (デフォルト): 拡散しません。 1: 指定したユーザーへの拡散。 2: グループへの拡散。	2
BroadCastStatistics	boolean	任意	統計メッセージをブロードキャストするかどうかを指定します。有効にすると、ユーザーがグループに参加した後にメッセージグループの統計がブロードキャストされ、クライアントはメッセージを受信してプロセスできます。有効な値: true: 統計メッセージをブロードキャストします。 false: 統計メッセージをブロードキャストしません。	true

レスポンスフィールド

フィールド	型	説明	例
	object	Schema of Response
RequestId	string	Request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	Return result.
Success	boolean	Indicates whether joining the message group was successful. Valid values: true: Successful. false: Unsuccessful.	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "Success": true
  }
}

エラーコード

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

変更履歴

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