Room API ／ Channel API

SkyWay Channel API

概要

SkyWay Channel API は、SkyWay の Channel の作成と取得を行うことができるサーバーサイド向けの API です。

類似するサーバーサイド向け API である SkyWay Room API のリリースに伴い、SkyWay Channel API は非推奨とさせていただきました。今後は SkyWay Room API をご利用ください。

SkyWay Channel API から SkyWay Room API への移行については移行ドキュメントをご参照ください。

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

使用方法

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

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

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

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

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

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "createChannel",
  "params": {
    "name": "sample-channel",
  }
}

API エンドポイント

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

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

認証

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

サンプルコード

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

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

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

{"jsonrpc":"2.0","result":{"channel":{"id":"7e19cb20-fc79-4d2f-bf29-d498ff76299a","name":"sample-channel"}},"id":0}

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

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

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

{"jsonrpc":"2.0","result":{"channel":{"id":"7e19cb20-fc79-4d2f-bf29-d498ff76299a","name":"sample-channel-05","members":[],"publications":[],"subscriptions":[]}},"id":0}

リクエストレートの制限

SkyWay Channel API へのリクエストはリクエストレートの制限の対象になります。リクエストレートの制限の詳細についてはリクエストレートの制限のドキュメントを参照してください。

Room API

概要