# シグナリング API

> **注意**
>
> この API は [実験的機能](EXPERIMENTAL.html) のため、正式版では仕様が変更される可能性があります。


## ListChannels

**x-sora-target**: Sora_20201013.ListChannels

すべてのチャネル一覧を取得します。

* - キー
  - 型
  - デフォルト
* - local (オプション)
  - boolean
  - true

`local` はクラスター機能利用時に、全てのノードの情報を取得するかどうかを指定します。

```console
$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20201013.ListChannels" \
    | jq .
[
    {
        "channel_id": "sora",
        "spotlight": false
    },
    {
        "channel_id": "akane",
        "spotlight": false
    }
]
```