シグナリング — REST
OpenTokシグナリングAPIを使用して、OpenTokセッションに接続しているクライアントにテキストやデータを送信します。
OpenTokクライアントSDKを使用してクライアントエンドポイントがセッションに接続されると、 開発者は、クライアントエンドポイント間で信号を送信するのではなく、 アプリサーバーから接続済みのクライアントに信号を送信することを選択できます。 JS SDKのモデレーション機能とは異なり、REST APIのモデレーション機能は、 セッションから接続を削除するオプションを提供することのみを目的としています。
このトピックには以下のセクションが含まれます:
セッション内の特定のクライアントにシグナルを送信する
HTTP POSTリクエストを signal 特定の接続 ID を持つリソース、
そのセッションに接続しているクライアントに対して:
SESSION_ID=SOMESESSIONID
CONNECTION_ID=SOMECONNECTIONID
API_KEY=123456
# Replace with a JSON web token --
# see /opentok/rest/#authentication:
JWT=jwt_token
DATA='{"type":"foo","data":"bar"}'
curl -v \
-H "Content-Type: application/json" \
-X POST \
-H "X-OPENTOK-AUTH:${JWT}" \
-d "${DATA}" \
https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}/signal
セッション内のすべてのクライアントに信号を送信する
以下の2つの信号の例において、リクエスト本文は、
両方の type そして data フィールド。これらは、クライアントのシグナル受信ハンドラに渡される
型およびデータパラメータに対応しています。
HTTP POSTリクエストを signal セッションの資料:
SESSION_ID=SOMESESSIONID
API_KEY=123456
# Replace with a JSON web token --
# see /opentok/rest/#authentication:
JWT=jwt_token
DATA='{"type":"foo","data":"bar"}'
curl -v \
-H "Content-Type: application/json" \
-X POST \
-H "X-OPENTOK-AUTH:${JWT}" \
-d "${DATA}" \
https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/signal