Room API ／ Channel API

SkyWay Room API

概要

SkyWay Room API は、SkyWay の Room に対する操作を実行するサーバーサイド向け API です。

類似するサーバーサイド向け API として SkyWay Channel API を提供しておりますが、現在は非推奨です。 SkyWay Room API をご利用ください。

クライアントサイドでの Room の操作は各種 SDK をご利用ください。

使用方法

SkyWay Room API は JSON-RPC 2.0 に準拠しています。また、リクエストはすべて HTTP POST メソッドを使用します。

リクエストボディのスキーマは以下のようになっており、method プロパティに使用したい SkyWay Room API のメソッドを指定し、params プロパティに必要なパラメータを指定します。

提供されている SkyWay Room API のメソッドなどの詳細については SkyWay Room API リファレンスを参照してください。

プロパティ	形式	必須	説明
jsonrpc	string	️✔	`2.0` を指定する
id	string \| integer	✔	任意の値を指定する。レスポンスにはリクエストで指定した id の値が入る
method	string	✔	SkyWay Room API のメソッドを指定する
params	object	✔	SkyWay Room API のメソッドを使用するのに必要なパラメータを指定する

例えば SkyWay Room API の createRoom メソッドで name sample-room の Room を作成するときのリクエストボディは以下のようになります。

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "createRoom",
  "params": {
    "name": "sample-room",
  }
}

API エンドポイント

以下のエンドポイントから SkyWay Room API を利用できます。

https://room.skyway.ntt.com/v1/json-rpc

認証

SkyWay Room API の利用には SkyWay Admin Auth Token による認証が必要です。 SkyWay Admin Auth Token の詳細についてはSkyWay Admin Auth Token のドキュメントを参照してください。

サンプルコード

次のコードでは、curl コマンドで SkyWay Room API の createRoom メソッドを使って name sample-room の Room を作成しています。 YOUR_SKYWAY_ADMIN_AUTH_TOKEN は生成した SkyWay Admin Auth Token で置き換えてください。

curl https://room.skyway.ntt.com/v1/json-rpc \
     -X POST \
     -H "Authorization: Bearer YOUR_SKYWAY_ADMIN_AUTH_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "createRoom",
      "params": {
        "name": "sample-room"
      }
    }'

レスポンスとして作成した Room の id や name が返されます。

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": {
    "room": {
      "id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc",
      "name": "sample-room"
    }
  }
}

次のコードでは、SkyWay Room API の findRoom メソッドを使って name sample-room の Room を取得しています。

curl https://room.skyway.ntt.com/v1/json-rpc \
     -X POST \
     -H "Authorization: Bearer YOUR_SKYWAY_ADMIN_AUTH_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "findRoom",
      "params": {
        "name": "sample-room"
      }
    }'

レスポンスとして Room の詳細な情報が返されます。

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": {
    "room": {
      "id": "6abbecae-dd86-4e8b-ab9f-8da2c7740ddc",
      "name": "sample-room",
      "members": [],
      "publications": [],
      "subscriptions": []
    }
  }
}

リクエストレートの制限

SkyWay Room API へのリクエストはリクエストレートの制限の対象になります。リクエストレートの制限の詳細については「割り当てと制限」ページの「リクエストレートの制限」セクションを参照してください。

TURN

Channel API (旧)