playback

playback retrieve

GET

https://odkmedia.io/odx/api/v2

/playback/{id}/

playback retrieve › path Parameters

id

string · required

playback retrieve › query Parameters

debug

string

If value is "on", debug is included in response.

is_lat

integer

Limit Ad Tracking (LAT) lets users opt out and therefore restrict advertisers from targeting based on user behavior.

did

uuid

Device ID from ODK clients

adid

uuid

Advertising ID (Ad ID)

playback retrieve › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

playback retrieve › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2Playback

GET/playback/{id}/

curl https://odkmedia.io/odx/api/v2/playback/:id \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "ad_tag": {
      "ad_tag_url": "https://pubads.g.doubleclick.net/gampad/ads?cmsid=2533206&ad_rule=1&ad_type=video&ciu_szs=300x600,300x250,320x100&env=vp&gdfp_req=1&output=xml_vmap1&sz=640x360&vad_type=linear&vpmute=0&tfcd=0&npa=0&vpa=auto&unviewed_position_start=1&hl=en&vid=637071&scor=1663251801.413168&iu=/114479492/ODK-MobileApp/Android/ROS/Instream-Video_640x360&description_url=https://local.ondemandkorea.com/player/vod/tv-sermon?contentId=637071&url=com.ondemandkorea.android.adsenseformobileapps.com&cust_params=category%3Dreligion%26program%3Dtv-sermon%26episode%3Dtv-sermon-e20220311-5%26partner%3Dcbs%26lang%3Den%26domain%3Dwww.ondemandkorea.com%26membership%3Dguest%26stage%3Ddev%26customAdCue%3D1%26kocowa%3D0",
      "client_params": [
        "did",
        "custom_7"
      ],
      "provider": "gam",
      "schedule": [
        {
          "position": "0",
          "tag_url": "https://pbs.getpublica.com/v1/s2s-hb?format=vast...&pod_duration=90&position=preroll"
        }
      ]
    },
    "age_rating": {
      "is_block": true,
      "label": "All",
      "name": "All"
    },
    "bumper": "kcp",
    "bumper_duration": "3540",
    "cc_languages": [
      {
        "default": true,
        "label": "English",
        "language": "en"
      }
    ],
    "cue_points": [
      {
        "metadata": "metadata",
        "name": "intro-start",
        "timecode": 123.456,
        "type": "CODE"
      }
    ],
    "cw": {
      "duration": 0,
      "episode": {
        "age_rating": {
          "is_block": true,
          "label": "All",
          "name": "All"
        },
        "badges": {
          "bottom_left": "content-new-episode",
          "bottom_right": "bottom_right",
          "top_left": "content-premium",
          "top_right": "content-live"
        },
        "id": 0,
        "images": {
          "thumbnail": "https://www.example.com/path/to/resource"
        },
        "kind": "series",
        "number": 0,
        "part": 0,
        "program": {
          "id": 0,
          "images": {
            "poster": "https://www.example.com/path/to/resource",
            "poster_landscape": "https://www.example.com/path/to/resource",
            "poster_portrait": "https://www.example.com/path/to/resource"
          },
          "slug": "slug",
          "title": "title"
        },
        "slug": "slug",
        "title": "title",
        "video_cc_languages": [
          "ko"
        ],
        "video_duration": 0
      },
      "episode_id": 0,
      "last_position": 0,
      "program_id": 0,
      "progress_ratio": 0,
      "session_key": "session_key",
      "total_play_time": 0,
      "updated_at": "2024-08-25T15:00:00Z",
      "user_id": 0,
      "watched": true
    },
    "cwl_call_cycle": 30000,
    "drm": {
      "authorization": {
        "fairplay": {
          "certificate_url": "https://lic.drmtoday.com/license-server-fairplay/cert/odkmedia",
          "license_request_headers": [
            {
              "name": "Content-type",
              "value": "application/x-www-form-urlencoded"
            }
          ],
          "license_response_type": "text",
          "process_spc_url": "https://lic.drmtoday.com/license-server-fairplay/"
        },
        "playready": {
          "key_server_url": "https://lic.drmtoday.com/license-proxy-headerauth/drmtoday/RightsManager.asmx"
        },
        "widevine": {
          "key_server_url": "https://lic.drmtoday.com/license-proxy-widevine/cenc/"
        }
      },
      "base": {
        "asset_id": "e719bcbe5c4d86963d92d39c5d6f58459acf9564fead2a7ad9d9cb21532bcbd0",
        "merchant": "odkmedia",
        "session_id": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXJ2aWNlX25hbWUiOiJvZGsiLCJlcGlzb2RlX2lkIjo4NDE1NDMsImVuY3J5cHRpb25faWQiOiJlNzE5YmNiZTVjNGQ4Njk2M2Q5MmQzOWM1ZDZmNTg0NTlhY2Y5NTY0ZmVhZDJhN2FkOWQ5Y2IyMTUzMmJjYmQwIiwiZHJtX3Nlc3Npb24iOiI3ZTJmOWEyMy1lMWI5LTQ2YzAtYjgwNC1kN2Q5NzYwYzM4ODcifQ.HxNUmEzfcjhH42mgUJ2MnVDFuSiWY7mD9bzFqSWUIQg",
        "user_id": "7e2f9a23-e1b9-46c0-b804-d7d9760c3887",
        "variant": "prod"
      }
    },
    "duration": 7267798,
    "episode": {
      "id": 0,
      "images": {
        "thumbnail": "https://www.example.com/path/to/resource"
      },
      "is_kocowa": true,
      "kind": "series",
      "next_episode": {
        "id": 0,
        "images": {
          "thumbnail": "https://www.example.com/path/to/resource"
        },
        "is_kocowa": true,
        "kind": "series",
        "number": 0,
        "part": 0,
        "program": {
          "id": 0,
          "images": {
            "poster": "https://www.example.com/path/to/resource",
            "poster_landscape": "https://www.example.com/path/to/resource",
            "poster_portrait": "https://www.example.com/path/to/resource"
          },
          "slug": "slug",
          "title": "title"
        },
        "release_date": "2024-08-25",
        "slug": "slug",
        "title": "title"
      },
      "number": 0,
      "part": 0,
      "program": {
        "id": 0,
        "images": {
          "poster": "https://www.example.com/path/to/resource",
          "poster_landscape": "https://www.example.com/path/to/resource",
          "poster_portrait": "https://www.example.com/path/to/resource"
        },
        "slug": "slug",
        "title": "title"
      },
      "release_date": "2024-08-25",
      "sales_type": "GUEST",
      "slug": "slug",
      "title": "title"
    },
    "external": {
      "kcp": {
        "asset_id": "asset_id",
        "episode_number": 0,
        "service_type": "service_type",
        "user_id": "user_id",
        "user_type": "Anonymous",
        "vod_type": "vod_type"
      }
    },
    "id": 123,
    "manifests": [
      {
        "preset": "1080p",
        "type": "hls",
        "url": "https://hls.ondemandkorea.com/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8"
      }
    ],
    "program": {
      "categories": [
        {
          "id": 0,
          "slug": "slug",
          "title": "title"
        }
      ],
      "genres": [
        {
          "id": 0,
          "slug": "slug",
          "title": "title"
        }
      ],
      "id": 0,
      "images": {
        "poster": "https://www.example.com/path/to/resource",
        "poster_landscape": "https://www.example.com/path/to/resource",
        "poster_portrait": "https://www.example.com/path/to/resource"
      },
      "is_favorite": true,
      "provider": {
        "name": "name",
        "slug": "slug"
      },
      "slug": "slug",
      "synopsis": "synopsis",
      "title": "title"
    },
    "source": "inhouse",
    "sources": [
      {
        "preset": "1080p",
        "type": "hls",
        "url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8"
      }
    ],
    "storyboards_url": {
      "vtt": "vtt"
    },
    "text_tracks": [
      {
        "codec": "ass",
        "default": true,
        "label": "en-US",
        "language": "English",
        "url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt"
      }
    ]
  }
}

json

application/json

payment program

playback retrieve

GET

https://odkmedia.io/odx/api/v2

/playback/{id}/

playback retrieve › path Parameters

id

string · required

playback retrieve › query Parameters

debug

string

If value is "on", debug is included in response.

is_lat

integer

Limit Ad Tracking (LAT) lets users opt out and therefore restrict advertisers from targeting based on user behavior.

did

uuid

Device ID from ODK clients

adid

uuid

Advertising ID (Ad ID)

playback retrieve › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

playback retrieve › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2Playback