ApsaraVideo Live:CreateEventSub

チャンネルメッセージをサブスクライブするためのコールバックを作成します。たとえば、コールバックの作成時に、コールバック URL やイベントタイプなどのパラメーターを設定できます。

QPS 制限

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

コールバック

次の例は、指定された CallbackUrl を通じてユーザーにコールバックされる内容を示しています。

Request:

POST /callbackURL

Body
application/json

{
    "MsgId": "Message ID",
    "MsgTimestamp": 12312324, // メッセージ送信時の Unix 時間スタンプ
    "SubscribeID": "Subscription ID",
    "AppId":"",     // このメッセージを生成した AppId 
    "ChannelID":"", // このメッセージを生成したチャンネル
    "Contents": [
      {
        "Event": "UserEvent",// サブスクリプションイベント: チャンネル内のユーザーイベント
        "UserEvent": {
          "UserId": "80331631628*****",    // ユーザー ID
          "EventTag": "Publish",    // イベント (Join, Leave, Publish, Unpublish, Roleupdate など)
          "SessionId": "0dr15rrnhkz0jnvz6o8sxo0*****", // このイベントを生成した SessionID
          "Timestamp": 1609854786,    // イベント発生時の Unix 時間スタンプ
          "Reason": 1, // 参加または退出の理由。Join イベントでのみ利用可能。
          "Role": 1, //  ロールタイプ: 配信者または視聴者
          "CurrentMedias":"1,2,3"// ストリームタイプ: ユーザーによって公開されたストリーム
        }
      },
      {
        "Event": "ChannelEvent",// サブスクリプションイベント: チャンネルイベント
        "ChannelEvent": {
          "ChannelId": "88888****",
          "EventTag": "Open",   // チャンネルイベント (Open, Close など)
          "Timestamp": 1609854530 // イベント発生時の Unix 時間スタンプ
        }
      }
   ]
}

Response 
HTTP STATUS 200

UserEvent

ChannelEvent

コールバック認証

イベントコールバック認証機能はデフォルトで有効になっています。認証ロジックは以下の通りです。

• ApsaraVideo Live がコールバックリクエストを呼び出すと、HTTP(S) リクエストヘッダーに Ali-Rtc-Timestamp フィールドと Ali-Rtc-Signature フィールドが含まれ、コールバックメッセージ受信サーバーが署名認証を実行します。Ali-Rtc-Timestamp の値は、Ali-Rtc-Signature=MD5SUM(MD5CONTENT) として計算されます。ここで MD5CONTENT=コールバックドメイン名|Ali-Rtc-Timestamp 値|認証キー です。コールバックドメイン名はコールバック URL で設定されたドメイン名であり、認証キーは AppId 作成時に生成された AppKey です。

• コールバックメッセージ受信サーバーはコールバックメッセージを受信すると、コールバックドメイン名、Ali-Rtc-Timestamp 値、および認証キーを連結し、MD5 値を計算して暗号化文字列を取得します。その後、計算された暗号化文字列と、ApsaraVideo Real-time Communication によって呼び出された HTTP(S) リクエストヘッダー内の Ali-Rtc-Signature フィールド値を比較します。一致しない場合、リクエストは無効です。

コールバック例外のリトライ

Alibaba Cloud がコールバックリクエストを呼び出した際、ビジネスサーバーが HTTP ステータスコード 200 で応答した場合にのみ、コールバックは成功とみなされます。コールバックが失敗した場合、Alibaba Cloud は 1 秒、2 秒、5 秒、10 秒、1 分、2 分、5 分の間隔で 7 回リトライします。各リトライでは対応するコールバックレコードが生成されます。

例外処理

チャンネルに参加している、またはストリームを公開しているクライアントは、Alibaba Cloud サーバーとの間でハートビートキープアライブメカニズムを維持します。クライアントがネットワーク接続を失ったか、アプリが異常終了したためにハートビートキープアライブが失敗した場合（クライアントから 90 秒間ハートビートが受信されない場合に失敗と判断）、サーバーはクライアントがタイムアウトして異常退出したと判断し、ユーザーのストリーム公開停止およびチャンネル退出のイベントコールバックを生成します。