プロジェクト セッション API

概要

プロジェクトの API Key を利用してそのプロジェクトのセッション情報を取得できます。

セッション情報は直近 30 日間分の最大 100 件取得できます。

現在の同時接続数

API URL:

https://api.sora-cloud.shiguredo.app/projects/get-total-live-concurrent-connections

現在の同時接続数を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/get-total-live-concurrent-connections \
    -vvv

POST /projects/get-total-live-concurrent-connections HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 0
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0



HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Length: 2
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

5

現在のセッション合計数

API URL:

https://api.sora-cloud.shiguredo.app/projects/get-total-live-sessions

現在のセッション合計数を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/get-total-live-sessions \
    -vvv

POST /projects/get-total-live-sessions HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 0
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0



HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Length: 2
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

2

現在のセッション一覧

API URL:

https://api.sora-cloud.shiguredo.app/projects/list-live-sessions

現在のセッション一覧を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/list-live-sessions \
    -vvv

POST /projects/list-live-sessions HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 0
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0



HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Transfer-Encoding: chunked
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

[
    {
        "start_timestamp": "2023-12-21T10:19:49.779719Z",
        "node_name": "sora-1@sora-cloud1",
        "channel_id": "channel-2@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
        "session_id": "MDND1JPYF55EB54V2C72GCYFZ4",
        "channel_connections": 1,
        "last_active_timestamp": "2023-12-21T10:19:49.986033Z"
    }
    {
        "start_timestamp": "2023-12-21T10:19:49.779719Z",
        "node_name": "sora-2@sora-cloud2",
        "channel_id": "channel-2@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
        "session_id": "MDND1JPYF55EB54V2C72GCYFZ4",
        "channel_connections": 2,
        "last_active_timestamp": "2023-12-21T10:19:49.986033Z"
    }
    ...
]

現在の指定したセッションを取得

API URL:

https://api.sora-cloud.shiguredo.app/projects/get-live-session

指定した現在のセッション情報を取得します

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/get-live-session \
    session_id=<Session-ID> \
    -vvv

POST /projects/get-live-session HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 44
Content-Type: application/json
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0

{
    "session_id": "8XWBNGXG8S60B8K5XEBHSK1BRM"
}

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Length: 253
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

{
    "start_timestamp": "2023-12-22T04:47:42.177097Z",
    "node_name": "sora1@sora-cloud1",
    "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
    "session_id": "8XWBNGXG8S60B8K5XEBHSK1BRM",
    "channel_connections": 1,
    "last_active_timestamp": "2023-12-22T04:49:42.398167Z"
}

現在のコネクション一覧

API URL:

https://api.sora-cloud.shiguredo.app/projects/list-live-connections

プロジェクトの現在の指定したセッションのコネクション一覧を取得します

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/list-live-connections \
    session_id=<Session-ID> \
    -vvv

POST /projects/list-live-connections HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 44
Content-Type: application/json
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0

{
    "session_id": "8XWBNGXG8S60B8K5XEBHSK1BRM"
}

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Transfer-Encoding: chunked
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

[
    {
        "status": "Active",
        "sora_version": "2023.2.0",
        "node_name": "sora1@sora-cloud1",
        "role": "sendrecv",
        "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
        "session_id": "8XWBNGXG8S60B8K5XEBHSK1BRM",
        "client_id": "7AXCNHPTVH1HH6TQ74ZH9FPRHC",
        "bundle_id": "7AXCNHPTVH1HH6TQ74ZH9FPRHC",
        "connection_id": "7AXCNHPTVH1HH6TQ74ZH9FPRHC",
        "multistream": true,
        "simulcast": false,
        "audio": true,
        "audio_codec_type": "OPUS",
        "audio_bit_rate": null,
        "video": true,
        "video_codec_type": "VP9",
        "video_bit_rate": 500,
        "duration_min": 2,
        "total_received_bytes": 8509508,
        "total_sent_bytes": 12680,
        "turn_transport_type": "tcp",
        "created_timestamp": "2023-12-22T04:47:42.393212Z",
        "destroyed_timestamp": null
    },
    ...
]

現在の指定したコネクション詳細

API URL:

https://api.sora-cloud.shiguredo.app/projects/get-live-connection

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/get-live-connection \
    session_id=<Session-ID> \
    connection_id=<Connection-ID> \
    -vvv

POST /projects/get-live-connection HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 91
Content-Type: application/json
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0

{
    "session_id": "8XWBNGXG8S60B8K5XEBHSK1BRM",
    "connection_id": "7AXCNHPTVH1HH6TQ74ZH9FPRHC"
}

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Length: 651
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

{
    "status": "Active",
    "sora_version": "2023.2.0",
    "node_name": "sora1@sora-cloud1",
    "role": "sendrecv",
    "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
    "session_id": "8XWBNGXG8S60B8K5XEBHSK1BRM",
    "client_id": "7AXCNHPTVH1HH6TQ74ZH9FPRHC",
    "bundle_id": "7AXCNHPTVH1HH6TQ74ZH9FPRHC",
    "connection_id": "7AXCNHPTVH1HH6TQ74ZH9FPRHC",
    "multistream": true,
    "simulcast": false,
    "audio": true,
    "audio_codec_type": "OPUS",
    "audio_bit_rate": null,
    "video": true,
    "video_codec_type": "VP9",
    "video_bit_rate": 500,
    "duration_min": 2,
    "total_received_bytes": 8509508,
    "total_sent_bytes": 12680,
    "turn_transport_type": "tcp",
    "created_timestamp": "2023-12-22T04:47:42.393212Z",
    "destroyed_timestamp": null
}

過去のセッション一覧

API URL:

https://api.sora-cloud.shiguredo.app/projects/list-past-sessions

プロジェクトの過去のセッション一覧を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/list-past-sessions \
    -vvv

POST /projects/list-past-sessions HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 0
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0



HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Transfer-Encoding: chunked
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

[
    {
        "timestamp": "2023-12-21T10:13:59.947433Z",
        "node_name": "sora1@sora-cloud1",
        "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
        "session_id": "DM2ASQDRF90H9DPS5S5ABKWTKM",
        "total_connections": 1,
        "max_connections": 1,
        "created_timestamp": "2023-12-21T10:13:21.731452Z",
        "destroyed_timestamp": "2023-12-21T10:13:59.947058Z",
        "duration_min": 0
    },
    {
        "timestamp": "2023-12-21T08:05:21.073115Z",
        "node_name": "sora1@sora-cloud1",
        "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
        "session_id": "4HW0G1Y65H57519CFEHTGP5ZG0",
        "total_connections": 1,
        "max_connections": 1,
        "created_timestamp": "2023-12-21T08:03:24.052625Z",
        "destroyed_timestamp": "2023-12-21T08:05:21.072713Z",
        "duration_min": 1
    },
    ...
]

過去のセッション詳細

API URL:

https://api.sora-cloud.shiguredo.app/projects/get-past-session

指定したセッション ID の過去のセッション情報を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/get-past-session \
    session_id=<Session-ID> \
    -vvv

POST /projects/get-past-session HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 44
Content-Type: application/json
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0

{
    "session_id": "HWQ9DYPC0D05S9YDSTJSS3PSAR"
}

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Length: 331
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

{
    "timestamp": "2023-12-22T04:46:43.132317Z",
    "node_name": "sora1@sora-cloud1",
    "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
    "session_id": "HWQ9DYPC0D05S9YDSTJSS3PSAR",
    "total_connections": 1,
    "max_connections": 1,
    "created_timestamp": "2023-12-22T04:34:19.866827Z",
    "destroyed_timestamp": "2023-12-22T04:46:43.131931Z",
    "duration_min": 12
}

過去のコネクション一覧

API URL:

https://api.sora-cloud.shiguredo.app/projects/list-past-connections

過去の指定したセッション ID のコネクション一覧を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/list-past-connections \
    session_id=<Session-ID> \
    -vvv

POST /projects/list-past-connections HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 44
Content-Type: application/json
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0

{
    "session_id": "HWQ9DYPC0D05S9YDSTJSS3PSAR"
}

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Transfer-Encoding: chunked
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

[
    {
        "timestamp": "2023-12-22T04:46:28.129771Z",
        "node_name": "sora1@sora-cloud1",
        "role": "sendrecv",
        "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
        "session_id": "HWQ9DYPC0D05S9YDSTJSS3PSAR",
        "client_id": "JX0FD6323X58D1XKDPNW4G47A8",
        "bundle_id": "JX0FD6323X58D1XKDPNW4G47A8",
        "connection_id": "JX0FD6323X58D1XKDPNW4G47A8",
        "total_received_bytes": 50773444,
        "total_sent_bytes": 76816,
        "created_timestamp": "2023-12-22T04:34:20.070429Z",
        "destroyed_timestamp": "2023-12-22T04:46:28.129613Z",
        "duration_min": 12
    },
    ...
]

過去のコネクション詳細

API URL:

https://api.sora-cloud.shiguredo.app/projects/get-past-connection

指定したコネクション ID の過去のコネクション情報を取得します。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/get-past-connection \
    session_id=<Session-ID> \
    connection_id=<Connection-ID> \
    -vvv

POST /projects/get-past-connection HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 91
Content-Type: application/json
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0

{
    "session_id": "HWQ9DYPC0D05S9YDSTJSS3PSAR",
    "connection_id": "JX0FD6323X58D1XKDPNW4G47A8"
}

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Length: 491
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

{
    "timestamp": "2023-12-22T04:46:28.129771Z",
    "node_name": "sora1@sora-cloud1",
    "role": "sendrecv",
    "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
    "session_id": "HWQ9DYPC0D05S9YDSTJSS3PSAR",
    "client_id": "JX0FD6323X58D1XKDPNW4G47A8",
    "bundle_id": "JX0FD6323X58D1XKDPNW4G47A8",
    "connection_id": "JX0FD6323X58D1XKDPNW4G47A8",
    "total_received_bytes": 50773444,
    "total_sent_bytes": 76816,
    "created_timestamp": "2023-12-22T04:34:20.070429Z",
    "destroyed_timestamp": "2023-12-22T04:46:28.129613Z",
    "duration_min": 12
}
© Copyright 2024, Shiguredo Inc. Created using Sphinx 8.2.3