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

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

メンテナンスウィンドウ

• 本機能について、毎週水曜日18:00-20:00をメンテナンスウィンドウといたします
• メンテナンスウィンドウ内でのメンテナンス実施の場合、事前通知はなく、メンテナンスの開始から終了までステータスダッシュボードに掲示いたします
  • 原則としてメール通知は行いません
• メンテナンスを実施しない場合は特に告知を行いません

共通仕様

• API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されます
• 本 API で取得されるデータの保証範囲について
  • 終了後 24 時間以上経過した RoomInstance について確定した値が算入されていることを保証します
• 指定時刻範囲について
  • RoomInstance の開始時刻が since 以降、until 未満のデータ、及び、その RoomInstance に付随する ConnectionInstance` のデータに対して集計が行われます
  • since で指定可能な時刻は、現在時刻から過去 1 年以内
  • until で指定可能な時刻は、since 以降 1 ヶ月以内
• approximate_total_cost および approximate_cost について
  • 単位は日本円 (JPY) です

料金・利用量の明細リストの各明細項目について

Base URLs:

• https://api.livestreaming.mw.smart-integration.ricoh.com/v1

Authentication

• HTTP Authentication, scheme: basic クライアント ID を username、クライアントシークレットを password にした Basic 認証

料金・利用量集計 API

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

Code samples

GET https://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/cost_and_usage/total?since=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z HTTP/1.1
Host: api.livestreaming.mw.smart-integration.ricoh.com
Accept: application/json

GET /clients/{client_id}/cost_and_usage/total

Parameters

Enumerated Values

Responses

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

Code samples

GET https://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/cost_and_usage/classification_labels/{classification_label}?since=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z HTTP/1.1
Host: api.livestreaming.mw.smart-integration.ricoh.com
Accept: application/json

GET /clients/{client_id}/cost_and_usage/classification_labels/{classification_label}

Parameters

Enumerated Values

Responses

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

Code samples

GET https://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/cost_and_usage/classification_labels?since=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z HTTP/1.1
Host: api.livestreaming.mw.smart-integration.ricoh.com
Accept: application/json

GET /clients/{client_id}/cost_and_usage/classification_labels

Parameters

Enumerated Values

Responses

Schemas

CostAndUsageResponse

料金・利用量 API のレスポンス

{
  "results": [
    {
      "classification_label": "string",
      "approximate_total_cost": 0,
      "items": [
        {
          "item_name": "string",
          "usage": 0,
          "approximate_cost": 0
        }
      ]
    }
  ]
}

Properties

CostAndUsage

料金・利用量オブジェクト

{
  "classification_label": "string",
  "approximate_total_cost": 0,
  "items": [
    {
      "item_name": "string",
      "usage": 0,
      "approximate_cost": 0
    }
  ]
}

Properties

oneOf

xor

CostAndUsageItem

明細項目の利用量及び料金

{
  "item_name": "string",
  "usage": 0,
  "approximate_cost": 0
}

Properties

HierarchicalCostAndUsageItem

料金形態が階層化された明細項目の利用量及び料金

{
  "item_name": "string",
  "sub_items": [
    {
      "item_name": "string",
      "usage": 0,
      "approximate_cost": 0
    }
  ]
}

Properties

Error

{
  "error_id": "string",
  "message": "string",
  "options": {}
}

Properties