API docs by Redocly

RICOH Live Streaming REST API: 料金・利用量集計 API (v1)

Download OpenAPI specification:Download

RICOH Live Streaming REST API は Live Streaming サービスの公開 REST API です。

本ページは料金・利用量集計 API の仕様について記載します。

共通仕様

  • API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されます
  • 本 API で取得されるデータの保証範囲について
    • 終了後 24 時間以上経過した RoomInstance について確定した値が算入されていることを保証します
  • 指定時刻範囲について
    • RoomInstance の開始時刻が since 以降、until 未満のデータ、及び、その RoomInstance に付随する ConnectionInstance のデータに対して集計が行われます
    • since で指定可能な時刻は、現在時刻から過去 1 年以内
    • until で指定可能な時刻は、since 以降 1 ヶ月以内
  • approximate_total_cost および approximate_cost について
    • 単位は日本円 (JPY) です
  • 料金・利用量の明細リストの各明細項目について
    item_name usage の単位 詳細
    connection_time 分 usage は ConnectionInstance 単位で接続時間の 1 分未満を切り捨てた値の合計値
    traffic_volume GiB usage はデータ通信量の合計値
    クライアントアプリ全体の集計の場合は合計値の 1GiB 未満を切り捨てた値
    詳細は(*1)を参照してください
    bitrate_reservation 分 sub_items は各予約帯域幅設定ごとの副項目のリスト
    各副項目の item_name は予約帯域幅の設定値 (Mbps)
    各副項目の usage は RoomInstance 単位で接続時間の 1 分未満を切り捨てた値の合計値
    • (*1) traffic_volume のデータ通信量の合計値について
      • room_spec の type が sfu または sfu_large の場合
        • 2024/04/01 00:00 (UTC) 以降に開始した RoomInstance については SFU サーバーからの送信量のみを対象とし、 SFU サーバーの受信量は対象外とします
        • それより前に開始した RoomInstance については、SFU サーバーの送受信量を対象とします
      • room_specの type が p2p_turn の場合
        • 中継経路上の各 TURN サーバーからの送信量を対象とします

料金・利用量集計 API

クライアントアプリ全体の料金・利用量集計結果の取得

Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
query Parameters
env
Array of strings (LSEnv)
Default: ["prod","dev"]
Items Enum: "prod" "dev"
  • 集計対象の環境
    • prod: プロダクション環境
    • dev: 開発環境
  • 複数指定可能 ?env=prod&env=dev
  • 指定されない場合は全ての環境について収集します
since
required
string <date-time>
  • 集計範囲の開始時刻 (ISO8601 拡張形式)
  • UTC 指定の例
    • 2021-01-01T00:00:00Z
  • JST 指定の例
    • 2021-01-01T09:00:00+09:00
    • こちらの場合は値に対して URL エンコードが必要
until
required
string <date-time>
  • 集計範囲の終了時刻 (ISO8601 拡張形式)
  • UTC 指定の例
    • 2021-01-01T00:00:00Z
  • JST 指定の例
    • 2021-01-01T09:00:00+09:00
    • こちらの場合は値に対して URL エンコードが必要

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

特定の課金分類ラベルについての料金・利用量集計結果の取得

Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
classification_label
required
string
  • 課金分類ラベル
query Parameters
env
Array of strings (LSEnv)
Default: ["prod","dev"]
Items Enum: "prod" "dev"
  • 集計対象の環境
    • prod: プロダクション環境
    • dev: 開発環境
  • 複数指定可能 ?env=prod&env=dev
  • 指定されない場合は全ての環境について収集します
since
required
string <date-time>
  • 集計範囲の開始時刻 (ISO8601 拡張形式)
  • UTC 指定の例
    • 2021-01-01T00:00:00Z
  • JST 指定の例
    • 2021-01-01T09:00:00+09:00
    • こちらの場合は値に対して URL エンコードが必要
until
required
string <date-time>
  • 集計範囲の終了時刻 (ISO8601 拡張形式)
  • UTC 指定の例
    • 2021-01-01T00:00:00Z
  • JST 指定の例
    • 2021-01-01T09:00:00+09:00
    • こちらの場合は値に対して URL エンコードが必要

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

課金分類ラベルごとの料金・利用量集計結果の取得

Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
query Parameters
env
Array of strings (LSEnv)
Default: ["prod","dev"]
Items Enum: "prod" "dev"
  • 集計対象の環境
    • prod: プロダクション環境
    • dev: 開発環境
  • 複数指定可能 ?env=prod&env=dev
  • 指定されない場合は全ての環境について収集します
since
required
string <date-time>
  • 集計範囲の開始時刻 (ISO8601 拡張形式)
  • UTC 指定の例
    • 2021-01-01T00:00:00Z
  • JST 指定の例
    • 2021-01-01T09:00:00+09:00
    • こちらの場合は値に対して URL エンコードが必要
until
required
string <date-time>
  • 集計範囲の終了時刻 (ISO8601 拡張形式)
  • UTC 指定の例
    • 2021-01-01T00:00:00Z
  • JST 指定の例
    • 2021-01-01T09:00:00+09:00
    • こちらの場合は値に対して URL エンコードが必要
starts_with
string
  • この値に前方一致する課金分類ラベルについてのみ結果を返却します
  • 指定されない場合は全ての課金分類ラベルについての結果を返却します

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

CostAndUsageResponse

Array of objects (CostAndUsage)
  • 料金・利用量オブジェクトのリスト
{
  • "results": [
    ]
}