モデレーション — REST

クライアントエンドポイントにセッションからの切断を強制する

OpenTok.js SDK から接続中のクライアントエンドポイントを管理することに加え、アプリサーバーは、サーバー側から HTTP DELETE リクエストを発行して、接続中のクライアントをセッションから強制的に切断させることができます。

アプリケーションサーバーは、そのクライアントの接続に対応するリソースに対してHTTP DELETEリクエストを送信することで、 OpenTokセッションからクライアントを切断することができます：

SESSION_ID=SOME_SESSION_ID CONNECTION_ID=SOME_CONNECTION_ID API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -X DELETE \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}

詳細は OpenTok REST API ドキュメント.

セッション内のストリームに対して、配信中のオーディオをミュートするように強制する

を使用することができます。 OpenTok REST API 特定のストリームの配信者に、配信中の音声をミュートさせるには：

SESSION_ID=SOME_SESSION_ID STREAM_ID=SOME_STREAM_ID API_KEY=123456 API_SECRET=ABCDEF1234567890 JWT=jwt_token curl -v \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/stream/${STREAM_ID}/mute

を使用することができます。 OpenTok REST API セッション内のすべてのストリーム（オプションで指定されたストリームの一覧を除く）に対して、配信中のオーディオをミュートするように強制するには：

SESSION_ID=SOME_SESSION_ID DATA='{"excludedStreamIds": ["excludedStreamId1", "excludedStreamId2"], "active": true}' API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -H "Content-Type: application/json" \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/mute

JSONデータには、以下のプロパティが含まれています：

active (ブール値、必須) — セッション内のストリームをミュートするかどうか（true) セッションのミュート状態を有効にする、またはセッションのミュート状態を無効にする（false). ミュート状態が有効になっている場合（true), セッションに公開されている現在および将来のすべてのストリーム（ただし、 excludedStreamIds array) はミュートされます。このメソッドを active プロパティを false, その後、そのセッションに公開されるストリームはミュートされません（ただし、すでにミュートされているストリームはそのままミュートされた状態のままです）。
excludedStreamIds (文字列の配列、オプション) — ミュート対象から除外するストリームの ID。これはオプションのプロパティです。このプロパティを省略した場合、セッション内のすべてのストリームがミュートされます。このプロパティは、 active プロパティが true. そのとき、 active プロパティが false, 無視されます。

セッションのミュート状態を解除するには（今後のストリームがミュートされないようにするには）、以下の引数を指定して、このメソッドを再度呼び出してください。 active プロパティを false:

SESSION_ID=SOME_SESSION_ID DATA='{"active": false}' API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -H "Content-Type: application/json" \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/mute