ライブAPI

共通処理

リクエストヘッダーで下記を指定します。

リクエストヘッダー
フィールドタイプ説明
AuthorizationStringAuthorization: Bearer access_token

IDもしくは参照IDによるライブイベントの取得

ライブイベント情報をIDまたは参照IDを指定して1件取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_idStringライブイベントIDidlive_event_id, ref_idいずれか必須
ref_idString参照IDid
レスポンス
フィールドタイプ説明
merchant_idString契約者ID
idStringライブイベントID
ref_idString参照ID
nameStringライブイベント名
descriptionString説明
enable_ad_insertion_flagBoolean広告挿入フラグ
live_event_profile_idStringライブイベントプロファイルID
input_sourcesObject[]インジェストURL
enable_ad_insertion_flagBoolean広告挿入フラグ
media_idStringメディアID
enable_live_to_file_flagBooleanクリップフラグ
encode_statusStringエンコード状態
live_encode_start_atStringエンコード開始日時
live_encode_end_atStringエンコード終了日時
previewObjectライブプレビュー画像
 srcStringライブプレビュー画像のURL
created_atString作成日時
updated_atString更新日時
previewObjectライブプレビュー画像
 srcStringポスター画像のURL

レスポンスの例

HTTP/1.1 200 OK
{
    "merchant_id": "nttsmc",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "live_encode_start_at":null,
    "live_encode_end_at":null,
    "created_at":"2018-03-14T14:42:04.632+09:00",
    "updated_at":"2018-03-14T16:39:04.428+09:00",
    "preview":
    {
      "src":"https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}
エラーコード
ステータスコードコードメッセージ
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_NOT_FOUND該当するライブイベントが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントの一覧取得

ライブイベント情報を一括で取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
クエリパラメータ
フィールドタイプ説明サンプル
limitInteger取得件数30
pageIntegerページ番号1
sortStringソート指定カラムupdated_at
orderString並び順ASC
レスポンス
フィールドタイプ説明
idStringライブイベントID
ref_idString参照ID
nameStringライブイベント名
merchant_idString契約者ID
descriptionString説明
live_event_profile_idStringライブイベントプロファイルID
input_sourcesObject[]インジェストURL
enable_ad_insertion_flagBoolean広告挿入フラグ
media_idStringメディアID
enable_live_to_file_flagBooleanクリップフラグ
encode_statusStringエンコード状態
live_encode_start_atStringエンコード開始日時
live_encode_end_atStringエンコード終了日時
previewObjectライブプレビュー画像
 srcStringライブプレビュー画像のURL
created_atString作成日時
updated_atString更新日時

レスポンスの例

HTTP/1.1 200 OK
{
  "count": 30,
  "live_events":
    [
      {<live_event1 fields>},
      {<live_event2 fields>},
      ...
    ]
}
エラーコード
ステータスコードコードメッセージ
400BAD_REQUESTリクエストパラメーターが不正です
401UNAUTHORIZED認証に失敗しました
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントの作成

ライブイベントを作成するAPIです。

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events
URLパラメータ
フィールドタイプ説明サンプル
merchant_idStringマーチャントIDnttsmc
リクエスト
フィールドタイプ説明必要性
nameStringライブイベント名必須
descriptionString説明任意
ref_idString参照ID任意
source_typeString入力プロトコルタイプ任意(rtmp, rtp, udpから選択可。default値はrtmp)
enable_ad_insertion_flagBoolean広告挿入フラグ任意
live_event_profile_idStringライブイベントプロファイルID必須
enable_live_to_file_flagBooleanクリップフラグ任意
live_encode_start_atStringエンコード開始日時任意
live_encode_end_atStringエンコード終了日時任意
レスポンス
フィールドタイプ説明
merchant_idString契約者ID
idStringライブイベントID
ref_idStringライブイベントの参照ID
nameStringライブイベント名
descriptionString説明
enable_ad_insertion_flagBoolean広告挿入フラグ
live_event_profile_idStringライブイベントプロファイルID
input_sourcesObject[]インジェストURL
media_idStringメディアID
enable_live_to_file_flagBooleanクリップフラグ
encode_statusStringエンコード状態
live_encode_start_atStringエンコード開始日時
live_encode_end_atStringエンコード終了日時
created_atString作成日時
updated_atString更新日時
previewObjectライブプレビュー画像
 srcStringポスター画像のURL

レスポンスの例

HTTP/1.1 200 OK
{
    "merchant_id": "nttsmc",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "live_encode_start_at":null,
    "live_encode_end_at":null,
    "created_at":"2018-03-14T14:42:04.632+09:00",
    "updated_at":"2018-03-14T16:39:04.428+09:00",
    "preview":
    {
      "src":"https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}
エラーコード
ステータスコードコードメッセージ
400BAD_REQUESTリクエストパラメーターが不正です
400FAILED_TO_SAVE保存処理に失敗しました
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_PROFILE_NOT_FOUND該当するライブイベントプロファイルが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントの開始

ライブイベントを開始するAPIです。

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id/start

OR

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id/start
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_idStringライブイベントIDidlive_event_id, ref_idいずれか必須
ref_idString参照IDref_id
レスポンス
フィールドタイプ説明
merchant_idString契約者ID
idStringライブイベントID
ref_idStringライブイベントの参照ID
nameStringライブイベント名
descriptionString説明
enable_ad_insertion_flagBoolean広告挿入フラグ
live_event_profile_idStringライブイベントプロファイルID
input_sourcesObject[]インジェストURL
media_idStringメディアID
enable_live_to_file_flagBooleanクリップフラグ
encode_statusStringエンコード状態
live_encode_start_atStringエンコード開始日時
live_encode_end_atStringエンコード終了日時
created_atString作成日時
updated_atString更新日時
previewObjectライブプレビュー画像
 srcStringポスター画像のURL

レスポンスの例

HTTP/1.1 200 OK
{
    "merchant_id": "nttsmc",
    "id": "ea74ba39162f49d89221daebd02c215a",
    "ref_id": "live_test",
    "name": "live_test",
    "description": "",
    "enable_ad_insertion_flag": false,
    "live_event_profile_id": "c2e31a9d22d9487dae8d837c38231f81",
    "input_sources": [
      "rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"
    ],
    "media_id": "6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status": "encode_status_pending",
    "enable_live_to_file_flag": false,
    "live_encode_start_at": null,
    "live_encode_end_at": null,
    "created_at": "2018-03-14T14:42:04.632+09:00",
    "updated_at": "2018-03-14T21:47:54.607+09:00",
    "preview": {
      "src": "https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}
エラーコード
ステータスコードコードメッセージ
400FAILED_TO_SAVE保存処理に失敗しました
400FAILED_TO_START開始処理に失敗しました
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_NOT_FOUND該当のライブイベントが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントの停止

ライブイベントを停止するAPIです。ライブを再開すためには停止後リセットする必要があります。

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id/stop

OR

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id/stop
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_idStringライブイベントIDidlive_event_id, ref_idいずれか必須
ref_idString参照IDref_id
レスポンス
フィールドタイプ説明
merchant_idString契約者ID
idStringライブイベントID
ref_idStringライブイベントの参照ID
nameStringライブイベント名
descriptionString説明
enable_ad_insertion_flagBoolean広告挿入フラグ
live_event_profile_idStringライブイベントプロファイルID
input_sourcesObject[]インジェストURL
media_idStringメディアID
enable_live_to_file_flagBooleanクリップフラグ
encode_statusStringエンコード状態
live_encode_start_atStringエンコード開始日時
live_encode_end_atStringエンコード終了日時
created_atString作成日時
updated_atString更新日時
previewObjectライブプレビュー画像
 srcStringポスター画像のURL

レスポンスの例

HTTP/1.1 200 OK
{
    "merchant_id": "nttsmc",
    "id": "ea74ba39162f49d89221daebd02c215a",
    "ref_id": "live_test",
    "name": "live_test",
    "description": "",
    "enable_ad_insertion_flag": false,
    "live_event_profile_id": "c2e31a9d22d9487dae8d837c38231f81",
    "input_sources": [
      "rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"
    ],
    "media_id": "6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status": "encode_status_pending",
    "enable_live_to_file_flag": false,
    "live_encode_start_at": null,
    "live_encode_end_at": null,
    "created_at": "2018-03-14T14:42:04.632+09:00",
    "updated_at": "2018-03-14T21:47:54.607+09:00",
    "preview": {
      "src": "https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}
エラーコード
ステータスコードコードメッセージ
400FAILED_TO_STOP停止処理に失敗しました
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_NOT_FOUND該当のライブイベントが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントのリセット

ライブイベントをリセットするAPIです。

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id/reset

OR

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id/reset
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_idStringライブイベントIDidlive_event_id, ref_idいずれか必須
ref_idString参照IDid
レスポンス
HTTP/1.1 200 OK

エラーコード
ステータスコードコードメッセージ
400FAILED_TO_RESETリセット処理に失敗しました
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_NOT_FOUND該当するライブイベントが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントのキャンセル

ライブイベントをキャンセルするAPIです。

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id/cancel

OR

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id/cancel
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_idStringライブイベントIDidlive_event_id, ref_idいずれか必須
ref_idString参照IDid
レスポンス
HTTP/1.1 200 OK

エラーコード
ステータスコードコードメッセージ
400FAILED_TO_CANCELキャンセル処理に失敗しました
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_NOT_FOUND該当するライブイベントが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントの更新

ライブイベント情報を更新するAPIです。

HTTPリクエスト
PUT https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id

OR

PUT https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_idStringライブイベントIDidlive_event_id, ref_idいずれか必須
ref_idString参照IDid
リクエストボディ
フィールドタイプ説明
nameStringライブイベント名
descriptionString説明
ref_idString参照ID
enable_ad_insertion_flagBoolean広告挿入フラグ
live_event_profile_idStringライブイベントプロファイルID
enable_live_to_file_flagBooleanクリップフラグ
live_encode_start_atStringエンコード開始日時
live_encode_end_atStringエンコード終了日時
レスポンス
HTTP/1.1 200 OK
{
    "merchant_id": "nttsmc",
    "id": "ea74ba39162f49d89221daebd02c215a",
    "ref_id": "live_test",
    "name": "live_test",
    "description": "",
    "enable_ad_insertion_flag": false,
    "live_event_profile_id": "c2e31a9d22d9487dae8d837c38231f81",
    "input_sources": [
      "rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"
    ],
    "media_id": "6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status": "encode_status_pending",
    "enable_live_to_file_flag": false,
    "live_encode_start_at": null,
    "live_encode_end_at": null,
    "created_at": "2018-03-14T14:42:04.632+09:00",
    "updated_at": "2018-03-14T21:47:54.607+09:00",
    "preview": {
      "src": "https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

エラーコード
ステータスコードコードメッセージ
400BAD_REQUESTリクエストパラメーターが不正です
400FAILED_TO_UPDATE更新処理に失敗しました
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_NOT_FOUND該当するライブイベントが存在しません
404LIVE_EVENT_PROFILE_NOT_FOUND該当するライブイベントプロファイルが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントの削除

ライブイベントを削除するAPIです。ライブ配信中に削除をする場合、停止されてから削除されます。

HTTPリクエスト
DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/:live_event_id

OR

DELETE https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events/ref:ref_id
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_idStringライブイベントIDidlive_event_id, ref_idいずれか必須
ref_idString参照IDid
レスポンス

レスポンスの例

HTTP/1.1 200 OK
{
    "merchant_id": "nttsmc",
    "id": "ea74ba39162f49d89221daebd02c215a",
    "ref_id": "live_test",
    "name": "live_test",
    "description": "",
    "enable_ad_insertion_flag": false,
    "live_event_profile_id": "c2e31a9d22d9487dae8d837c38231f81",
    "input_sources": [
      "rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"
    ],
    "media_id": "6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status": "encode_status_pending",
    "enable_live_to_file_flag": false,
    "live_encode_start_at": null,
    "live_encode_end_at": null,
    "created_at": "2018-03-14T14:42:04.632+09:00",
    "updated_at": "2018-03-14T21:47:54.607+09:00",
    "preview": {
      "src": "https://vod-nttsmc.smartstream.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}
エラーコード
ステータスコードコードメッセージ
400FAILED_TO_DELETE削除処理に失敗しました
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_NOT_FOUND該当するライブイベントが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

IDもしくは参照IDによるライブイベントプロファイルの取得

ライブイベントプロファイル情報をIDまたは参照IDを指定して1件取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_event_profiles/:live_event_profile_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_event_profiles/ref:ref_id
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
live_event_profile_idStringライブイベントプロファイルIDidlive_event_profile_id, ref_idいずれか必須
ref_idString参照IDref_id
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringライブイベントプロファイルID
ref_idStringライブイベントプロファイルの参照ID
nameStringライブイベントプロファイル名
descriptionString説明文
created_atString作成日時
updated_atString更新日時
エラーコード
ステータスコードコードメッセージ
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_PROFILE_NOT_FOUND該当するライブイベントプロファイルが存在しません
500SERVER_ERROR予期せぬエラーが発生しました

ライブイベントプロファイルの一覧取得

ライブイベントプロファイルを一括で取得するAPIです。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_event_profiles
URLパラメータ
フィールドタイプ説明サンプル必要性
merchant_idStringマーチャントIDnttsmc必須
クエリパラメータ
フィールドタイプ説明サンプル
limitInteger取得件数30
pageIntegerページ番号1
sortStringソート指定カラムupdated_at
orderString並び順ASC
レスポンス
フィールドタイプ説明
merchant_idStringマーチャントID
idStringライブイベントプロファイルID
ref_idString参照ID
nameStringライブイベントプロファイル名
descriptionString説明文
created_atString作成日時
updated_atString更新日時

レスポンスの例


HTTP/1.1 200 OK
{
  "count": 30,
  "profiles":
    [
      {<profile1 fields>},
      {<profile2 fields>},
      ...
    ]
}
エラーコード
ステータスコードコードメッセージ
400BAD_REQUESTリクエストパラメーターが不正です
401UNAUTHORIZED認証に失敗しました
404LIVE_EVENT_PROFILE_NOT_FOUND該当するライブイベントプロファイルが存在しません
500SERVER_ERROR予期せぬエラーが発生しました