ライブAPI

共通処理

リクエストヘッダー

リクエストヘッダーはこちらをご確認ください。

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_id String マーチャントID nttsmc 必須
live_event_id String ライブイベントID id live_event_id, ref_idいずれか必須
ref_id String 参照ID id
レスポンス
フィールド タイプ 説明
merchant_id String 契約者ID
id String ライブイベントID
ref_id String 参照ID
name String ライブイベント名
description String 説明
enable_ad_insertion_flag Boolean 広告挿入フラグ
live_event_profile_id String ライブイベントプロファイルID
input_sources Object[] インジェストURL
enable_ad_insertion_flag Boolean 広告挿入フラグ
media_id String メディアID
enable_live_to_file_flag Boolean クリップフラグ
encode_status String エンコード状態
live_encode_start_at String エンコード開始日時
live_encode_end_at String エンコード終了日時
preview Object ライブプレビュー画像
　src String ライブプレビュー画像のURL
created_at String 作成日時
updated_at String 更新日時
preview Object ライブプレビュー画像
　src String ポスター画像の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"
    }
}
エラーコード
ステータスコード コード メッセージ
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_NOT_FOUND 該当するライブイベントが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

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

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

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
クエリパラメータ
フィールド タイプ 説明 サンプル
limit Integer 取得件数 30
page Integer ページ番号 1
sort String ソート指定カラム updated_at
order String 並び順 ASC
レスポンス
フィールド タイプ 説明
id String ライブイベントID
ref_id String 参照ID
name String ライブイベント名
merchant_id String 契約者ID
description String 説明
live_event_profile_id String ライブイベントプロファイルID
input_sources Object[] インジェストURL
enable_ad_insertion_flag Boolean 広告挿入フラグ
media_id String メディアID
enable_live_to_file_flag Boolean クリップフラグ
encode_status String エンコード状態
live_encode_start_at String エンコード開始日時
live_encode_end_at String エンコード終了日時
preview Object ライブプレビュー画像
　src String ライブプレビュー画像のURL
created_at String 作成日時
updated_at String 更新日時

レスポンスの例

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

ライブイベントの作成

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

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events
URLパラメータ
フィールド タイプ 説明 サンプル
merchant_id String マーチャントID nttsmc
リクエスト
フィールド タイプ 説明 必要性
name String ライブイベント名 必須
description String 説明 任意
ref_id String 参照ID 任意
source_type String 入力プロトコルタイプ 任意(rtmp, rtp, udpから選択可。default値はrtmp)
enable_ad_insertion_flag Boolean 広告挿入フラグ 任意
live_event_profile_id String ライブイベントプロファイルID 必須
enable_live_to_file_flag Boolean クリップフラグ 任意
live_encode_start_at String エンコード開始日時 任意
live_encode_end_at String エンコード終了日時 任意
レスポンス
フィールド タイプ 説明
merchant_id String 契約者ID
id String ライブイベントID
ref_id String ライブイベントの参照ID
name String ライブイベント名
description String 説明
enable_ad_insertion_flag Boolean 広告挿入フラグ
live_event_profile_id String ライブイベントプロファイルID
input_sources Object[] インジェストURL
media_id String メディアID
enable_live_to_file_flag Boolean クリップフラグ
encode_status String エンコード状態
live_encode_start_at String エンコード開始日時
live_encode_end_at String エンコード終了日時
created_at String 作成日時
updated_at String 更新日時
preview Object ライブプレビュー画像
　src String ポスター画像の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"
    }
}
エラーコード
ステータスコード コード メッセージ
400 BAD_REQUEST リクエストパラメーターが不正です
400 FAILED_TO_SAVE 保存処理に失敗しました
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_PROFILE_NOT_FOUND 該当するライブイベントプロファイルが存在しません
500 SERVER_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_id String マーチャントID nttsmc 必須
live_event_id String ライブイベントID id live_event_id, ref_idいずれか必須
ref_id String 参照ID ref_id
レスポンス
フィールド タイプ 説明
merchant_id String 契約者ID
id String ライブイベントID
ref_id String ライブイベントの参照ID
name String ライブイベント名
description String 説明
enable_ad_insertion_flag Boolean 広告挿入フラグ
live_event_profile_id String ライブイベントプロファイルID
input_sources Object[] インジェストURL
media_id String メディアID
enable_live_to_file_flag Boolean クリップフラグ
encode_status String エンコード状態
live_encode_start_at String エンコード開始日時
live_encode_end_at String エンコード終了日時
created_at String 作成日時
updated_at String 更新日時
preview Object ライブプレビュー画像
　src String ポスター画像の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"
    }
}
エラーコード
ステータスコード コード メッセージ
400 FAILED_TO_SAVE 保存処理に失敗しました
400 FAILED_TO_START 開始処理に失敗しました
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_NOT_FOUND 該当のライブイベントが存在しません
500 SERVER_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_id String マーチャントID nttsmc 必須
live_event_id String ライブイベントID id live_event_id, ref_idいずれか必須
ref_id String 参照ID ref_id
レスポンス
フィールド タイプ 説明
merchant_id String 契約者ID
id String ライブイベントID
ref_id String ライブイベントの参照ID
name String ライブイベント名
description String 説明
enable_ad_insertion_flag Boolean 広告挿入フラグ
live_event_profile_id String ライブイベントプロファイルID
input_sources Object[] インジェストURL
media_id String メディアID
enable_live_to_file_flag Boolean クリップフラグ
encode_status String エンコード状態
live_encode_start_at String エンコード開始日時
live_encode_end_at String エンコード終了日時
created_at String 作成日時
updated_at String 更新日時
preview Object ライブプレビュー画像
　src String ポスター画像の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"
    }
}
エラーコード
ステータスコード コード メッセージ
400 FAILED_TO_STOP 停止処理に失敗しました
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_NOT_FOUND 該当のライブイベントが存在しません
500 SERVER_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_id String マーチャントID nttsmc 必須
live_event_id String ライブイベントID id live_event_id, ref_idいずれか必須
ref_id String 参照ID id
レスポンス
HTTP/1.1 200 OK

エラーコード
ステータスコード コード メッセージ
400 FAILED_TO_RESET リセット処理に失敗しました
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_NOT_FOUND 該当するライブイベントが存在しません
500 SERVER_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_id String マーチャントID nttsmc 必須
live_event_id String ライブイベントID id live_event_id, ref_idいずれか必須
ref_id String 参照ID id
レスポンス
HTTP/1.1 200 OK

エラーコード
ステータスコード コード メッセージ
400 FAILED_TO_CANCEL キャンセル処理に失敗しました
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_NOT_FOUND 該当するライブイベントが存在しません
500 SERVER_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_id String マーチャントID nttsmc 必須
live_event_id String ライブイベントID id live_event_id, ref_idいずれか必須
ref_id String 参照ID id
リクエストボディ
フィールド タイプ 説明
name String ライブイベント名
description String 説明
ref_id String 参照ID
enable_ad_insertion_flag Boolean 広告挿入フラグ
live_event_profile_id String ライブイベントプロファイルID
enable_live_to_file_flag Boolean クリップフラグ
live_encode_start_at String エンコード開始日時
live_encode_end_at String エンコード終了日時
レスポンス
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"
    }
}

エラーコード
ステータスコード コード メッセージ
400 BAD_REQUEST リクエストパラメーターが不正です
400 FAILED_TO_UPDATE 更新処理に失敗しました
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_NOT_FOUND 該当するライブイベントが存在しません
404 LIVE_EVENT_PROFILE_NOT_FOUND 該当するライブイベントプロファイルが存在しません
500 SERVER_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_id String マーチャントID nttsmc 必須
live_event_id String ライブイベントID id live_event_id, ref_idいずれか必須
ref_id String 参照ID id
レスポンス

レスポンスの例

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"
    }
}
エラーコード
ステータスコード コード メッセージ
400 FAILED_TO_DELETE 削除処理に失敗しました
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_NOT_FOUND 該当するライブイベントが存在しません
500 SERVER_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_id String マーチャントID nttsmc 必須
live_event_profile_id String ライブイベントプロファイルID id live_event_profile_id, ref_idいずれか必須
ref_id String 参照ID ref_id
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String ライブイベントプロファイルID
ref_id String ライブイベントプロファイルの参照ID
name String ライブイベントプロファイル名
description String 説明文
created_at String 作成日時
updated_at String 更新日時
エラーコード
ステータスコード コード メッセージ
401 UNAUTHORIZED 認証に失敗しました
404 LIVE_EVENT_PROFILE_NOT_FOUND 該当するライブイベントプロファイルが存在しません
500 SERVER_ERROR 予期せぬエラーが発生しました

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

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

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_event_profiles
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
クエリパラメータ
フィールド タイプ 説明 サンプル
limit Integer 取得件数 30
page Integer ページ番号 1
sort String ソート指定カラム updated_at
order String 並び順 ASC
レスポンス
フィールド タイプ 説明
merchant_id String マーチャントID
id String ライブイベントプロファイルID
ref_id String 参照ID
name String ライブイベントプロファイル名
description String 説明文
created_at String 作成日時
updated_at String 更新日時

レスポンスの例


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