すべてのプロダクト
Search
ドキュメントセンター

ApsaraVideo Live:CreateLiveMessageApp

最終更新日:Jul 15, 2026

インタラクティブなメッセージングアプリケーションを作成します。

操作説明

  • 他のインタラクティブなメッセージング API オペレーションを呼び出す際は、データセンターがインタラクティブなメッセージングアプリケーション作成時に指定したものと同じである必要があります。

  • 1 つの Alibaba Cloud アカウントあたり、最大値 300 個のインタラクティブなメッセージングアプリケーションを作成できます。

QPS 制限

この API オペレーションのシングルユーザー QPS 制限は、1 秒あたり 50 回の呼び出しです。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作は適切に呼び出してください。

今すぐお試しください

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

create

*All resources.

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AppName

string

任意

アプリケーション名。名前の長さは 2~16 文字である必要があります。

testApp

AuditType

integer

任意

セキュリティ監査モード。有効な値:

  • 0: デフォルト値。セキュリティ監査は無効です。

  • 1: 組み込みセキュリティ監査。

  • 2: カスタムセキュリティ監査。

列挙値:

  • 0 :

    セキュリティ監査無効。

  • 1 :

    組み込みセキュリティ監査。

  • 2 :

    カスタムセキュリティ監査。

2

AuditUrl

string

任意

カスタムセキュリティ監査の URL。このパラメーターは、カスタムセキュリティ監査 (AuditType=2) を選択した場合に必須です。URL は http:// または https:// で始まる必要があり、非公開 IP アドレスを含めることはできず、ポート番号を含めることはできません。カスタムセキュリティ監査コンテンツのフォーマットについては、以下のセクションを参照してください。

http://demo.aliyundoc.com/exampleaudit

EventCallbackUrl

string

任意

クライアントのログイン、ログアウト、グループ参加、グループ離脱イベントのイベントコールバック URL。このパラメーターが空の場合、イベントコールバックは無効になります。トリガーされるコールバック API オペレーションについては、「クライアントアクセス」を参照してください。イベントコールバック URL は http:// または https:// で始まる必要があり、非公開 IP アドレスを含めることはできず、ポート番号を含めることはできません。イベントコールバックのフォーマットおよびコールバック認証ロジックについては、以下のセクションを参照してください。

http://demo.aliyundoc.com/examplecallback

DataCenter

string

任意

データセンター。有効な値:

  • cn-shanghai: デフォルト値。上海。

  • ap-southeast-1: シンガポール。

説明

他のインタラクティブなメッセージング API オペレーションを呼び出す際は、データセンターがインタラクティブなメッセージングアプリケーション作成時に指定したものと同じである必要があります。

cn-shanghai

MsgLifeCycle

integer

任意

アプリケーション内のグループメッセージの保存期間ティア。有効な値:

  • 0: デフォルト値。メッセージは 30 日間保存されます。

  • 1: メッセージは 90 日間保存されます。

  • 2: メッセージは 180 日間保存されます。

1

カスタムセキュリティ監査コンテンツの説明:

  • リクエストプロトコル: HTTP

  • リクエストメソッド: POST

  • リクエスト例:

{
  "content": "testaudit"
}
  • レスポンス例:

{
  "pass": true,
  "reason":"****"    |pass が true に設定されている場合、コンテンツが監査に合格したことを示します。それ以外の場合は、コンテンツが不合格であることを示します。reason は拒否の理由を示します。
}
説明

HTTP ステータスコード 200 は成功を示します。200 以外のステータスコードはサービスが利用できないことを示し、システムはメッセージの監査をスキップすることでデグレードします。

イベントコールバック

HTTP/HTTPS POST。ボディは以下のフォーマットの JSON UTF-8 文字列です。イベントコールバック例:

{
  "appid":"demo",
  "eves":[{
  "uid":"uid1",
  "sid":"sessionid",
  "events":[{
     "e": 3, |イベントタイプ。列挙型。1: ログイン、2: ログアウト、3: グループ参加、4: グループ離脱、5: ネットワーク切断後のクライアント再接続
     "r": 1, |ログアウト理由。他のイベントにはこの属性は存在しません。列挙型。1: 通常の呼び出し、3: タイムアウト、4: 他のデバイスからのログイン
     "g": "testgroup", |グループ ID。グループ参加およびグループ離脱イベントにこの値が存在します。ログインおよびログアウトイベントにはこの属性は存在しません。
     "gs":["testgroupid"] |グループ ID リスト。ネットワーク切断後にクライアントが再接続すると、これにはクライアントが参加しているグループが含まれます。他のイベントにはこの属性は存在しません。
  }]
  }]
}
説明

HTTP ステータスコード 200 は成功を示します。その他のステータスコードは失敗を示し、システムは配信を再試行します。

コールバック認証の説明

サービスがリクエストを開始すると、HTTP(S) リクエストヘッダーに Ali-Live-Timestamp フィールドと Ali-Live-Signature フィールドが含まれ、コールバックメッセージ受信サーバーが署名認証を実行します。Ali-Live-Signature の値は次のように計算されます: Ali-Live-Signature=sha256(CONTENT)。CONTENT = コールバックドメイン名 + Ali-Live-Timestamp 値 + 認証キー。コールバックドメイン名は、コールバック URL で設定されたドメイン名です。認証キーは、AppId 作成時に生成された AppKey です。

レスポンスフィールド

フィールド

説明

object

応答パラメーター。

RequestId

string

リクエスト ID。

65EEDBEB-43FE-1E15-976F-3DDD753A****

AppId

string

アプリケーション ID。グループ参加などの後続の操作に使用されます。

demo

AppKey

string

AppKey。AppId に関連するさまざまな操作の認証を生成するために使用されます。

**********************************

AppSign

string

アプリケーション署名。インタラクティブなメッセージングサービス SDK にこの情報が必要です。

**************************************************************************

DataCenter

string

データセンター。

cn-shanghai

成功レスポンス

JSONJSON

{
  "RequestId": "65EEDBEB-43FE-1E15-976F-3DDD753A****",
  "AppId": "demo",
  "AppKey": "**********************************",
  "AppSign": "**************************************************************************",
  "DataCenter": "cn-shanghai"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InputInvalid %s. 入力パラメーターが無効です。
400 ErrorInvalidAppName %s. AppName が無効です。値を確認して再試行してください。
400 ErrorTooManyApps %s. 各アカウントで同時に作成できるアプリは最大値の 300 個までです。
400 ErrorInvalidEventCallbackUrl %s. EventCallbackUrl が無効です。値を確認して再試行してください。
400 ErrorInvalidAuditUrl %s. AuditUrl が無効です。値を確認して再試行してください。
500 ServerError %s. 不明なエラーが発生しました。後でもう一度お試しいただくか、チケットを送信してください。
403 NoAuth %s. 必須の権限がありません。
404 ResourceNotExist %s. リクエストされたリソースが存在しません。リクエストを確認して再試行してください。

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

変更履歴

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