Playback API

Retrieve Media by ID or Reference ID

This API retrieves media information by ID or reference ID.

HTTP Request

GET https://ovp-p-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/:media_id

GET https://ovp-p-api.smartstream.ne.jp/v1/merchants/:merchant_id/medias/ref:ref_id

Request Headers

Please refer here for request headers.

URL Parameters

Field	Type	Description	Example	Required
media_id	String	Media ID	*****	Either media_id or ref_id is required
merchant_id	String	Merchant ID	nttsmc	Required
ec_url	UrlString	Entitlement check URL	https://…	Optional
ref_id	String	Reference ID	video1
user_id	String	User ID	1	Optional

Response

Field	Type	Description
merchant_id	String	Merchant ID
id	String	Media ID
ref_id	String	Reference ID (must be unique within the merchant account)
name	String	Name
description	Text	Description
duration	Number	Duration (milliseconds)
encode_type	String	Encoding type (file or live or scheduled live)
publish_status	String	Publication status
custom_fields	Object	Custom field values, default is {}
publish_geo_rule	String	Geo publishing rule
poster	Object	Poster image
src	String	Poster image URL
thumbnaill	Object	Thumbnail image
src	String	Thumbnail image URL
seek_preview_config	JSON	Seek preview configuration
tags	String[]	Array of tags
offline_enabled	Boolean	Whether offline playback is enabled
sources	Object[]	Array of video sources
text_tracks	Object[]	Array of text tracks
created_at	DateString	Created date and time
updated_at	DateString	Updated date and time

Response Example

{
  "id": "40459b7e6e414652828f98af788f3abc",
  "name": "BigBuckBunny",
  "ref_id": null,
  "description": null,
  "thumbnail": {
      "src": "https://images.smartstream.jp/nttsmc/12345667890/1234567890.jpg"
  },
  "poster": {
      "src": "https://images.smartstream.jp/nttsmc/12345667890/9999999999.jpg"
  },
  "tags": [],
  "encode_type": "",
  "publish_status": "",
  "custom_fields": {},
  "merchant_id": "nttsmc",
  "publish_geo_rule": null,
  "sources": [
    {
      "type": "application/vnd.apple.mpegurl",
      "src": "https://ovp-vod.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/11111111/playlist.m3u8",
      "label": "35f91a9919164562b3dbb109fc27def4",
      "key_systems": {
        "com.apple.fps.1_0": {
          "key_request_url": "https://bees.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/fairplay-license/?token=129y94hqfihliufo98yh2l3oh12luglruahdoczhp8doi2hiu1g",
          "certificate_url": "https://bees.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/fairplay-license/cert/?specConform=true&token=129y94hqfihliufo98yh2l3oh12luglruahdoczhp8doi2hiu1g"
        }
      },
      "id": "791f9297e1da4ada8afcec2bea0c3a31"
    },
    {
      "type": "application/dash+xml",
      "src": "https://ovp-vod.smartstream.jp/nttsmc/1/123567890/manifest.mpd",
      "label": "b5c8614dd18249b5830e3238a28ed71e",
      "key_systems": {
        "com.widevine.alpha": {
          "license_url": "https://bees.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/cenc/?specConform=true&token=129y94hqfihliufo98yh2l3oh12luglruahdoczhp8doi2hiu1g"
        },
        "com.microsoft.playready": {
          "license_url": "https://bees.smartstream.jp/nttsmc/40459b7e6e414652828f98af788f3abc/RightsManager.asmx?token=129y94hqfihliufo98yh2l3oh12luglruahdoczhp8doi2hiu1g"
        }
      },
      "id": "bca76a9f43214294b5d6db7e5acce5c2"
    }
  ],
  "duration": 3600000,
  "text_tracks": [
    {
      "mime_type": "text/vtt",
      "default": false,
      "src": "https://assets.smartstream.jp/nttsmc/1234567890.vtt?mediaId=40459b7e6e414652828f98af788f3abc",
      "asset_id": "1111111111"
      "label": "ES",
      "id": "f696dc837e9a43f6b12e0f039bfb2f89",
      "kind": "captions",
      "lang": "es"
    }
  ],
  "seek_preview_config": null,
  "created_at": "2017-10-01T00:00:00.000Z",
  "updated_at": "2017-10-01T00:00:00.000Z",
  "offline_enabled": false
}

Error Codes

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