API docs by Redocly

Equipmedia 各種API仕様 (1.0.0)

Download OpenAPI specification:Download

概要

本ドキュメントでは、Equipmedia（以下、EQ）が提供する各種APIの仕様について説明します。
各APIのリクエスト／レスポンス仕様やサンプルコードを掲載しており、EQと外部システムとの連携に必要な技術情報を確認できます。
なお、EQの機能概要や管理画面の操作方法については、Equipmedia カスタマーサイト をご覧ください。

ReadAPI

Read APIは、EQに登録された動画のメタ情報を取得するためのAPIです。
公開状態や登録日時などの条件を指定して動画を検索できるため、外部システムから動画情報の検索や一覧取得を行い、EQとのデータ連携に活用できます。

WriteAPI

Write APIは、EQに登録された動画コンテンツを管理するためのAPIです。
動画ファイルの登録、メタ情報の更新、動画の削除を行うことができます。
これにより、外部システムからEQ上の動画コンテンツの登録・更新・削除を自動的に実行できます。

Equipmedia 新EQライブ（v3）

本ドキュメントで説明するライブAPIは、新EQライブ（v3）のライブ配信を管理するためのAPIです。
ライブ配信設定の作成・更新・削除、ライブ配信の開始・停止、配信履歴の取得など、ライブ配信に関する各種操作を実行できます。
なお、本APIは旧EQライブ（v1）および新EQライブ（v2）のAPIとは仕様や構成が異なります。
また、ライブAPIにはRead API／Write APIの区分はありませんが、実行する操作に応じてRead API用トークンまたはWrite API用トークンを利用します。

動画視聴解析API

動画視聴解析APIは、新版動画視聴解析（新VA）で集計された動画の視聴データを取得するためのAPIです。
視聴回数、視聴時間などの集計データをはじめ、新VAの管理画面で確認できる各種視聴解析情報を取得できます。
取得したデータは、外部システムとの連携や独自レポートの作成、分析業務などに活用できます。

[留意事項]

  • ログイン有効時間は6時間です。
  • オンデマンド動画については、動画視聴後1～3時間程度で集計に反映されます。
    ※ユーザー別視聴解析のライブ配信及び疑似ライブ配信の場合は、配信完了後に集計を行うため、約3時間程度で集計に反映されます。
  • 対象データが多い場合は、レスポンスまでに時間がかかることがあります。
  • 従来の動画視聴解析（旧VA）ではご利用いただけません。
  • 新VAと旧VAでは値が異なる場合がございます。詳しくはこちらをご確認ください。

アップロードキー取得

アップロードキー取得

認証API以外の各 WriteAPI を利用する際に必要となる、アップロードキーを取得するための API です。
本 API を実行することで、一時的に有効なアップロードキーが発行されます。

本 API は契約会社IDおよび API トークンを用いた認証を行い、
発行されたアップロードキーは指定された WriteAPI の呼び出しに利用されます。

利用上の注意事項：

  • 発行されるアップロードキーの有効期限は 3 時間です。
  • 有効期限を過ぎたアップロードキーは使用できません。
  • 本 API は GET および POST の両メソッドに対応しています。
  • レスポンスは text/plain 形式で返却されます。
  • 認証に失敗した場合はアップロードキーは発行されません。

マニュアル

query Parameters
cid
required
integer

契約会社ID

API
required
string

WriteAPIトークン

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/WriteApiLocation.aspx?cid=&API='

ReadAPI

動画メタ情報取得API（getMediaByParam）

EQ でトランスコードされたすべての動画コンテンツを対象に、
指定した条件に一致する動画のメタ情報を一覧取得する ReadAPI です。
動画ID、任意ID、公開状態、APIリファレンスコード、日付条件、
および複数キーによるソート条件を組み合わせた柔軟な検索が可能です。

マニュアル

本 API は ReadAPI トークンによる認証を行い、
検索結果は JSON または JSONP 形式で返却されます。

利用上の注意事項：

  • 推奨されるリクエストメソッドは GET です。
  • POST メソッドでのリクエストは推奨外であり、
    正常に動作しない場合があります。
  • 検索結果はページング形式で返却され、
    1 リクエストあたりの取得件数には上限（最大 1000 件）があります。
  • 日付条件およびソート条件は、
    専用の指定方法に従って指定する必要があります。
  • 公開日が未設定の動画は、
    公開日が最も新しいものとして扱われます。
query Parameters
token
required
string

ReadAPIトークン

pageSize
integer <= 1000
Default: 10

取得件数（最大1000）

pageNumber
integer
Default: 1

取得開始ページ番号

mid
string

取得する動画ID
カンマ区切りで複数指定可能
JavaScript 利用時は配列で指定可能

optional_id
string

メタデータ編集で登録した任意ID
半角英数・ハイフン・アンダースコア、最大64桁

active_flg
string
Enum: "2" "1" "0" ""

公開可否
2：公開 & 公開期限内
1：公開
0：非公開
空欄：すべて

api_keywords
string

APIリファレンスコード
メタ情報のキーワード項目を検索する文字列を指定
指定した文字列による完全一致検索
複数文字列によるAND検索(;で区切る)とOR検索(|で区切る）が可能
AND検索：; 区切り
OR検索：| 区切り

type
string
Default: "jsonp"
Enum: "jsonp" "json"

返却形式（jsonp / json）

callback
string
Default: "searchResultEq"

JSONP コールバック関数名（jsonp 時のみ有効）

insert_date_from
string

登録日（from）YYYYMMDDhhmm

insert_date_to
string

登録日（to）YYYYMMDDhhmm

update_date_from
string

変更日（from）YYYYMMDDhhmm

update_date_to
string

変更日（to）YYYYMMDDhhmm

publication_date_from
string

公開開始日（from）YYYYMMDDhhmm

publication_date_to
string

公開開始日（to）YYYYMMDDhhmm

expiration_date_from
string

公開終了日（from）YYYYMMDDhhmm

expiration_date_to
string

公開終了日（to）YYYYMMDDhhmm

sort1_order
string
Default: "publication_date"

ソートキー1
publication_date / insert_date / update_date / day_count / week_count / month_count / custom_metadata1〜5

sort1_by
string
Default: "desc"
Enum: "asc" "desc"

ソート順1（asc / desc）

sort2_order
string
Default: "insert_date"

ソートキー2
publication_date / insert_date / update_date / day_count / week_count / month_count / custom_metadata1〜5

sort2_by
string
Default: "desc"
Enum: "asc" "desc"

ソート順2（asc / desc）

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getMediaByParam/?token='

Response samples

Content type
application/json
Example
{
  • "moviesum": "100",
  • "response_status": "2000",
  • "meta": [
    ]
}

サムネイル一覧取得

指定された動画IDに紐づくサムネイル情報を一覧で取得する ReadAPI です。
トランスコード時に自動生成されたサムネイルおよび、
アップロードされたサムネイルを含む全サムネイル情報を返却します。

マニュアル

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • ReadAPI トークンによる認証が必要です。
  • レスポンスは JSON または JSONP 形式で返却されます。
  • JSONP 利用時は指定したコールバック関数名でラップされます。
  • 値が存在しない要素はレスポンスに含まれません。
query Parameters
token
required
string

ReadAPIトークン

mid
required
string^\d+$

動画ID（半角数字）

type
string
Default: "jsonp"
Enum: "json" "jsonp"

返却形式（json / jsonp）

callback
string
Default: "searchResultEq"

JSONP コールバック関数名（type=jsonp の場合のみ有効）

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getThumbnailList?token=&mid='

Response samples

Content type
Example
{}

字幕一覧取得

指定された動画IDに登録されている字幕情報を一覧で取得する ReadAPI です。
字幕が未登録の場合や、字幕OFFのみが設定されている場合も、
現在の字幕設定状況に応じた情報が返却されます。

マニュアル

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • ReadAPI トークンによる認証が必要です。
  • レスポンスは JSON または JSONP 形式で返却されます。
  • JSONP 利用時は指定したコールバック関数名でラップされます。
  • 値が存在しない要素はレスポンスに含まれません。
query Parameters
token
required
string

ReadAPIトークン

mid
required
string^\d+$

動画ID（半角数字）

type
string
Default: "jsonp"
Enum: "json" "jsonp"

返却形式（json / jsonp）

callback
string
Default: "searchResultEq"

JSONP コールバック関数名（type=jsonp の場合のみ有効）

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getSubtitleList?token=&mid='

Response samples

Content type
Example
{
  • "response_status": "2000",
  • "subtitle_sum": 1,
  • "subtitle": [
    ]
}

利用状況取得

EQ にアップロードされた動画コンテンツ等を対象に、
ディスク使用総容量および配信総流量の利用状況を取得する ReadAPI です。
利用状況は月単位の集計値として返却され、
指定された年月または当月を含む過去分のデータを取得できます。

マニュアル

本 API は ReadAPI トークンによる認証が必要となり、
レスポンスは JSON または JSONP 形式で返却されます。

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • 利用状況データは月単位で取得されます。
  • 取得可能な期間は当月を含む過去 25 ヵ月分です。
  • 前日分までの容量および流量は、
    当日の 9～16 時頃までに集計結果へ反映されます。
  • 集計システムの仕様により、
    一度取得したデータであっても前月分の値が増加する場合があります。
query Parameters
token
required
string

ReadAPIトークン

date
string^\d{4}/\d{2}$

取得対象年月（yyyy/mm）。
未指定の場合は当月を含む過去 25 ヵ月分を取得します。

type
string
Default: "jsonp"
Enum: "json" "jsonp"

返却形式（json / jsonp）

callback
string
Default: "searchResultEq"

JSONP コールバック関数名（type=jsonp の場合のみ有効）

p1
string

任意パラメータ（レスポンスにそのまま返却）

p2
string

任意パラメータ（レスポンスにそのまま返却）

p3
string

任意パラメータ（レスポンスにそのまま返却）

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getUsage?token='

Response samples

Content type
Example
{
  • "response_status": "2000",
  • "cid": "***",
  • "company_name": "**********",
  • "usage": [
    ]
}

アップロード

動画アップロード（2GBまで）

動画ファイルをアップロードし、
コンテンツ登録およびトランスコード処理を行うための API です。
アップロード時に、動画ファイルとあわせて
タイトルや説明文などの各種メタ情報を同時に設定できます。

本 API は multipart/form-data による POST リクエストで実行され、
最大 2GB までの動画ファイルをアップロードすることが可能です。
アップロードされた動画は、
処理完了後に配信用コンテンツとして登録されます。

利用上の注意事項：

  • 本 API は POST メソッド専用です。
  • 動画ファイルは縦サイズ 240px 以上である必要があります。
  • サムネイルファイルは任意指定であり、
    未指定の場合は自動生成されます。
  • トランスコード完了時の callback 通知は、
    対応するパラメータを指定した場合のみ実行されます。
  • callback 通知が失敗した場合のリトライは 1 回のみ行われます。
  • 再生ドメイン・IP 視聴制限が有効な環境では、
    視聴制限プロファイルが登録されている場合のみ関連設定が有効となります。
  • 関連ページリンクを設定する場合は、
    対応する利用可否設定を有効にしたうえで、
    テキストと URL を同一番号のペアとして指定する必要があります。
  • 存在しないユーザーID、管理グループID、
    プレイリストID、またはメタデータテンプレートIDを指定した場合、
    アップロード処理はエラーとなります。
  • リクエストおよびレスポンスの文字コードは UTF-8 固定です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
movie
required
string <binary>

アップロードする動画ファイル（必須）。最大 2GB。
動画の縦サイズは 240px 以上である必要があります。

thumb
string <binary>

サムネイル画像（任意、2MB以下）。指定がない場合は自動生成（50%）。
許可拡張子: .gif, .jpeg, .jpg, .png

title
string <= 255 characters

動画タイトル（未指定時は動画ファイル名）

description
string <= 1000 characters

説明文（未指定時は空白）

keywords
string <= 1000 characters

キーワード（未指定時は空白）

copyright
string <= 1000 characters

権利者情報（未指定時は空白）

copyright_url
string <= 1000 characters

権利者情報に付けるURL（未指定時は空白）

optional_id
string <= 64 characters ^[A-Za-z0-9_-]{1,64}$

任意ID（半角英数・-・_、64桁まで）

publication_date
string

公開開始日時（未指定時は期限なし）。
許可書式: [yyyy-mm-dd] / [yyyy/mm/dd] / [yyyy-mm-dd hh:mm] / [yyyy/mm/dd hh:mm]

expiration_date
string

公開終了日時（未指定時は期限なし）。
許可書式: [yyyy-mm-dd] / [yyyy/mm/dd] / [yyyy-mm-dd hh:mm] / [yyyy/mm/dd hh:mm]

api_keywords
string <= 150 characters

APIリファレンスコード（任意）

active_flg
string
Default: "1"
Enum: "0" "1"

動画公開フラグ（1:公開 / 0:非公開）

security_id
string^\d+$

紐づける視聴制限プロファイルID（半角数）。
再生ドメイン・IP視聴制限が有効で、視聴制限プロファイルが登録されている場合のみ設定可能。

use_exlink
string
Default: "1"
Enum: "0" "1"

関連ページリンク使用可否（1:使用する / 0:使用しない）

exlink1_txt
string <= 100 characters

関連ページリンク（1）テキスト（exlink1_url とペア指定が必要）

exlink1_url
string <= 1000 characters

関連ページリンク（1）URL（exlink1_txt とペア指定が必要）

exlink2_txt
string <= 100 characters

関連ページリンク（2）テキスト（exlink2_url とペア指定が必要）

exlink2_url
string <= 1000 characters

関連ページリンク（2）URL（exlink2_txt とペア指定が必要）

exlink3_txt
string <= 100 characters

関連ページリンク（3）テキスト（exlink3_url とペア指定が必要）

exlink3_url
string <= 1000 characters

関連ページリンク（3）URL（exlink3_txt とペア指定が必要）

custom_metadata1
string <= 5000 characters
custom_metadata2
string <= 5000 characters
custom_metadata3
string <= 5000 characters
custom_metadata4
string <= 5000 characters
custom_metadata5
string <= 5000 characters
callback
string <= 500 characters

トランスコード完了時に通知するコールバックURL。
指定時のみ通知。タイムアウト時は1回リトライ（間隔15秒）。2回目以降の失敗は通知失敗。
POST パラメータ名は callback_json（JSON文字列）。

mail_to
string <= 255 characters

通知メールの送信先（セミコロン区切りで複数可）。
指定時のみトランスコード完了時（エラー含む）に送信。未指定時は管理画面のユーザー操作ログにエラーを記録。

mail_subject
string <= 255 characters

通知メールの件名

mail_body
string <= 1000 characters

通知メールの本文。以下の置換パラメータが使用可能:
・動画ID: %eqMailMid%
・エラーコード: %eqErrorCode%
・URL: %movie_permalink%
・タイトル: %title%

mail_contenttype
string <= 255 characters

通知メールのContent-Type

transcode_id
string^\d+$
Default: "1"

紐付けるトランスコード設定ID（半角数）

redirect_success
string <= 255 characters

成功時にリダイレクトするURL（302）。未指定の場合はリダイレクトなし。

redirect_failure
string <= 255 characters

失敗時にリダイレクトするURL（302）。未指定の場合はリダイレクトなし。

user_id
string^\d+$

ユーザーID（半角数）。存在しないユーザーIDを指定した場合はエラー。

group_id
string^\d+(;\d+)*$

管理グループID（半角数; セミコロン区切り）。
存在しない、または権限の無いグループIDを指定した場合はエラー。

playlist_id
string^\d+(;\d+)*$

プレイリストID（半角数; セミコロン区切り）。
存在しない、または指定グループに紐づかないIDを指定した場合はエラー。

meta_template_id
string^\d+$

メタデータテンプレートID（半角数）。存在しない場合はエラー。

Responses

Callbacks

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/upload/{uploadKey}' \
--request POST \
--header 'Content-Type: multipart/form-data' \
--form 'movie=' \
--form 'thumb=' \
--form 'title=' \
--form 'description=' \
--form 'keywords=' \
--form 'copyright=' \
--form 'copyright_url=' \
--form 'optional_id=' \
--form 'publication_date=' \
--form 'expiration_date=' \
--form 'api_keywords=' \
--form 'active_flg=1' \
--form 'security_id=' \
--form 'use_exlink=1' \
--form 'exlink1_txt=' \
--form 'exlink1_url=' \
--form 'exlink2_txt=' \
--form 'exlink2_url=' \
--form 'exlink3_txt=' \
--form 'exlink3_url=' \
--form 'custom_metadata1=' \
--form 'custom_metadata2=' \
--form 'custom_metadata3=' \
--form 'custom_metadata4=' \
--form 'custom_metadata5=' \
--form 'callback=' \
--form 'mail_to=' \
--form 'mail_subject=' \
--form 'mail_body=' \
--form 'mail_contenttype=' \
--form 'transcode_id=1' \
--form 'redirect_success=' \
--form 'redirect_failure=' \
--form 'user_id=' \
--form 'group_id=' \
--form 'playlist_id=' \
--form 'meta_template_id='

Response samples

Content type
application/json
{
  • "message": "transcode processing",
  • "mid": 1905,
  • "progress": 0,
  • "play_speed": 1,
  • "error_code": 0
}

チャンクアップロード

【利用時の制限事項】
以下の制限事項を必ずお読みいただき、ご理解の上、ご利用ください。

  1. アップロード可能なファイル容量は契約内容により制限されます。
    （Business ：4GB、Expert：８GB、Enterprise：12GB）
    ※エディションの上限を超える容量のファイルのアップロードをご希望の場合は、弊社担当営業へご相談ください。
  2. 推奨分割サイズ：100MB～512MB
  3. アップロードの有効期限は、「チャンクアップロード開始API」実行時から12時間後までとなります。
  4. 「チャンクアップロード開始API」で指定できるチャンクファイルの総数には、上限がございます。
    （Business ：4GB・・・40ファイル、Expert：8GB・・・80ファイル、Enterprise：12GB・・・120ファイル）
  5. ファイル名には、以下の制限がございます。
    ・200文字まで
    ・ /　:　*　?　“　<　>　の半角記号は使用不可
  6. 1契約会社ID（1CID）あたりの最大同時接続数は30となります。

チャンクアップロード開始（POST）

分割された動画ファイルを1つのアップロード対象として扱うためのチャンクキーを生成する API です。
指定されたチャンクファイル数およびファイル名に基づき、
チャンクアップロード全体を識別するためのキー情報を取得することができます。

本 API はアップロードキーを用いて実行され、
後続のチャンクアップロード処理および結合処理において使用される
チャンクキーおよびアップロード有効期限が返却されます。

利用上の注意事項：

  • 本 API は POST または GET メソッドで利用可能です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • チャンクファイル数にはプランごとの上限があります。
  • ファイル名には拡張子を必ず指定する必要があります。
  • 指定可能な拡張子以外を使用した場合、後続の処理でエラーとなる可能性があります。
  • ファイル名には使用できない文字が存在します。
  • 不正なパラメータが指定された場合、チャンクキーは発行されません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: application/x-www-form-urlencoded
chunk_count
required
integer >= 1

チャンクファイルの総数（半角数）。

file_name
required
string <= 200 characters

結合後の動画ファイル名（拡張子必須、全角半角200文字まで）。
拡張子未指定の場合、後続のトランスコードでエラーとなります。
有効拡張子：.f4v, .m2ts, .m2t, .ts, .mp4, .m4v, .mpg, .mpeg, .mov, .aac, .m4a。

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/chunk/begin/{uploadKey}' \
--request POST \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'chunk_count=' \
--data-urlencode 'file_name='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK",
  • "chunk_key": "abc123xyz",
  • "upload_expiration_date": "2026-06-04 23:59:59"
}

チャンクアップロード（multipart）

分割されたチャンクファイルをアップロードするための API です。
指定されたチャンクキーおよびチャンク番号に基づき、
分割された動画ファイルを順次アップロードすることができます。

本 API はアップロードキーを用いて実行され、
チャンクアップロード開始APIで取得したチャンクキーを利用して
複数のチャンクファイルを順次登録するために使用されます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • チャンクキーは事前にチャンクアップロード開始APIで発行する必要があります。
  • チャンク番号は開始時に指定した総チャンク数の範囲内で指定する必要があります。
  • アップロードは有効期限内に完了する必要があります。
  • アップロード可能な状態のステータスでのみ処理が受け付けられます。
  • 不正なパラメータまたは状態で実行した場合、アップロードは受け付けられません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
chunk_key
required
string

チャンクキー（各APIで用いる識別キー、半角）。

chunk_no
required
integer >= 1

チャンクの順序番号（半角数）。

chunk_file
required
string <binary>

アップロード対象のチャンクファイル（分割した動画の一片）。

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/chunk/upload/{uploadKey}' \
--request POST \
--header 'Content-Type: multipart/form-data' \
--form 'chunk_key=' \
--form 'chunk_no=' \
--form 'chunk_file='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK",
  • "status": 0
}

チャンクアップロード状況取得（GET）

チャンクアップロードの進行状況を取得するための API です。
指定されたチャンクキーに紐づくアップロード状態や、
既にアップロードが完了しているチャンク番号の一覧を取得することができます。

本 API はアップロードキーを用いて実行され、
チャンクアップロード処理の進捗確認や再送制御、状態監視の用途で利用されます。

利用上の注意事項：

  • 本 API は GET または POST メソッドで利用可能です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • チャンクキーはチャンクアップロード開始APIで発行されたものを指定する必要があります。
  • アップロードステータスに応じて取得可能な情報が変化します。
  • アップロード有効期限を過ぎた場合、アップロード処理は継続できません。
  • 不正なパラメータが指定された場合、状態情報は取得されません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

query Parameters
chunk_key
required
string

チャンクキー（各APIで用いる識別キー、半角）。

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/chunk/status/{uploadKey}?chunk_key='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK",
  • "status": 1,
  • "done_chunk_no": [
    ],
  • "upload_expiration_date": "2026-06-04 23:59:59"
}

チャンクアップロード完了（結合・登録・通知）

チャンクアップロード処理を完了し、分割されたチャンクファイルの結合および
トランスコード処理の登録を行うための API です。
指定されたチャンクキーに基づき、アップロード済みのチャンクファイルを統合し、
動画として登録および非同期のトランスコード処理を開始します。

本 API はアップロードキーを用いて実行され、
必要に応じて動画のメタ情報や公開設定、通知設定を同時に登録することが可能です。
また、処理完了後にコールバック通知やメール通知、リダイレクト処理を行うことができます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • チャンクキーは事前にチャンクアップロード開始APIで発行されたものを指定する必要があります。
  • すべてのチャンクファイルが正常にアップロードされている必要があります。
  • チャンクファイルに欠番がある場合や総数が一致しない場合はエラーとなります。
  • トランスコード処理は非同期で実行されます。
  • コールバックやメール通知は指定された場合のみ実行されます。
  • 不正なパラメータまたは状態で実行された場合、処理は実行されません。
path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
chunk_key
required
string

チャンクキー（各APIで用いる識別キー、半角）。

file_hash
string <= 32 characters

分割前ファイルの MD5 ハッシュ（任意）。指定時は結合後との整合を検証。

chunk_count
integer >= 1

チャンクファイル総数（任意再指定）。begin での指定値と一致が必要。

thumb
string <binary>

サムネイル（任意、2MB 以下）。拡張子：.gif/.jpeg/.jpg/.png。未指定時は自動生成（50%）。

title
string <= 255 characters

タイトル（既定は file_name ※begin 時のファイル名）。

description
string <= 1000 characters

説明文。

keywords
string <= 1000 characters

キーワード。

copyright
string <= 1000 characters

権利者情報。

copyright_url
string <= 1000 characters

権利者情報URL。

optional_id
string <= 64 characters ^[A-Za-z0-9_-]{1,64}$

任意ID（半角英数・-・_、64 桁まで）。

publication_date
string

公開開始日時（yyyy-mm-dd / yyyy/mm/dd / yyyy-mm-dd hh:mm / yyyy/mm/dd hh:mm）。

expiration_date
string

公開終了日時（yyyy-mm-dd / yyyy/mm/dd / yyyy-mm-dd hh:mm / yyyy/mm/dd hh:mm）。

api_keywords
string <= 150 characters

API リファレンスコード。

active_flg
string
Default: "1"
Enum: "0" "1"

公開フラグ（1:公開 / 0:非公開）。

security_id
string^\d+$

視聴制限プロファイルID（半角数）。条件を満たす場合のみ設定可。

use_exlink
string
Default: "1"
Enum: "0" "1"

関連ページリンク使用可否。

exlink1_txt
string <= 100 characters

関連ページリンク（1）テキスト（URL とペア必須）。

exlink1_url
string <= 1000 characters

関連ページリンク（1）URL（テキストとペア必須）。

exlink2_txt
string <= 100 characters

関連ページリンク（2）テキスト（URL とペア必須）。

exlink2_url
string <= 1000 characters

関連ページリンク（2）URL（テキストとペア必須）。

exlink3_txt
string <= 100 characters

関連ページリンク（3）テキスト（URL とペア必須）。

exlink3_url
string <= 1000 characters

関連ページリンク（3）URL（テキストとペア必須）。

custom_metadata1
string <= 5000 characters
custom_metadata2
string <= 5000 characters
custom_metadata3
string <= 5000 characters
custom_metadata4
string <= 5000 characters
custom_metadata5
string <= 5000 characters
callback
string <= 5000 characters

トランスコード完了時の Callback URL（指定時のみ通知、1 回リトライ・間隔 15 秒）。

callback_failure
string <= 5000 characters

分割アップロード失敗時の Callback URL（指定時のみ通知、1 回リトライ・間隔 15 秒）。

mail_to
string <= 255 characters

完了通知の送信先メールアドレス（複数はセミコロン区切り）。

mail_subject
string <= 255 characters

完了通知の件名。

mail_body
string <= 1000 characters

完了通知の本文。使用可能置換：%eqMailMid% / %eqErrorCode% / %movie_permalink% / %title%。
例：
トランスコード処理が完了しました。
mid:%eqMailMid%
error:%eqErrorCode%

mail_contenttype
string <= 255 characters

通知メールの Content-Type（完了／エラー共通）。

mail_to_failure
string <= 255 characters

エラー通知の送信先メールアドレス（複数はセミコロン区切り）。

mail_subject_failure
string <= 255 characters

エラー通知の件名。

mail_body_failure
string <= 1000 characters

エラー通知の本文。使用可能置換：%eqChunkKey% / %eqErrorCode%。
例：
チャンク完了処理が失敗しました。
chunk_key:%eqChunkKey%
error:%eqErrorCode%

transcode_id
string^\d+$
Default: "1"

紐付けるトランスコード設定ID（半角数）。

redirect_success
string <= 255 characters

成功時のリダイレクトURL（失敗時にも本URLにリダイレクトされる仕様）。

redirect_failure
string <= 255 characters

失敗時のリダイレクトURL。

user_id
string^\d+$

ユーザーID（半角数）。

playlist_id
string^\d+$

プレイリストID（半角数）。

group_id
string^\d+$

管理グループID（半角数）。

meta_template_id
string^\d+$

メタデータテンプレートID（半角数）。

Responses

Callbacks

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/chunk/complete/{uploadKey}' \
--request POST \
--header 'Content-Type: multipart/form-data' \
--form 'chunk_key=' \
--form 'file_hash=' \
--form 'chunk_count=' \
--form 'thumb=;type=image/jpeg, image/png, image/gif' \
--form 'title=' \
--form 'description=' \
--form 'keywords=' \
--form 'copyright=' \
--form 'copyright_url=' \
--form 'optional_id=' \
--form 'publication_date=' \
--form 'expiration_date=' \
--form 'api_keywords=' \
--form 'active_flg=1' \
--form 'security_id=' \
--form 'use_exlink=1' \
--form 'exlink1_txt=' \
--form 'exlink1_url=' \
--form 'exlink2_txt=' \
--form 'exlink2_url=' \
--form 'exlink3_txt=' \
--form 'exlink3_url=' \
--form 'custom_metadata1=' \
--form 'custom_metadata2=' \
--form 'custom_metadata3=' \
--form 'custom_metadata4=' \
--form 'custom_metadata5=' \
--form 'callback=' \
--form 'callback_failure=' \
--form 'mail_to=' \
--form 'mail_subject=' \
--form 'mail_body=' \
--form 'mail_contenttype=' \
--form 'mail_to_failure=' \
--form 'mail_subject_failure=' \
--form 'mail_body_failure=' \
--form 'transcode_id=1' \
--form 'redirect_success=' \
--form 'redirect_failure=' \
--form 'user_id=' \
--form 'playlist_id=' \
--form 'group_id=' \
--form 'meta_template_id='

Response samples

Content type
application/json
{
  • "message": "transcode processing",
  • "mid": 1905,
  • "progress": 0,
  • "play_speed": 1,
  • "error_code": 0
}

メタ情報編集

メタ情報編集

アップロード済みの動画コンテンツに対してメタ情報を更新するための API です。
指定された動画IDに紐づくタイトルや説明、公開設定、関連リンクなどの
各種メタ情報を変更することができます。

本 API はアップロードキーを用いて実行され、
動画の公開状態や付加情報を運用中に柔軟に更新する用途で利用されます。

利用上の注意事項：

  • 本 API は POST メソッド（application/x-www-form-urlencoded）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • 動画IDには既にアップロード済みの動画を指定する必要があります。
  • 各種メタ情報は任意で指定可能ですが、条件や組み合わせにより制限があります。
  • 関連リンク設定を利用する場合は、対応するフラグおよびペアのパラメータ指定が必要です。
  • 視聴制限プロファイルは有効な設定が存在する場合のみ指定可能です。
  • 不正なパラメータが指定された場合、メタ情報の更新は行われません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: application/x-www-form-urlencoded
mid
required
string^\d+$

動画ID（必須）

title
string <= 255 characters

動画タイトル（未指定時は動画ファイル名）

description
string <= 1000 characters

説明文（未指定時は空白）

keywords
string <= 1000 characters

キーワード（未指定時は空白）

copyright
string <= 1000 characters

権利者情報（未指定時は空白）

copyright_url
string <= 1000 characters

権利者情報に付けるリンクURL（未指定時は空白）

optional_id
string <= 64 characters ^[A-Za-z0-9_-]{1,64}$

任意ID（半角英数・-・_、64桁まで）

publication_date
string

公開開始日／日時（[yyyy-mm-dd] / [yyyy/mm/dd] / [yyyy-mm-dd hh:mm] / [yyyy/mm/dd hh:mm]）

expiration_date
string

公開終了日／日時（[yyyy-mm-dd] / [yyyy/mm/dd] / [yyyy-mm-dd hh:mm] / [yyyy/mm/dd hh:mm]）

api_keywords
string <= 150 characters

APIリファレンスコード（任意）

active_flg
string
Default: "1"
Enum: "0" "1"

動画公開フラグ（1:公開 / 0:非公開）

security_id
string^\d+$

紐づける視聴制限プロファイルID（半角数）。
再生ドメイン・IP視聴制限が有効でプロファイルが登録されている場合のみ設定可能。

use_exlink
string
Default: "1"
Enum: "0" "1"

関連ページリンク使用可否（1:使用する / 0:使用しない）

exlink1_txt
string <= 100 characters

関連ページリンク（1）リンクテキスト（exlink1_url とペア必須）

exlink1_url
string <= 1000 characters

関連ページリンク（1）リンクURL（exlink1_txt とペア必須）

exlink2_txt
string <= 100 characters

関連ページリンク（2）リンクテキスト（exlink2_url とペア必須）

exlink2_url
string <= 1000 characters

関連ページリンク（2）リンクURL（exlink2_txt とペア必須）

exlink3_txt
string <= 100 characters

関連ページリンク（3）リンクテキスト（exlink3_url とペア必須）

exlink3_url
string <= 1000 characters

関連ページリンク（3）リンクURL（exlink3_txt とペア必須）

custom_metadata1
string <= 5000 characters

カスタムメタデータの値（1）

custom_metadata2
string <= 5000 characters

カスタムメタデータの値（2）

custom_metadata3
string <= 5000 characters

カスタムメタデータの値（3）

custom_metadata4
string <= 5000 characters

カスタムメタデータの値（4）

custom_metadata5
string <= 5000 characters

カスタムメタデータの値（5）

thumbnail_id
string^\d+$

サムネイルID（半角数）

devices_quality_id
string^\d+$

デバイス別画質設定プロファイルID（半角数）

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/metaedit/{uploadKey}' \
--request POST \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'mid=' \
--data-urlencode 'title=' \
--data-urlencode 'description=' \
--data-urlencode 'keywords=' \
--data-urlencode 'copyright=' \
--data-urlencode 'copyright_url=' \
--data-urlencode 'optional_id=' \
--data-urlencode 'publication_date=' \
--data-urlencode 'expiration_date=' \
--data-urlencode 'api_keywords=' \
--data-urlencode 'active_flg=1' \
--data-urlencode 'security_id=' \
--data-urlencode 'use_exlink=1' \
--data-urlencode 'exlink1_txt=' \
--data-urlencode 'exlink1_url=' \
--data-urlencode 'exlink2_txt=' \
--data-urlencode 'exlink2_url=' \
--data-urlencode 'exlink3_txt=' \
--data-urlencode 'exlink3_url=' \
--data-urlencode 'custom_metadata1=' \
--data-urlencode 'custom_metadata2=' \
--data-urlencode 'custom_metadata3=' \
--data-urlencode 'custom_metadata4=' \
--data-urlencode 'custom_metadata5=' \
--data-urlencode 'thumbnail_id=' \
--data-urlencode 'devices_quality_id='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK"
}

サムネイル変更

アップロード済みの動画コンテンツに対してサムネイル画像を変更するための API です。
指定された動画IDに紐づくサムネイルを、任意の画像ファイルに更新することができます。

本 API はアップロードキーを用いて実行され、
動画の表示用サムネイルを差し替える用途で利用されます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • 動画IDには既にアップロード済みの動画を指定する必要があります。
  • サムネイル画像は指定可能なファイル形式およびサイズ制限内で指定する必要があります。
  • 不正なパラメータが指定された場合、サムネイルの変更は行われません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
mid
required
string^\d+$

動画ID（必須）

thumb
required
string <binary>

サムネイルファイル（必須、2MB 以下）。
許可拡張子：.gif / .jpeg / .jpg / .png

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/thumbup/{uploadKey}' \
--request POST \
--header 'Content-Type: multipart/form-data' \
--form 'mid=' \
--form 'thumb=;type=image/gif, image/jpeg, image/png'

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK"
}

ステータス確認（GET）

動画コンテンツに対する各種API処理の進捗状況を取得するための API です。
指定された動画IDに紐づくトランスコード処理やアップロード後の状態を確認することができます。

本 API はアップロードキーを用いて実行され、
状態確認に加えて、指定に応じてコールバック通知やメール通知の設定を上書きすることが可能です。
また、コールバックURLが指定された場合、処理完了時に即座に通知が実行される仕組みとなります。

利用上の注意事項：

  • 本 API は GET または POST メソッドで利用可能です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • 動画IDには既にアップロード済みの動画を指定する必要があります。
  • トランスコード処理が未完了の場合は、コールバック通知は実行されません。
  • コールバックおよびメール通知の指定は、既存設定を上書きします。
  • 不正なパラメータが指定された場合、状態の取得は行われません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

query Parameters
mid
required
string^\d+$

動画ID（必須）

callback
string <= 500 characters

完了通知を行う callback URL（任意）。
指定時はリクエスト直後に完了通知を試行します。

mail_to
string <= 255 characters

完了通知メールの送信先メールアドレス

mail_subject
string <= 255 characters

メール件名（未指定時：トランスコード終了）

mail_body
string <= 1000 characters

メール本文。以下の置換パラメータが使用可能です。
・動画ID：%eqMailMid%
・エラーコード：%eqErrorCode%

mail_contenttype
string <= 255 characters

メールの Content-Type

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/status/{uploadKey}?mid='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "processing"
}

動画削除（POST）

アップロード済みの動画コンテンツを削除するための API です。
指定された動画IDに紐づく動画データおよび関連情報を削除し、
コンテンツとして利用できない状態にします。

本 API はアップロードキーを用いて実行され、
動画コンテンツの管理や不要データの整理を行う用途で利用されます。

利用上の注意事項：

  • 本 API は GET または POST メソッドで利用可能です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • 動画IDには既にアップロード済みの動画を指定する必要があります。
  • 削除された動画は元に戻すことができません。
  • 配信中や他機能で利用中の動画は削除できない場合があります。
  • 不正なパラメータが指定された場合、動画の削除は行われません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: application/x-www-form-urlencoded
mid
required
string^\d+$

動画ID（必須）

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/delete/{uploadKey}' \
--request POST \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'mid='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK"
}

字幕編集

字幕設定（新規作成／更新）

動画コンテンツに対する字幕情報を新規作成または更新するための API です。
指定された動画IDに紐づき、字幕ファイルや言語情報、表示順序などの設定を登録し、
動画に対する多言語字幕の管理を行うことができます。

本 API はアップロードキーを用いて実行され、
字幕IDの指定有無により新規作成または既存字幕の更新を行います。
また、言語コードやラベル設定により複数言語の字幕を管理することが可能です。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • 動画IDには既にアップロード済みの動画を指定する必要があります。
  • 字幕ファイルは対応する形式およびサイズ制限内で指定する必要があります。
  • 字幕IDを指定しない場合は新規作成、指定した場合は更新として処理されます。
  • 言語コードがカスタムの場合、ラベルの指定が必須となります。
  • 設定内容や既存データとの重複によりエラーとなる場合があります。
  • 不正なパラメータが指定された場合、字幕情報の登録または更新は行われません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
mid
required
string^\d+$

動画ID（必須）

stid
string^\d+$

字幕ID（更新時のみ指定）。
未指定の場合は新規作成となります。

lang_code
string <= 20 characters

言語コード（新規作成時は必須）。
言語対応表に存在しないコードはカスタム扱いとなります。

subtitle
string <binary>

字幕ファイル（必須）。

  • 拡張子：.vtt / .ttml
  • ファイル名：50文字以内（拡張子含む）
  • ファイルサイズ：50MB 以下
order
integer >= 2

表示順序（2以上の半角数）。
未指定時は既存の最大値で登録されます。

default
integer
Default: 0
Enum: 0 1

デフォルト字幕設定。
0：無効 / 1：デフォルト

lang_label
string <= 20 characters

表示ラベル。
lang_code がカスタムの場合は必須。
新規登録時、既定の言語コードに対応するデフォルトラベルで登録されます。

言語対応表

言語コード 言語選択 ラベル
de ドイツ語 German
en 英語 English
fr フランス語 French
ja 日本語 日本語
ko 韓国語 Korean
zh 中国語 Chinese
zh-Hans 中国語（簡体字） Chinese(Simplified)
zh-Hant 中国語（繁体字） Chinese(Traditional)
fil フィリピン語 Filipino
th タイ語 Thai
id インドネシア語 Indonesian
vi ベトナム語 Vietnamese
pt ポルトガル語 Portuguese
es スペイン語 Spanish
my ビルマ語 Burmese
it イタリア語 Italian

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/subtitleup/{uploadKey}' \
--request POST \
--header 'Content-Type: multipart/form-data' \
--form 'mid=' \
--form 'stid=' \
--form 'lang_code=' \
--form 'subtitle=;type=text/vtt, application/ttml+xml' \
--form 'order=' \
--form 'default=0' \
--form 'lang_label='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "updated subtitle"
}

字幕削除

動画コンテンツに紐づく字幕情報を削除するための API です。
指定された動画IDおよび字幕IDに対応する字幕データを削除し、
対象の字幕を動画から取り除くことができます。

本 API はアップロードキーを用いて実行され、
不要な字幕の削除や多言語字幕の管理を行う用途で利用されます。

利用上の注意事項：

  • 本 API は DELETE メソッド専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • 動画IDおよび字幕IDには既存のデータを指定する必要があります。
  • 削除された字幕は元に戻すことができません。
  • 不正なパラメータまたは存在しないIDが指定された場合、削除処理は実行されません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
mid
required
string^\d+$

動画ID（半角数、必須）

stid
required
string^\d+$

字幕ID（半角数、必須）

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/subtitleup/{uploadKey}' \
--request DELETE \
--header 'Content-Type: multipart/form-data' \
--form 'mid=' \
--form 'stid='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK"
}

ライブ配信準備

ライブプロファイル取得

ライブ配信に関するプロファイル設定情報を取得する API です。
登録されているライブプロファイルを対象に、
配信状態や基本設定などの情報を一覧で取得することができます。

本 API は ReadAPI トークンによる認証が必要となり、
条件指定により特定のライブプロファイルのみを取得することも可能です。
また、レスポンス内容には、指定条件に応じて
関連リンクやチャット設定、サムネイル情報などの付加情報が含まれる場合があります。

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • レスポンスは JSON または JSONP 形式で返却されます。
  • 一覧取得はページング形式で行われ、
    1 回のリクエストで取得できる件数には上限があります。
  • レスポンスに含まれるオブジェクトは、
    リクエスト時の指定条件に応じて内容が変動します。
  • 無効または不正なパラメータを指定した場合、
    エラーステータスが返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

type
string
Enum: "json" "jsonp"

レスポンス形式。json または jsonp
デフォルト値：json

callback
string

JSONP コールバック関数名（type=jsonp 時のみ有効）
デフォルト値：searchResultEq

pageSize
integer

取得件数（最大 100）
デフォルト値：10

pageNumber
integer

ページ番号（開始位置）
デフォルト値：1

lpid
string

ライブ設定 ID（複数指定はカンマ区切り）

liveName
string

ライブ設定名（部分一致）

status
string

ライブステータスでの絞り込み（例： creating, open, stop, error）

p1
string

指定の引数を戻り値としてそのまま返却

p2
string

指定の引数を戻り値としてそのまま返却

p3
string

指定の引数を戻り値としてそのまま返却

resObject
string

レスポンスのオブジェクト（複数指定はカンマ区切り)

  • livesum
  • permalink
  • exlink
  • chat
  • portal_meta
  • thumbnails

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/live/v1/profile/?token='

Response samples

Content type
application/json
Example
{}

ライブプロファイル作成更新API

ライブプロファイルの作成および更新を行うAPIです。

指定したライブ配信設定情報をもとにライブプロファイルを新規作成、または更新します。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • 新規作成時は name が必須です。
  • 更新時は lpid が必須です。
  • サムネイル画像は 2MB 以下の gif、jpeg、jpg、png ファイルのみ指定可能です。
  • chat_icon_text_flg[] と chat_icon_text[] の件数が一致しない場合はパラメータエラーとなります。
  • encrypt=1 を指定する場合は暗号配信機能が利用可能な契約である必要があります。
  • max_client に 0 を指定した場合は無制限となります（Unlimited Liveエディションのみ）。
  • standby_type に hot または auto を指定した場合は契約上限の制限を受けます。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
integer

ライブ設定 ID（更新時のみ指定、作成は空）

name
string <= 100 characters

ライブ設定名（新規作成時のみ必須。100文字まで）

description
string <= 500 characters

ライブ説明文（500文字まで）

group_id
integer

グループID

transcode_id
integer

トランスコードID
デフォルト値：デフォルトに指定したトランスコードID

max_client
integer

同時接続上限（0：無制限、その他の値：その値で制限）
デフォルト値：ライブの同時接続数上限
※Unlimited Liveエディションでのみ利用可、それ以外のエディションでは「0」を指定することは出来ません。

standby_type
string
Enum: "manual" "hot" "auto"

ライブ開始操作設定

  • manual：手動開始（通常）
  • hot：手動開始（即時）
  • auto：自動開始 デフォルトはmanual
liveapp_flg
integer
Enum: 0 1

ライブキャスト利用フラグ（0:利用しない、1:利用する）
デフォルト値：1

vod_flg
integer
Enum: 0 1

VOD利用フラグ（0:無効、1:有効）
デフォルト値：1

exlink_flg
integer
Enum: 0 1

関連リンク利用フラグ（0:利用しない、1:利用する）
デフォルト値：1

exlink1_txt
string

関連リンク1 テキスト（100文字）

exlink1_url
string <uri>

関連リンク1 URL（100文字）

exlink2_txt
string

関連リンク2 テキスト（100文字）

exlink2_url
string <uri>

関連リンク2 URL（100文字）

exlink3_txt
string

関連リンク3 テキスト（100文字）

exlink3_url
string <uri>

関連リンク3 URL（100文字）

vlp_id
integer

セキュリティプロファイル ID（デフォルト値：制限なし）

thumb_feedout
string <binary>

配信停止時サムネイル画像ファイル（2MB以下 *.gif; *.jpeg; *.jpg; *.png）

thumb_feedin
string <binary>

配信前サムネイル画像ファイル（2MB以下 *.gif; *.jpeg; *.jpg; *.png）

thumb_liveclose
string <binary>

配信終了時サムネイル画像ファイル（2MB以下 *.gif; *.jpeg; *.jpg; *.png）

chat_flg
integer
Enum: 0 1

チャット機能使用フラグ（0:利用しない、1:利用する）
デフォルト値：0

chat_auto_resize
integer
Enum: 0 1

チャット自動リサイズフラグ（0:無効、1:有効）
デフォルト値：0

chat_width
integer

チャットウィンドウ幅（300 ～ 1920）
デフォルト値：600

chat_height
integer

チャットウィンドウ高さ（320 ～ 1080）
デフォルト値：400

chat_block_type
integer
Enum: 0 1 2

チャットブロックタイプ（デフォルト値：0）

  • 0:メッセージを全て許可する
  • 1:不適切な可能性のあるメッセージを保留して確認する
  • 2:表示しない
chat_enter_msg
integer
Enum: 0 1 2

入退室メッセージ表示設定（デフォルト値：0）

  • 0:表示する
  • 1:入室メッセージのみ表示する
  • 2:表示しない
chat_open_timing
integer

チャット開始タイミング（分）（デフォルト値：0）

  • -1:手動で開始
  • 0:ライブ開始と同タイミング
chat_close_timing
integer

チャット終了タイミング（分）（デフォルト値：0）

  • -1:手動で終了
  • 0:ライブ終了と同タイミング
  • その他数値：ライブ終了後、○分後に終了
chat_icon_text_flg
Array of integers

リアクションボタンテキストフラグ配列（0:利用しない、1:利用する）
※ chat_icon_text[]と数が一致しない場合、パラメータエラーとなります。

chat_icon_text
Array of strings

リアクションボタンテキスト配列

chat_good_btn
integer
Enum: 0 1

「いいね」ボタン表示フラグ（0:無効、1:有効）
デフォルト値：1

chat_trouble_btn
integer
Enum: 0 1

「わかりません」ボタン表示フラグ（0:無効、1:有効）
デフォルト値：1

chat_display_name
string

管理者表示名（デフォルト値："admin"）

  • "admin":管理者
  • "operator":運営
  • "secretariat":事務局
  • "任意の15文字以内"
chat_block_words
string

ブロックする文字列（カンマ区切り）（1000文字）

desktop_encoder
integer
Enum: 0 1

デスクトップ配信利用設定（0:利用しない、1:利用する）
デフォルト値：0

lqpid
integer

ライブ自動画質設定ID（デフォルト値：ライブ自動画質設定のデフォルト）

dvr
integer
Enum: 0 1

DVR 機能設定（0:利用しない、1:利用する）
デフォルト値：0

dvr_close_minutes
integer

DVR 有効期間（分）（デフォルト値：1）

  • 0：利用しない
  • 1：即時無効化
  • その他数値：DVR有効時間（分）
encrypt
integer
Enum: 0 1

暗号配信設定（0:利用しない、1:利用する）
デフォルト値：0
※ 暗号化配信が利用可能なアカウント（cid）でない場合は「9021:パラメーターエラー」となります。

potal_meta_event_name
string

ライブイベント情報 - イベント名

potal_meta_event_description
string

ライブイベント情報 - イベント説明

potal_meta_performer
string

ライブイベント情報 - 出演者

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/setProfile/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=' \
  --form 'name=' \
  --form 'description=' \
  --form 'group_id=' \
  --form 'transcode_id=' \
  --form 'max_client=' \
  --form 'exlink1_txt=' \
  --form 'exlink1_url=' \
  --form 'exlink2_txt=' \
  --form 'exlink2_url=' \
  --form 'exlink3_txt=' \
  --form 'exlink3_url=' \
  --form 'vlp_id=' \
  --form 'thumb_feedout=' \
  --form 'thumb_feedin=' \
  --form 'thumb_liveclose=' \
  --form 'chat_width=' \
  --form 'chat_height=' \
  --form 'chat_open_timing=' \
  --form 'chat_close_timing=' \
  --form 'chat_display_name=' \
  --form 'chat_block_words=' \
  --form 'lqpid=' \
  --form 'dvr_close_minutes=' \
  --form 'potal_meta_event_name=' \
  --form 'potal_meta_event_description=' \
  --form 'potal_meta_performer='

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK",
  • "lpid": 1
}

ライブプロファイル削除API

ライブプロファイルの削除を行うAPIです。

指定したライブ設定IDのライブプロファイルを削除します。

利用上の注意事項：

  • 本APIは DELETE メソッド（application/json）専用です。
  • API実行にはアップロードキーが必要です。
  • 削除対象のライブ設定ID（lpid）の指定が必須です。
  • 削除済み、または存在しないライブ設定IDを指定した場合はエラーとなります。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: application/json
lpid
required
integer

ライブ設定ID（必須）

Responses

Request samples

Content type
application/json
{
  • "lpid": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

ライブエンコーダー設定取得API

ライブエンコーダー設定情報を取得するAPIです。

指定したライブ設定IDに紐付く配信設定情報を取得します。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • lpid の指定は必須です。
  • type を省略または json を指定した場合は JSON 形式で返却されます。
  • type に encorderText を指定した場合はライブエンコーダー設定テキストが返却されます。
  • wirecast、liveusolo、liveshell を指定した場合も encorderText と同様の内容が返却されます。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID（半角数字）（必須）

type
string
Enum: "json" "encorderText" "wirecast" "liveusolo" "liveshell"

取得するライブエンコーダー設定のフォーマット

  • "json": jsonフォーマット(デフォルト)
  • "encorderText“:ライブエンコーダー設定ダウンロードファイル(共通)（txt）

※互換性のため以下の値でも設定ファイルを取得可能ですが、取得できるファイルはencorderText指定時と同様のものです。

  • "wirecast":WireCastフォーマット
  • "liveusolo":LiveUSoloフォーマット
  • "liveshell":LiveShellフォーマット

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/getEncoder/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
{
  • "error_code": 0,
  • "message": "OK",
  • "lpid": "2",
  • "encoder_setting": {
    }
}

ライブ有効化API

ライブ配信の有効化を行うAPIです。

同じライブIDを続けて利用する際、エンコーダーからフィードを送出しても 接続できない場合があります。その際は本APIを実行後、再度フィードを送出してください。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • 本 API の実行タイミングは、
    ライブ配信の制御フローに従って行う必要があります。
  • ライブ設定ID（lpid）の指定が必須です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID

Responses

Request samples

Content type
multipart/form-data
{
  "lpid": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

ライブ配信中

m3u8取得API

ライブ配信のm3u8情報を取得するAPIです。

指定したライブIDに対して、配信URL、モニタリングURLおよび プレイヤー用のm3u8 URLを取得できます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • lpid の指定は必須です。
  • replacement_fqdn を指定すると、player_url のFQDN部分が指定した値に置換されます。
  • replacement_fqdn は253文字以内で指定してください。
  • replacement_fqdn に指定可能な文字は半角英数字、ハイフン(-)、ドット(.)です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定 ID

replacement_fqdn
string <= 253 characters

置換する FQDN 文字列（253文字、半角英数字、ハイフン（-）、ドット（.）のみ）

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/getPlaylist/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1' \
  --form 'replacement_fqdn='

Response samples

Content type
application/json
{}

ライブ開始API

ライブ配信の開始を行うAPIです。

ライブ設定IDを指定してライブ配信を開始します。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • lpid の指定は必須です。
  • event_name はライブ配信開始時のみ指定可能です。
  • ライブ配信中にイベント名を変更することはできません。
  • event_name が201文字以上の場合はエラーとなります。
  • ライブ開始時に error_code=9508 が返却された場合は、ライブ有効化APIを実行した後に再度開始してください。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID（半角数字）（必須）

event_name
string <= 200 characters

ライブイベント名

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/startLive/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1' \
  --form 'event_name='

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

ライブ停止API

ライブ配信を停止するための API です。
指定されたライブ設定に基づき、
配信中のライブストリームを停止します。

本 API はアップロードキーを用いて実行され、
ライブ配信の状態を「停止」に遷移させるために使用されます。

利用上の注意事項：

  • 本 API は POST メソッド専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • 配信中のライブに対して実行する必要があります。
  • 不正なパラメータが指定された場合、
    ライブ配信の停止処理は行われません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID（半角数字）（必須）

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/stopLive/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

チャット開始API

チャットの開始を行うAPIです。

本APIはチャットの開始タイミングを「手動」に設定している場合のみ利用可能です。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • lpid の指定は必須です。
  • チャット設定において開始タイミングが「手動」に設定されている必要があります。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID（半角数字）（必須）

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/startChat/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

チャット停止API

チャットの停止を行うAPIです。

本APIはチャットの停止タイミングを「手動」に設定している場合のみ利用可能です。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • lpid の指定は必須です。
  • チャット設定において停止タイミングが「手動」に設定されている必要があります。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID（半角数字）（必須）

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/stopChat/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

ライブ中イベント情報取得API

ライブ配信中にライブイベント情報の取得を行うAPIです。

指定したライブ設定IDの現在の配信状況、 チャット状態、視聴者数などの情報を取得できます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/getNowInfo/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK",
  • "lpid": 1,
  • "live_name": "テスト用ライブ配信設定",
  • "status": "open",
  • "chat_room_status": "stop",
  • "event_name": "テスト配信",
  • "recfile_cnt": 1,
  • "recfile_cnt_limit": 9,
  • "current_viewing_cnt": 0,
  • "max_viewing_cnt": 0,
  • "cumulative_cnt": 0,
  • "dvr_close_date": "2021-12-08T19:41:30.2930",
  • "onair_time": "2020/01/01 00:00:00"
}

ライブイベント名変更API

ライブ配信中にライブイベント名の変更を行うAPIです。

配信中のライブイベント名を動的に変更することができます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • lpid および event_name の指定は必須です。
  • event_name は200文字以内で指定してください。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID（半角数字）（必須）

event_name
required
string <= 200 characters

ライブイベント名

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/setEventName/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1' \
  --form 'event_name='

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

ライブ分割API

ライブ配信中に録画ファイルの分割を行うAPIです。

配信中の録画ファイルを任意のタイミングで分割することができます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • lpid の指定は必須です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID（半角数字）（必須）

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/live/v1/setExtension/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

ライブDVR停止API

ライブDVRの停止を行うAPIです。

ライブ配信中または配信終了後のDVR配信を停止することができます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • lpid の指定は必須です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブ設定ID（半角数字）（必須）

Responses

Request samples

Content type
multipart/form-data
{
  "lpid": 1
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

ライブ配信終了

ライブ履歴取得API

過去のライブ開催時の設定情報を取得できるAPIです。

指定した条件に一致するライブ開催履歴およびライブ開催時点の設定情報を取得できます。

利用上の注意事項：

  • 本APIはGETメソッドです。
  • ReadAPIトークンが必要です。
  • lpidはカンマ区切りで複数指定可能です。
  • eventDateFromは26ヶ月以前の日付を指定できません。
  • resObjectで指定したオブジェクトのみ追加返却されます。
  • resObjectに不正な値を指定した場合はエラーコード1037が返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

type
string
Enum: "jsonp" "json"

返却形式のタイプを指定。「jsonp」「json」が指定可能

callback
string

JSONP コールバック関数名（jsonp 時のみ）

pageSize
integer <= 100
Default: 10

1ページあたりの取得件数（最大100件）

pageNumber
integer
Default: 1

取得するページ番号（1開始）

lpid
string

ライブプロファイルID。複数指定する場合はカンマ区切りで指定。

eventDateFrom
string

取得するライブの開催日期間：開始 ※26ヶ月以前は指定不可（エラーコード：1026）

eventDateTo
string

取得するライブの開催日期間：終了

liveName
string

ライブ設定名（部分一致）

eventName
string

ライブイベント名（部分一致）

p1
string

任意パラメータ1（指定の引数を戻り値としてそのまま返却）

p2
string

任意パラメータ2（指定の引数を戻り値としてそのまま返却）

p3
string

任意パラメータ3（指定の引数を戻り値としてそのまま返却）

resObject
string

レスポンスのオブジェクト（複数指定はカンマ区切り)

  • livesum
  • exlink
  • chat
  • portal_meta

※上記以外の文字列の場合は、エラーコード（1037：resObjectが不正）を返却

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/live/v1/profile/arch/?token='

Response samples

Content type
application/json
Example
{
  • "response_status": "2000",
  • "livesum": 1,
  • "events": [
    ]
}

ライブ同時接続履歴取得API

過去のライブ開催時の同時接続履歴を取得できるAPIです。

指定したライブイベントIDの同時接続数履歴を取得できます。

利用上の注意事項：

  • 本APIはGETメソッドです。
  • ReadAPIトークンが必要です。
  • ライブイベントID（lplid）の指定は必須です。
  • ライブ停止前は取得できません。
  • DVRを設定しているライブの場合はDVR終了後に取得可能となります。
  • エラー時はHTTPステータス404が返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

lplid
required
string
Example: lplid=12-3

ライブイベントID。
半角数-半角数形式で指定（例：12-3）。

type
string
Default: "file"
Enum: "text" "file"

ダウンロードタイプ。
text または file を指定可能。未指定時は file。

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getLiveConnectionArch?token=&lplid=12-3'

Response samples

Content type
text/plain
"2022-07-01 17:20:00",0
"2022-07-01 17:20:30",0
"2022-07-01 17:21:00",0
"2022-07-01 17:21:30",1
"2022-07-01 17:22:00",1
"2022-07-01 17:22:30",1
"2022-07-01 17:23:00",1
"2022-07-01 17:23:30",1
"2022-07-01 17:24:00",1
累計視聴者数,1

ライブチャット投稿履歴取得API

過去のライブ開催時のライブチャット履歴を取得できるAPIです。

指定したライブイベントIDのチャット投稿履歴を取得できます。

利用上の注意事項：

  • 本APIはGETメソッドです。
  • ReadAPIトークンが必要です。
  • ライブイベントID（lplid）の指定は必須です。
  • 本APIはチャット終了前には取得できません。
  • エラー時はHTTPステータス404が返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

lplid
required
string
Example: lplid=12-3

ライブイベントID。
半角数-半角数形式で指定（例：12-3）。

type
string
Default: "file"
Enum: "text" "file"

ダウンロードタイプ。
text または file を指定可能。未指定時は file。

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getLiveChatMsgArch?token=&lplid=12-3'

Response samples

Content type
text/plain
number,delete,time,soket_id,name,message
1,false,2019/06/17 15:48:54,master,システム,【○○】さんが入室しました
2,false,2019/06/17 15:49:05,master,システム,【aaa】さんが入室しました
3,true,2019/06/17 15:49:27,HUHHi_dXv0MbyMBBAAAC,○○,△△部の○○開いてます。
4,false,2019/06/17 15:49:47,master,システム,【○○】さんが退室しました
5,false,2019/06/17 15:51:15,master,システム,【テストです】さんが入室しました
6,true,2019/06/17 15:51:28,ZF_b0ZXgHScWrAUIAAAE,テストです,テストです
7,true,2019/06/17 15:51:32,ZF_b0ZXgHScWrAUIAAAE,テストです,:trouble:よくわかりません。
8,true,2019/06/17 15:52:09,W8iS8tD8piUyaur4AAAF,aaa,EQライブプレイヤーのサイズをレスポンシブ設定にしておくと、チャットを含んだ画面が使いやすくなりますよ。
9,true,2019/06/17 15:52:28,ZF_b0ZXgHScWrAUIAAAE,テストです,:nice:いいね！しました。
10,false,2019/06/17 15:52:33,master,システム,【aaa】さんが退室しました

疑似ライブ配信準備

疑似ライブフィラー利用動画一覧取得API

疑似ライブに利用できるフィラー動画を一覧で取得するAPIです。

フィラー映像として利用可能な動画を検索および取得できます。
フィラー映像の注意事項等は疑似ライブ配信のフィラー映像設定をご確認ください。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • mid の指定は必須です。
  • pageSize の上限は1000です。
  • フィラー映像の利用条件については疑似ライブ配信のフィラー映像設定をご確認ください。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
mid
required
integer

本編動画ID（必須）

pageSize
integer <= 1000

取得件数（デフォルト値：100）

pageNumber
integer

ページ番号（デフォルト値：1）

search_filler_mid
integer

検索する動画ID

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/filetolive/v1/getFillerList/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'mid=1' \
  --form 'pageSize=' \
  --form 'pageNumber=' \
  --form 'search_filler_mid='

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK",
  • "sum": 1,
  • "movies": [
    ]
}

疑似ライブ利用動画一覧取得API

疑似ライブに利用できる動画を一覧で取得するAPIです。

指定した条件に一致する疑似ライブ利用可能動画を取得できます。 利用できない動画の条件等は疑似ライブ配信設定の新規登録をご確認ください。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • pageSize の上限は1000です。
  • 利用できない動画の条件については疑似ライブ配信設定の新規登録をご確認ください。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
pageSize
integer <= 1000
Default: 100

取得件数（最大1000）。
未指定時は100。

pageNumber
integer
Default: 1

取得を開始するページ番号（1開始）。

mid
integer

検索する動画ID

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/filetolive/v1/getMediaList/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'pageSize=100' \
  --form 'pageNumber=1' \
  --form 'mid='

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK",
  • "sum": 1,
  • "movies": [
    ]
}

疑似ライブプロファイル取得API

疑似ライブプロファイルの設定情報を取得するAPIです。

指定した条件に一致する疑似ライブプロファイルの情報を取得できます。

利用上の注意事項：

  • 本APIはGETメソッドです。
  • ReadAPIトークンが必要です。
  • flpidはカンマ区切りで複数指定可能です。
  • liveNameは部分一致で検索されます。
  • resObjectで指定したオブジェクトのみ追加返却されます。
  • resObjectに不正な値を指定した場合はエラーコード1037が返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

type
string
Default: "json"
Enum: "jsonp" "json"

返却形式（jsonp / json）

callback
string
Default: "searchResultEq"

JSONP コールバック関数名（jsonp 時のみ有効）

pageSize
integer <= 100
Default: 10

取得件数（最大100）

pageNumber
integer
Default: 1

取得開始ページ番号

flpid
string

取得する疑似ライブ設定ID。
カンマ区切りで複数指定可能。

liveName
string

疑似ライブ設定名（部分一致）

status
string
Enum: "waiting" "ready" "streaming" "finished" "error"

疑似ライブステータス

  • waiting：配信予約中
  • ready：配信準備中
  • streaming：配信中
  • finished：配信終了
  • error：エラー
p1
string

任意パラメータ1（そのまま返却）

p2
string

任意パラメータ2（そのまま返却）

p3
string

任意パラメータ3（そのまま返却）

resObject
string

レスポンスのオブジェクト（複数指定はカンマ区切り)

  • livesum
  • permalink
  • chat
  • portal_meta
  • thumbnails
  • media_meta
  • media_thumbnails

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/filetolive/v1/profile?token='

Response samples

Content type
application/json
Example
{}

疑似ライブプロファイル作成更新API

疑似ライブプロファイルの作成および更新を行うAPIです。

配信スケジュール、利用動画、チャット設定、サムネイル設定などを指定して、 疑似ライブプロファイルを新規作成または更新できます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • 新規作成時は mid、start_date、name が必須です。
  • 更新時は flpid の指定が必須です。
  • start_date は現在時刻から30分後以降の日時を指定する必要があります。
  • pageSize の上限はありません。
  • サムネイル画像は 2MB 以下の gif、jpeg、jpg、png ファイルのみ指定可能です。
  • chat_icon_text_flg[] と chat_icon_text[] の件数が一致しない場合はパラメータエラーとなります。
  • max_client に 0 を指定した場合は無制限となります（Unlimited Live エディションのみ）。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
flpid
integer

疑似ライブ設定ID
新規：不要（自動採番）
更新：必須

mid
integer

疑似ライブする動画ID（新規時必須）

start_date
string

公開開始日時（新規時必須）
yyyy/MM/dd hh:mm:ss または yyyy-MM-dd hh:mm:ss
※現時刻から30分以上後である必要あり

name
string <= 100 characters

疑似ライブ設定名（新規時必須）（100文字以内）

description
string <= 500 characters

疑似ライブ設定説明（500文字以内）

max_client
integer

同時接続数制限
0：無制限（Unlimited Live エディションのみ）
その他：指定値で制限

prefiller_mid
integer
Default: 0

開始前フィラー動画ID
0：デフォルト
1以上：任意動画

postfiller_mid
integer
Default: 0

終了後フィラー動画ID
0：デフォルト
1以上：任意動画

thumb_feedout
string <binary>

配信停止サムネイル（2MB以下、gif/jpeg/jpg/png）

thumb_feedin
string <binary>

配信準備サムネイル（2MB以下、gif/jpeg/jpg/png）

thumb_liveclose
string <binary>

配信終了サムネイル（2MB以下、gif/jpeg/jpg/png）

chat_flg
integer
Default: 0
Enum: 0 1

チャット利用可否（0:利用しない / 1:利用する）

chat_auto_resize
integer
Default: 0
Enum: 0 1

チャット自動リサイズ（0:無効 / 1:有効）

chat_width
integer
Default: 600

チャット幅（300〜1920）

chat_height
integer
Default: 400

チャット高さ（320〜1080）

chat_block_type
integer
Default: 0
Enum: 0 1 2

投稿メッセージ管理
0：全て許可
1：不適切の可能性があるものを保留
2：全て保留

chat_enter_msg
integer
Default: 0
Enum: 0 1 2

入退室メッセージ表示
0：表示
1：入室のみ
2：非表示

chat_open_timing
integer
Default: 0

チャット開始タイミング（分）
-1：手動
0：ライブ開始と同時

chat_close_timing
integer
Default: 0

チャット終了タイミング（分）
-1：手動
0：ライブ終了と同時
その他：終了後○分

chat_icon_text_flg
Array of integers

任意リアクションボタン利用有無
chat_icon_text[] と数が一致しない場合エラー

chat_icon_text
Array of strings

任意リアクションボタンテキスト

chat_good_btn
integer
Default: 1
Enum: 0 1

いいねボタン（0:無効 / 1:有効）

chat_trouble_btn
integer
Default: 1
Enum: 0 1

わかりませんボタン（0:無効 / 1:有効）

chat_display_name
string
Default: "admin"

管理者表示名
"admin" / "operator" / "secretariat" / 任意15文字以内

chat_block_words
string

ブロックワード（カンマ区切り、1000文字以内）

potal_meta_event_name
string

ポータルイベント名

potal_meta_event_description
string

ポータルイベント説明

potal_meta_performer
string

ポータル出演者

Responses

Request samples 

curl 'https://eqapi.stream.co.jp/filetolive/v1/setProfile/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'flpid=' \
  --form 'mid=' \
  --form 'start_date=' \
  --form 'name=' \
  --form 'description=' \
  --form 'max_client=' \
  --form 'prefiller_mid=0' \
  --form 'postfiller_mid=0' \
  --form 'thumb_feedout=' \
  --form 'thumb_feedin=' \
  --form 'thumb_liveclose=' \
  --form 'chat_flg=0' \
  --form 'chat_auto_resize=0' \
  --form 'chat_width=600' \
  --form 'chat_height=400' \
  --form 'chat_block_type=0' \
  --form 'chat_enter_msg=0' \
  --form 'chat_open_timing=0' \
  --form 'chat_close_timing=0' \
  --form 'chat_good_btn=1' \
  --form 'chat_trouble_btn=1' \
  --form 'chat_display_name=admin' \
  --form 'chat_block_words=' \
  --form 'potal_meta_event_name=' \
  --form 'potal_meta_event_description=' \
  --form 'potal_meta_performer='

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK",
  • "flpid": 1
}

疑似ライブプロファイル削除API

疑似ライブプロファイルの削除を行うAPIです。

指定した疑似ライブ設定IDの疑似ライブプロファイルを削除します。

利用上の注意事項：

  • 本APIはDELETEメソッド（application/json）専用です。
  • API実行にはアップロードキーが必要です。
  • flpid の指定は必須です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: application/json
flpid
required
integer

疑似ライブ設定ID（必須）

Responses

Request samples

Content type
application/json
{
  • "flpid": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

疑似ライブ配信中

疑似ライブ停止API

疑似ライブの強制停止を行うAPIです。

配信中または配信準備中の疑似ライブを強制的に停止できます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • flpid の指定は必須です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
flpid
required
integer

疑似ライブ設定ID（必須）

Responses

Request samples

Content type
multipart/form-data
{
  "flpid": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

疑似ライブチャット開始API

チャットの開始を行うAPIです。

疑似ライブ配信中のチャットを開始できます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。
  • API実行にはアップロードキーが必要です。
  • flpid の指定は必須です。
  • chat.open_timing=-1（手動開始）に設定されている疑似ライブプロファイルに対してのみ利用可能です。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
flpid
required
integer

疑似ライブ設定ID（必須）

Responses

Request samples

Content type
multipart/form-data
{
  "flpid": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

疑似ライブチャット停止API

チャットの停止を行うAPIです。

疑似ライブ配信中のチャットを停止できます。

利用上の注意事項：

  • 本APIはPOSTメソッド（multipart/form-data）専用です。

  • API実行にはアップロードキーが必要です。

  • flpid の指定は必須です。

  • chat.close_timing=-1（手動停止）に設定されている疑似ライブプロファイルに対してのみ利用可能です。

    マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
flpid
required
integer

疑似ライブ設定ID（必須）

Responses

Request samples

Content type
multipart/form-data
{
  "flpid": 0
}

Response samples

Content type
application/json
{
  • "error_code": 0,
  • "message": "OK"
}

疑似ライブ配信終了

疑似ライブ同時接続履歴取得API

疑似ライブの同時接続履歴を取得するAPIです。

指定した疑似ライブ設定IDの同時接続数履歴を取得できます。

利用上の注意事項：

  • 本APIはGETメソッドです。
  • ReadAPIトークンが必要です。
  • flpid の指定は必須です。
  • エラー時はHTTPステータス404が返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

flpid
required
integer

疑似ライブ設定ID

type
string
Default: "file"
Enum: "text" "file"

ダウンロードタイプ
text または file を指定可能（デフォルト：file）

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/filetolive/v1/connection?token=&flpid=1'

Response samples

Content type
text/plain
"2022-03-25 15:51:30",171
"2022-03-25 15:52:00",170
"2022-03-25 15:52:30",168
"2022-03-25 15:53:00",168
"2022-03-25 15:53:30",164
"2022-03-25 15:54:00",169
"2022-03-25 15:54:30",162
"2022-03-25 15:55:00",162

累計視聴者数,317

疑似ライブチャット投稿履歴取得API

疑似ライブのチャット投稿履歴を取得するAPIです。

指定した疑似ライブ設定IDのチャット投稿履歴を取得できます。

利用上の注意事項：

  • 本APIはGETメソッドです。
  • ReadAPIトークンが必要です。
  • flpid の指定は必須です。
  • エラー時はHTTPステータス404が返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

flpid
required
integer

疑似ライブ設定ID

type
string
Default: "file"
Enum: "text" "file"

ダウンロードタイプ
text または file を指定可能（デフォルト：file）

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/filetolive/v1/chatmsg?token=&flpid=1'

Response samples

Content type
text/plain
number,delete,time,soket_id,name,message
1,false,2019/06/17 15:48:54,master,システム,【竹田】さんが入室しました
2,false,2019/06/17 15:49:05,master,システム,【aaa】さんが入室しました
3,true,2019/06/17 15:49:27,HUHHi_dXv0MbyMBBAAAC,竹田,ライブ業務推進課の竹田開いてます。
4,false,2019/06/17 15:49:47,master,システム,【竹田】さんが退室しました
5,false,2019/06/17 15:51:15,master,システム,【テストです】さんが入室しました
6,true,2019/06/17 15:51:28,ZF_b0ZXgHScWrAUIAAAE,テストです,テストです
7,true,2019/06/17 15:51:32,ZF_b0ZXgHScWrAUIAAAE,テストです,:trouble:よくわかりません。
8,true,2019/06/17 15:52:09,W8iS8tD8piUyaur4AAAF,aaa,EQライブプレイヤーのサイズをレスポンシブ設定にしておくと、チャットを含んだ画面が使いやすくなりますよ。
9,true,2019/06/17 15:52:28,ZF_b0ZXgHScWrAUIAAAE,テストです,:nice:いいね！しました。
10,false,2019/06/17 15:52:33,master,システム,【aaa】さんが退室しました

認証（VA）

ログインAPI

新動画視聴解析（新VA）APIを利用するための認証キー（va_session）を取得するログインAPIです。
指定された契約IDおよびユーザーアカウントの認証情報をもとに認証を行い、
以降のAPIアクセスに必要なセッション情報を取得することができます。

本 API は JSON 形式のリクエストボディを受け取り、
認証成功時にはレスポンス内の情報とともに Cookie として va_session が付与されます。
他API利用時には、この va_session をリクエストの Cookie に設定する必要があります。

利用上の注意事項：

  • 本 API は POST メソッド（application/json）専用です。
  • API の利用には事前に有効なユーザーアカウントが必要です。
  • セキュリティの観点から、API専用のユーザーアカウントの利用が推奨されます。
  • レスポンスの Cookie（va_session）は後続APIの認証として利用されます。
  • 不正な認証情報が指定された場合、認証は失敗します。

マニュアル

Request Body schema: application/json
cid
required
integer

契約会社ID

mail
required
string

EQログイン時のメールアドレス

password
required
string <password>

EQログイン時のパスワード

Responses

Request samples

Content type
application/json
{
  • "cid": 0,
  • "mail": "yourmail@stream.co.jp",
  • "password": "yourpassword"
}

Response samples

Content type
application/json
Example
{
  • "response_code": 0
}

グループ

グループ一覧取得

他APIのリクエストパラメーターとして利用する管理グループ情報を取得するAPIです。

指定したページサイズおよびページ番号に基づいて、 管理グループの一覧を取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • page_size は 1～100 の範囲で指定してください。
  • page_number は 1 以上を指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数（1〜100）

page_number
required
integer >= 1

該当のページ番号（1〜2147483647）

Responses

Request samples

Content type
application/json
{
  • "page_size": 100,
  • "page_number": 1
}

Response samples

Content type
application/json
Example
{
  • "response_code": 0,
  • "count": 3,
  • "group_list": [
    ]
}

カスタムフィールド

カスタムフィールド一覧取得

他APIのリクエストパラメーターとして利用するカスタムフィールド情報を取得するAPIです。

EQ管理画面で設定されたカスタムメタデータ設定の情報を取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • リクエストパラメーターは不要です。
  • 不正な認証情報が指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
Example
{
  • "response_code": 0,
  • "custom_field_list": [
    ]
}

オンデマンド

全体サマリー取得

オンデマンド動画の集計サマリー情報を取得するAPIです。

指定した集計期間および検索条件に一致する動画を対象として、 表示回数、再生回数、視聴率、再生率、再生完了率の集計結果を取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • 集計期間は from_date ～ to_date の範囲で指定してください。
  • 管理グループ、動画情報、カスタムフィールドによる絞り込みが可能です。
  • grids を指定しない場合は [0] が適用されます。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

grids
Array of integers

管理グループID一覧（0〜5件）
指定しない場合は[0]固定

title
string

タイトル

keywords
string

キーワード

mid
integer

動画ID

opid
string

任意ID

api_keywords
string

APIリファレンスコード

Array of objects

カスタムフィールド（1〜5件）

Responses

Request samples

Content type
application/json
{
  • "from_date": "2026-01-01 00:00:00",
  • "to_date": "2026-12-31 23:59:59",
  • "grids": [
    ],
  • "opid": "optest1",
  • "mid": 350,
  • "api_keywords": "test_api_keywords",
  • "custom_fields": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "total_view_count": 98,
  • "total_play_count": 14,
  • "average_audience_rating": "0.142",
  • "average_play_rate": "0.000",
  • "average_play_completion_rate": "0.000",
  • "response_code": 0
}

コンテンツリスト取得

オンデマンド動画のコンテンツ一覧および視聴状況を取得するAPIです。

指定した集計期間および検索条件に一致する動画を対象として、 動画ごとの再生状況や視聴率、表示回数などの視聴分析データを取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • 集計期間は from_date ～ to_date の範囲で指定してください。
  • 管理グループ、動画情報、カスタムフィールドによる絞り込みが可能です。
  • grids を指定しない場合は [0] が適用されます。
  • ソート対象項目の先頭に「-」を付与すると降順となります。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

grids
Array of integers

管理グループID一覧（0〜5件）
指定しない場合は[0]固定

title
string

タイトル

keywords
string

キーワード

mid
integer

動画ID

opid
string

任意ID

api_keywords
string

APIリファレンスコード

Array of objects

カスタムフィールド（1〜5件）

sort
string

ソート条件
レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count

page_size
required
integer

1ページ当たりのレコード数

page_number
required
integer

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2025-01-01 00:00:00",
  • "to_date": "2025-10-05 23:59:59",
  • "grids": [
    ],
  • "mid": 26,
  • "sort": "-view_count",
  • "page_size": 100,
  • "page_number": 1
}

Response samples

Content type
application/json
Example
{
  • "viewing_status_list": [
    ],
  • "count": 1,
  • "response_code": 0
}

コンテンツクリックリスト取得

オンデマンド動画のコンテンツ一覧におけるクリック数情報を取得するAPIです。

指定した集計期間および検索条件に一致する動画を対象として、 「もう一回見る」ボタン、外部リンク、SNS共有ボタンなどのクリック数を取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • 集計期間は from_date ～ to_date の範囲で指定してください。
  • 管理グループ、動画情報、カスタムフィールドによる絞り込みが可能です。
  • grids を指定しない場合は [0] が適用されます。
  • ソート対象項目の先頭に「-」を付与すると降順となります。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

grids
Array of integers

管理グループID一覧（0〜5件）
指定しない場合は[0]固定

title
string

タイトル

keywords
string

キーワード

mid
integer

動画ID

opid
string

任意ID

api_keywords
string

APIリファレンスコード

Array of objects

カスタムフィールド（1〜5件）

sort
string

ソート条件
レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2025-01-01 00:00:00",
  • "to_date": "2025-10-05 23:59:59",
  • "grids": [
    ],
  • "mid": 26,
  • "sort": "-twitter_count",
  • "page_size": 100,
  • "page_number": 1
}

Response samples

Content type
application/json
Example
{}

各動画の掲載ページURL一覧取得

オンデマンド動画の掲載ページURLごとの視聴状況を取得するAPIです。

指定した動画IDを対象として、動画が掲載されているページURLごとの 表示回数、再生回数、視聴率、再生率、再生完了率などの集計情報を取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • 集計期間は from_date ～ to_date の範囲で指定してください。
  • search_domain を指定した場合、対象URLをドメインで絞り込みます。
  • ソート対象項目の先頭に「-」を付与すると降順となります。
  • page_size は 1～100 の範囲で指定してください。
  • 対象動画が存在しない場合はエラーレスポンスが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

mid
required
integer

動画ID

search_domain
string

取得対象
対象掲載ページURLの一覧
未指定で全体取得

sort
string

ソート条件
レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2025-01-01 00:00:00",
  • "to_date": "2025-10-05 23:59:59",
  • "mid": 4,
  • "search_domain": "stream.co.jp",
  • "sort": "-view_count",
  • "page_size": 100,
  • "page_number": 1
}

Response samples

Content type
application/json
Example
{
  • "url_info_list": [
    ],
  • "count": 1,
  • "response_code": 0
}

動画別の日別・時間帯別リスト取得

動画別・日時別の視聴状況を取得するAPIです。

指定した月を対象として、動画ごとの日別および時間帯別の 視聴状況集計データを取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • target_month は対象年月を指定してください。
  • 集計対象は過去25か月以内のデータに限られます。
  • page_size は 1～100000 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
target_month
required
string

集計対象月（Y-m-d）
過去25か月以内を指定

page_size
required
integer [ 1 .. 100000 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "target_month": "2025-09",
  • "page_size": 100,
  • "page_number": 1
}

Response samples

Content type
application/json
Example
{
  • "viewing_date_list": [
    ],
  • "count": 4,
  • "response_code": 0
}

ユーザー別視聴解析

キーリスト取得

ユーザ別視聴解析で利用可能な任意パラメータのキー一覧を取得するAPIです。

指定した集計期間および集計対象に対して、 視聴ログに記録されている任意パラメータのキー名一覧を取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • 集計期間は from_date ～ to_date の範囲で指定してください。
  • target には集計対象を指定します。
  • sort の先頭に「-」を付与すると降順となります。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータや利用権限がない場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

sort
string

ソート条件
レスポンスの項目名にマイナス（-）をつけると降順となる
例）-key

target
required
integer
Enum: 1 2 3

集計対象（1:VOD/2:ライブ/3:疑似ライブ）

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2023-01-01 00:00:00",
  • "to_date": "2023-12-31 23:59:59",
  • "sort": "-key",
  • "target": 1,
  • "page_size": 100,
  • "page_number": 1
}

Response samples

Content type
application/json
Example
{
  • "count": 2,
  • "key_list": [
    ],
  • "response_code": 0
}

オンデマンド動画管理画面データ一覧取得

ユーザー別視聴解析におけるオンデマンド動画の集計データ一覧を取得するAPIです。

指定した任意パラメータキーおよび集計方法に基づき、 オンデマンド動画の視聴状況データを取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • key には「キーリスト取得API」で取得した任意パラメータキーを指定してください。
  • type により集計方法を指定します。
  • sort の先頭に「-」を付与すると降順となります。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

key
required
string [ 1 .. 64 ] characters

任意パラメータキー名

type
required
integer
Enum: 1 2 3 4

集計方法
1:分別
2:日別
3:月別
4:全体

sort
string

ソート条件
レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2023-01-01 00:00:00",
  • "to_date": "2023-01-01 23:59:59",
  • "key": "type",
  • "type": 1,
  • "sort": "view_count",
  • "page_size": 1,
  • "page_number": 1
}

Response samples

Content type
application/json
{
  • "info_list": [
    ],
  • "count": 1,
  • "response_code": 0
}

ライブ管理画面データ一覧取得

ユーザー別視聴解析におけるライブ配信の集計データ一覧を取得するAPIです。

指定した任意パラメータキーおよび集計方法に基づき、 ライブ配信の視聴状況データを取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • key には「キーリスト取得API」で取得した任意パラメータキーを指定してください。
  • type により集計方法を指定します。
  • sort の先頭に「-」を付与すると降順となります。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

key
required
string [ 1 .. 64 ] characters

任意パラメータキー名

type
required
integer
Enum: 1 2 3 4

集計方法
1:分別
2:日別
3:月別
4:全体

sort
string

ソート条件
レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2023-01-01 00:00:00",
  • "to_date": "2023-01-01 23:59:59",
  • "key": "type",
  • "type": 1,
  • "sort": "view_count",
  • "page_size": 1,
  • "page_number": 1
}

Response samples

Content type
application/json
{
  • "info_list": [
    ],
  • "count": 1,
  • "response_code": 0
}

疑似ライブ管理画面データ一覧取得

ユーザー別視聴解析における疑似ライブの集計データ一覧を取得するAPIです。

指定した任意パラメータキーおよび集計方法に基づき、 疑似ライブの視聴状況データを取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • key には「キーリスト取得API」で取得した任意パラメータキーを指定してください。
  • type により集計方法を指定します。
  • sort の先頭に「-」を付与すると降順となります。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

key
required
string [ 1 .. 64 ] characters

任意パラメータキー名

type
required
integer
Enum: 1 2 3 4

集計方法
1:分別
2:日別
3:月別
4:全体

sort
string

ソート条件
レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2023-01-01 00:00:00",
  • "to_date": "2023-01-01 23:59:59",
  • "key": "type",
  • "type": 1,
  • "sort": "view_count",
  • "page_size": 1,
  • "page_number": 1
}

Response samples

Content type
application/json
{
  • "info_list": [
    ],
  • "count": 1,
  • "response_code": 0
}

オンデマンド動画データ一覧取得

ユーザー別視聴解析で取得したオンデマンド動画の集計データ一覧を取得するAPIです。
※旧VAでCSVファイル取得機能を利用していたお客様向けの機能です。

本APIは旧動画視聴解析（旧VA）のCSVファイル取得機能の代替として提供されており、 任意パラメータのキーおよび値を指定して対象データを抽出することができます。

指定した集計期間、集計方法、検索条件に一致するオンデマンド動画の 視聴状況データを取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • type により集計方法を指定します。
  • key および value を指定することで対象データを絞り込めます。
  • 集計方法が「4:全体」の場合、date は返却されません。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

type
required
integer
Enum: 1 2 3 4

集計方法
1:分別
2:日別
3:月別
4:全体

key
string

検索対象キー

value
string

検索対象値

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2023-01-01 00:00:00",
  • "to_date": "2023-01-01 23:59:59",
  • "key": "type",
  • "value": "研修",
  • "type": 1,
  • "page_size": 1,
  • "page_number": 1
}

Response samples

Content type
application/json
{
  • "count": 1000,
  • "record_list": [
    ],
  • "response_code": 0
}

ライブデータ一覧取得

ユーザー別視聴解析で取得したライブ配信の集計データ一覧を取得するAPIです。
※旧VAでCSVファイル取得機能を利用していたお客様向けの機能です。

本APIは旧動画視聴解析（旧VA）のCSVファイル取得機能の代替として提供されており、 任意パラメータのキーおよび値を指定して対象データを抽出することができます。

指定した集計期間、集計方法、検索条件に一致するライブ配信の 視聴状況データを取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • type により集計方法を指定します。
  • key および value を指定することで対象データを絞り込めます。
  • 集計方法が「4:全体」の場合、date は返却されません。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

type
required
integer
Enum: 1 2 3 4

集計方法
1:分別
2:日別
3:月別
4:全体

key
string

検索対象キー

value
string

検索対象値

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2023-01-01 00:00:00",
  • "to_date": "2023-01-01 23:59:59",
  • "key": "type",
  • "value": "研修",
  • "type": 1,
  • "page_size": 1,
  • "page_number": 1
}

Response samples

Content type
application/json
{
  • "count": 1000,
  • "record_list": [
    ],
  • "response_code": 0
}

疑似ライブデータ一覧取得

ユーザー別視聴解析で取得した疑似ライブの集計データ一覧を取得するAPIです。
※旧VAでCSVファイル取得機能を利用していたお客様向けの機能です。

本APIは旧動画視聴解析（旧VA）のCSVファイル取得機能の代替として提供されており、 任意パラメータのキーおよび値を指定して対象データを抽出することができます。

指定した集計期間、集計方法、検索条件に一致する疑似ライブの 視聴状況データを取得することができます。

本APIはログインAPIで取得した Cookie（va_session）による認証が必要です。

利用上の注意事項：

  • 本APIは POST メソッド（application/json）専用です。
  • API実行前にログインAPIで認証を行う必要があります。
  • 認証成功時に取得した Cookie（va_session）をリクエストに設定してください。
  • type により集計方法を指定します。
  • key および value を指定することで対象データを絞り込めます。
  • 集計方法が「4:全体」の場合、date は返却されません。
  • page_size は 1～100 の範囲で指定してください。
  • 不正なパラメータが指定された場合はエラーが返却されます。

マニュアル

Authorizations:
VaSessionAuth
Request Body schema: application/json
from_date
required
string

集計期間開始日時（Y-m-d H:i:s）

to_date
required
string

集計期間終了日時（Y-m-d H:i:s）

type
required
integer
Enum: 1 2 3 4

集計方法
1:分別
2:日別
3:月別
4:全体

key
string

検索対象キー

value
string

検索対象値

page_size
required
integer [ 1 .. 100 ]

1ページ当たりのログレコード数

page_number
required
integer >= 1

ページ番号

Responses

Request samples

Content type
application/json
{
  • "from_date": "2023-01-01 00:00:00",
  • "to_date": "2023-01-01 23:59:59",
  • "key": "type",
  • "value": "研修",
  • "type": 1,
  • "page_size": 1,
  • "page_number": 1
}

Response samples

Content type
application/json
{
  • "count": 1000,
  • "record_list": [
    ],
  • "response_code": 0
}