:CreateEventSub

この操作を呼び出して、チャンネルまたはユーザーイベントをサブスクライブするためのコールバックを作成できます。コールバックを作成する際に、コールバック URL やイベントタイプなどのパラメーターを設定できます。

QPS 制限

この操作は、アカウントごとに毎秒 100 回まで呼び出すことができます。この制限を超えたリクエストは破棄され、サービスが中断されます。この操作を呼び出す際は、この制限に注意することを推奨します。

コールバック

コールバックメッセージは、CallbackUrl パラメーターで指定されたコールバック URL に送信されます。次のサンプルコードに例を示します：

リクエスト：

POST /callbackURL

本文
application/json

{
    "MsgId": "メッセージ ID",
    "MsgTimestamp": 12312324, // メッセージが送信されたときの UNIX タイムスタンプ。
    "SubscribeID": "サブスクリプション ID",
    "AppId":"",     // メッセージが生成されたアプリケーションの ID。
    "ChannelID":"", // メッセージが生成されたチャンネルの ID。
    "Contents": [
      {
        "Event": "UserEvent",// サブスクライブされたイベントのタイプ。この場合、タイプはユーザーイベントです。
        "UserEvent": {
          "UserId": "80331631628*****",    // ユーザー ID。
          "EventTag": "Publish",    // イベント。有効な値：Join、Leave、Publish、Unpublish、Roleupdate。
          "SessionId": "0dr15rrnhkz0jnvz6o8sxo0*****", // イベントが生成されたセッションの ID。
          "Timestamp": 1609854786,    // イベントが発生したときの UNIX タイムスタンプ。
          "Reason": 1, // チャンネルへの参加または退出の理由。このパラメーターは、イベントが Join イベントの場合にのみ利用可能です。
          "Role": 1, // ユーザーのロール。ロールにはストリーマーと視聴者が含まれます。
          "CurrentMedias":"1,2,3"// ユーザーによってアップストリーミングされたストリームのタイプ。
        }
      },
      {
        "Event": "ChannelEvent",// サブスクライブされたイベントのタイプ。この場合、タイプはチャンネルイベントです。
        "ChannelEvent": {
          "ChannelId": "88888****",
          "EventTag": "Open",   // イベント。有効な値：Open と Close。
          "Timestamp": 1609854530 // イベントが発生したときの UNIX タイムスタンプ。
        }
      }
   ]
}

応答
HTTP STATUS 200

ユーザーイベントのパラメーター

チャンネルイベントのパラメーター

コールバック認証

デフォルトでは、コールバック認証が有効になっています。次の認証ロジックが適用されます：

• ApsaraVideo Live がコールバックリクエストを開始すると、HTTP または HTTPS リクエストに Ali-Rtc-Timestamp および Ali-Rtc-Signature ヘッダーが含まれ、コールバックメッセージ受信サーバーが署名を認証できるようになります。Ali-Rtc-Signature の値は、次の数式に基づいて計算されます：Ali-Rtc-Signature=MD5SUM(MD5CONTENT)。この数式では、MD5CONTENT は「コールバックドメイン名|Ali-Rtc-Timestamp の値|認証キー」というフォーマットの文字列です。コールバックドメイン名は、コールバック URL 内のドメイン名です。認証キーは、アプリケーションの AppKey です。

• コールバックメッセージを受信した後、コールバックメッセージ受信サーバーは、コールバックドメイン名、Ali-Rtc-Timestamp ヘッダーの値、および認証キーを前述のフォーマットで連結します。サーバーは文字列の MD5 値を計算して暗号化された文字列を取得します。次に、サーバーは暗号化された文字列を、Real-Time Communication (RTC) によって開始された HTTP または HTTPS リクエストの Ali-Rtc-Signature ヘッダーの値と比較します。2 つの値が異なる場合、リクエストは無効です。

コールバックリトライ

Alibaba Cloud がコールバックリクエストを開始した後、ご利用のビジネスサーバーから HTTP ステータスコード 200 が返された場合にのみ、コールバックは成功したと見なされます。コールバックが失敗した場合、ApsaraVideo Live は 1 秒、2 秒、5 秒、10 秒、60 秒、120 秒、300 秒の間隔でコールバックリクエストを 7 回再送します。コールバックリクエストが再送されるたびに、コールバックレコードが生成されます。

例外処理

チャンネルに参加した、またはアップストリーミングを開始したクライアントと Alibaba Cloud サーバーとの間には、キープアライブメカニズムが実装されています。サーバーがクライアントから 90 秒間ハートビート情報を受信しない場合、サーバーはクライアントがタイムアウトし、ユーザーがチャンネルから退出したとみなし、コールバックをトリガーします。ハートビートの検出失敗は、ネットワーク切断が発生した場合や、アプリケーションが異常終了した場合に発生します。