SmartSTREAM logo

SmartSTREAM Support Manual

Return to Support Manual TOP

Live API

Common Processing

Request Headers

Please refer here for request headers.

Retrieve Live Event by ID or Reference ID

API to retrieve a single live event by specifying either the ID or the reference ID

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
live_event_id String Live event ID id Either live_event_id or ref_id required
ref_id String Reference ID id  

Response

Field Type Description
merchant_id String Merchant ID
id String Live event ID
ref_id String Reference ID
name String Live event name
description String Description
enable_ad_insertion_flag Boolean Ad insertion flag
live_event_profile_id String Live event profile ID
input_sources Object[] Ingest URL
enable_ad_insertion_flag Boolean Ad insertion flag
media_id String Media ID
enable_live_to_file_flag Boolean Clip flag
encode_status String Encoding Status
live_encode_start_at String Encoding start date and time
live_encode_end_at String Encoding end date and time
preview Object Live preview image
 src String Live preview image URL
created_at String Created date and time
updated_at String Updated date and time
preview Object Live preview image
 src String Poster image URL

Response Example

HTTP/1.1 200 OK
{
    "merchant_id": "nttsmc",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"Test Live",
    "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"
    }
}

Error Codes

Status Code Code Message
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_NOT_FOUND The specified live event does not exist
500 SERVER_ERROR An unexpected error has occurred

Retrieve Live Event List

This API retrieves live event information.

HTTP Request

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events

URL Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required

Query Parameters

Field Type Description Example
limit Integer Number of items to retrieve 30
page Integer Page number 1
sort String Sort column updated_at
order String Sort order ASC

Response

Field Type Example
id String Live event ID
ref_id String Reference ID
name String Live event name
merchant_id String Subscriber ID
description String Description
live_event_profile_id String Live event profile ID
input_sources Object[] Ingest URL
enable_ad_insertion_flag Boolean Ad insertion flag
media_id String Media ID
enable_live_to_file_flag Boolean Clip flag
encode_status String Encoding Status
live_encode_start_at String Encoding start date and time
live_encode_end_at String Encoding end date and time
preview Object Live preview image
 src String Live preview image URL
created_at String Created date and time
updated_at String Updated date and time

Response Example

HTTP/1.1 200 OK
{
  "count": 30,
  "live_events":
    [
      {<live_event1 fields>},
      {<live_event2 fields>},
      ...
    ]
}

Error Codes

Status Code Code Message
400 BAD_REQUEST Invalid request parameters
401 UNAUTHORIZED Authentication failed
500 SERVER_ERROR An unexpected error has occurred

Create Live Event

This API creates a live event.

HTTP Request

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_events

URL Parameters

Field Type Description Example
merchant_id String Merchant ID nttsmc

Request

Field Type Description Required
name String Live event name Required
description String Description Optional
ref_id String Reference ID Optional
source_type String Input protocol type Optional (Selectable from rtmp, rtp, udp. Default value is rtmp)
enable_ad_insertion_flag Boolean Ad insertion flag Optional
live_event_profile_id String Live event profile ID Required
enable_live_to_file_flag Boolean Clip flag Optional
live_encode_start_at String Encoding start date and time Optional
live_encode_end_at String Encoding end date and time Optional

Response

Field Type Description
merchant_id String Subscriber ID
id String Live event ID
ref_id String Live event reference ID
name String Live event name
description String Description
enable_ad_insertion_flag Boolean Ad insertion flag
live_event_profile_id String Live event profile ID
input_sources Object[] Ingest URL
media_id String Media ID
enable_live_to_file_flag Boolean Clip flag
encode_status String Encoding Status
live_encode_start_at String Encoding start date and time
live_encode_end_at String Encoding end date and time
created_at String Created date and time
updated_at String Updated date and time
preview Object Live preview image
 src String Poster image URL

Response Example

HTTP/1.1 200 OK
{
    "merchant_id": "nttsmc",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"Test Live",
    "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"
    }
}

Error Codes

Status Code Code Message
400 BAD_REQUEST Invalid request parameters
400 FAILED_TO_SAVE Failed to save
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_PROFILE_NOT_FOUND The specified live event profile does not exist
500 SERVER_ERROR An unexpected error has occurred

Start Live Event

This API starts a live event.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
live_event_id String Live event ID id Either live_event_id or ref_id is required
ref_id String Reference ID ref_id  

Response

Field Type Description
merchant_id String Subscriber ID
id String Live event ID
ref_id String Live event reference ID
name String Live event name
description String Description
enable_ad_insertion_flag Boolean Ad insertion flag
live_event_profile_id String Live event profile ID
input_sources Object[] Ingest URL
media_id String Media ID
enable_live_to_file_flag Boolean Clip flag
encode_status String Encoding Status
live_encode_start_at String Encoding start date and time
live_encode_end_at String Encoding end date and time
created_at String Created date and time
updated_at String Updated date and time
preview Object Live preview image
 src String Poster image URL

Response Example

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"
    }
}

Error Codes

Status Code Code Message
400 FAILED_TO_SAVE Failed to save
400 FAILED_TO_START Failed to start
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_NOT_FOUND Authentication failed
500 SERVER_ERROR An unexpected error has occurred

Stop Live Event

This API stops a live event. To restart the live event, it must be reset after stopping.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
live_event_id String Live event ID id Either live_event_id or ref_id is required
ref_id String Reference ID ref_id  

Response

Field Type Description
merchant_id String Subscriber ID
id String Live event ID
ref_id String Live event reference ID
name String Live event name
description String Description
enable_ad_insertion_flag Boolean Ad insertion flag
live_event_profile_id String Live event profile ID
input_sources Object[] Ingest URL
media_id String Media ID
enable_live_to_file_flag Boolean Clip flag
encode_status String Encoding Status
live_encode_start_at String Encoding start date and time
live_encode_end_at String Encoding end date and time
created_at String Created date and time
updated_at String Updated date and time
preview Object Live preview image
 src String Poster image URL

Response Example

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"
    }
}

Error Codes

Status Code Code Message
400 FAILED_TO_STOP Failed to stop
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_NOT_FOUND The specified live event does not exist
500 SERVER_ERROR An unexpected error has occurred

Reset Live Event

This API resets a live event.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
live_event_id String Live event ID id Either live_event_id or ref_id is required
ref_id String Reference ID ref_id  

Response

HTTP/1.1 200 OK

Error Codes

Status Code Code Message
400 FAILED_TO_RESET Failed to reset
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_NOT_FOUND The specified live event does not exist
500 SERVER_ERROR An unexpected error has occurred

Cancel Live Event

This API cancels a live event.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
live_event_id String Live event ID id Either live_event_id or ref_id is required
ref_id String Reference ID id  

Response

HTTP/1.1 200 OK

Error Codes

Status Code Code Message
400 FAILED_TO_CANCEL Failed to cancel
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_NOT_FOUND The specified live event does not exist
500 SERVER_ERROR An unexpected error has occurred

Update Live Event

This API updates live event information.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
live_event_id String Live event ID id Either live_event_id or ref_id is required
ref_id String Reference ID id  

Request Body

Field Type Description
name String Live event name
description String Description
ref_id String Reference ID
enable_ad_insertion_flag Boolean Ad insertion flag
live_event_profile_id String Live event profile ID
enable_live_to_file_flag Boolean Clip flag
live_encode_start_at String Encoding start date and time
live_encode_end_at String Encoding end date and time

Response

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"
    }
}

Error Codes

Status Code Code Message
400 BAD_REQUEST Invalid request parameters
400 FAILED_TO_UPDATE Failed to update
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_NOT_FOUND The specified live event does not exist
404 LIVE_EVENT_PROFILE_NOT_FOUND The specified live event profile does not exist
500 SERVER_ERROR An unexpected error has occurred

Delete Live Event

This API deletes a live event. If you delete a live event during live streaming, it will be deleted after it is stopped.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
live_event_id String Live event ID id Either live_event_id or ref_id is required
ref_id String Reference ID id  

Response

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"
    }
}

Error Codes

Status Code Code Message
400 FAILED_TO_DELETE Failed to delete
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_NOT_FOUND The specified live event does not exist
500 SERVER_ERROR An unexpected error has occurred

Retrieve Live Event Profile by ID or Reference ID

This API retrieves a single live event profile by specifying an ID or reference ID.

HTTP Request

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 Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required
live_event_id String Live event profile ID id Either live_event_profile_id or ref_id is required
ref_id String Reference ID ref_id  

Response

Field Type Description
merchant_id String Merchant ID
id String Live event profile ID
ref_id String Live event profile reference ID
name String Live event profile name
created_at String Created date and time
updated_at String Updated date and time

Error Codes

Status Code Code Message
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_PROFILE_NOT_FOUND The specified live event profile does not exist
500 SERVER_ERROR An unexpected error has occurred

Retrieve Live Event Profile List

This API retrieves live event profiles in bulk.

HTTP Request

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/live_event_profiles

URL Parameters

Field Type Description Example Required
merchant_id String Merchant ID nttsmc Required

Query parameters

Field Type Description Example
limit Integer Number of records to retrieve 30
page Integer Page number 1
sort String Sort column updated_at
order String Sort order ASC

Response

Field Type Description
merchant_id String Merchant ID
id String Live event profile ID
ref_id String Reference ID
name String Live event profile name
description String Description
created_at String Created date and time
updated_at String Updated date and time

Response Example

HTTP/1.1 200 OK
{
  "count": 30,
  "profiles":
    [
      {<profile1 fields>},
      {<profile2 fields>},
      ...
    ]
}

Error Codes

Status Code Code Message
400 BAD_REQUEST Invalid request parameters
401 UNAUTHORIZED Authentication failed
404 LIVE_EVENT_PROFILE_NOT_FOUND The specified live event profile does not exist
500 SERVER_ERROR An unexpected error has occurred