API docs by Redocly

ODX/V3 API (v3)

Download OpenAPI specification:

base

Check allowed region

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

ODX-User-Agent
string
Example: ODX ea961...

Bearer is ODX. If there is no ODX token, the backend assumes that a request is coming from the web platform.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object

check allowed region

is_allowed_region
boolean

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Get client base informations

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

ODX-User-Agent
string
Example: ODX ea961...

Bearer is ODX. If there is no ODX token, the backend assumes that a request is coming from the web platform.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3ClientBase)
object (OdxV3SplashScreen)
Array of objects
Array of objects

support promotion screens and interstitial ads(for mobile apps)

object (OdxV3ClientVersion)
client_version
string
store_link
string
force_update
string
object (OdxV3ClientConfig)
object

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

user

sign in

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
email
required
string <email> (Email) non-empty
password
required
string (Password) [ 1 .. 256 ] characters
keep
boolean
Default: false

In ODK, default value is true. If keep is true, expiration time is 1 year. Default expiration time is 1 day.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserToken)
token
required
string (Token) non-empty
required
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string",
  • "keep": false
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

sign in v2

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
email
string <email> (Email) non-empty
password
string (Password) [ 1 .. 256 ] characters
phone
string <phone> (Phone)
verification
string (Verification) [ 5 .. 10 ] characters
keep
boolean
Default: false

In ODK, default value is true. If keep is true, expiration time is 1 year. Default expiration time is 1 day.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserToken)
token
required
string (Token) non-empty
required
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Request samples

Content type
application/json
Example
{
  • "email": "hero@odkmedia.net",
  • "password": "secret_password"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

sign up

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
email
required
string <email> (Email) [ 1 .. 256 ] characters
password
required
string (Password) [ 5 .. 59 ] characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserToken)
token
required
string (Token) non-empty
required
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

sign up v2

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
email
string <email> (Email) non-empty
password
string (Password) [ 1 .. 256 ] characters
phone
string <phone> (Phone)
verification
string (Verification) [ 5 .. 10 ] characters
keep
boolean
Default: false

In ODK, default value is true. If keep is true, expiration time is 1 year. Default expiration time is 1 day.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserToken)
token
required
string (Token) non-empty
required
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
Example
{
  • "email": "hero@odkmedia.net",
  • "password": "secret_password"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

sign out

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

profile

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
gender
string or null (Gender)
Enum: "m" "f" "na" "other"
birthday
string or null <date> (Birthday)

The format should be YYYY-MM-DD, not YYYYMMDD like other version APIs.

language
string (Language)
Default: "en"
Enum: "en" "ko" "zh-hans" "zh-hant" "es" "pt"
is_receive_mail
boolean (Is receive mail)
postal_code
string or null (Postal Code) <= 20 characters
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
object (OdxV3UserProfileExternalKCPInformationSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

profile

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
object or null (OdxV3UserInfo)
gender
string or null (Gender)
Enum: "m" "f" "na" "other"
birthday
string or null <date> (Birthday)

The format should be YYYY-MM-DD, not YYYYMMDD like other version APIs.

language
string (Language)
Default: "en"
Enum: "en" "ko" "zh-hans" "zh-hant" "es" "pt"
is_receive_mail
boolean (Is receive mail)
postal_code
string or null (Postal Code) <= 20 characters
object (OdxV3UserProfileExternalSerializer)
object (OdxV3UserProfileExternalKCPInformationSerializer)
user_id
string or null

Hashed value from user's uuid (Set null if anonymous user)

user_type
string
Enum: "Anonymous" "Non-Sub" "<Subscription Product Code>"

User type for KCP data analytics

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
gender
string or null (Gender)
Enum: "m" "f" "na" "other"
birthday
string or null <date> (Birthday)

The format should be YYYY-MM-DD, not YYYYMMDD like other version APIs.

language
string (Language)
Default: "en"
Enum: "en" "ko" "zh-hans" "zh-hant" "es" "pt"
is_receive_mail
boolean (Is receive mail)
postal_code
string or null (Postal Code) <= 20 characters
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
object (OdxV3UserProfileExternalKCPInformationSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Request samples

Content type
application/json
{
  • "userinfo": {
    },
  • "external": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

profile

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
object or null (OdxV3UserInfo)
gender
string or null (Gender)
Enum: "m" "f" "na" "other"
birthday
string or null <date> (Birthday)

The format should be YYYY-MM-DD, not YYYYMMDD like other version APIs.

language
string (Language)
Default: "en"
Enum: "en" "ko" "zh-hans" "zh-hant" "es" "pt"
is_receive_mail
boolean (Is receive mail)
postal_code
string or null (Postal Code) <= 20 characters
object (OdxV3UserProfileExternalSerializer)
object (OdxV3UserProfileExternalKCPInformationSerializer)
user_id
string or null

Hashed value from user's uuid (Set null if anonymous user)

user_type
string
Enum: "Anonymous" "Non-Sub" "<Subscription Product Code>"

User type for KCP data analytics

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
gender
string or null (Gender)
Enum: "m" "f" "na" "other"
birthday
string or null <date> (Birthday)

The format should be YYYY-MM-DD, not YYYYMMDD like other version APIs.

language
string (Language)
Default: "en"
Enum: "en" "ko" "zh-hans" "zh-hant" "es" "pt"
is_receive_mail
boolean (Is receive mail)
postal_code
string or null (Postal Code) <= 20 characters
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
object (OdxV3UserProfileExternalKCPInformationSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Request samples

Content type
application/json
{
  • "userinfo": {
    },
  • "external": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

user modify

A phone user can add an email address and an email user can add a phone number.

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
email
string <email> (Email) non-empty
phone
string <phone> (Phone)
verification
string (Verification) [ 5 .. 10 ] characters
password
string (Password) [ 5 .. 59 ] characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
gender
string or null (Gender)
Enum: "m" "f" "na" "other"
birthday
string or null <date> (Birthday)

The format should be YYYY-MM-DD, not YYYYMMDD like other version APIs.

language
string (Language)
Default: "en"
Enum: "en" "ko" "zh-hans" "zh-hant" "es" "pt"
is_receive_mail
boolean (Is receive mail)
postal_code
string or null (Postal Code) <= 20 characters
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
object (OdxV3UserProfileExternalKCPInformationSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Request samples

Content type
application/json
Example

Users without an email can add an email.

{
  • "email": "hero@odkmedia.net"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

user modify

A phone user can replace with new phone number and an email user can modify with new email address.

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
email
string <email> (Email) non-empty
phone
string <phone> (Phone)
verification
string (Verification) [ 5 .. 10 ] characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
gender
string or null (Gender)
Enum: "m" "f" "na" "other"
birthday
string or null <date> (Birthday)

The format should be YYYY-MM-DD, not YYYYMMDD like other version APIs.

language
string (Language)
Default: "en"
Enum: "en" "ko" "zh-hans" "zh-hant" "es" "pt"
is_receive_mail
boolean (Is receive mail)
postal_code
string or null (Postal Code) <= 20 characters
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
object (OdxV3UserProfileExternalKCPInformationSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Request samples

Content type
application/json
Example
{
  • "email": "hero@odkmedia.net",
  • "verification": "value_secret"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

delete account

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
password
string (Password) [ 1 .. 256 ] characters

If user's login_type is email, then password is required.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

change password

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
password
required
string (Password) [ 5 .. 59 ] characters
new_password
required
string (New password) [ 5 .. 59 ] characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserToken)
token
required
string (Token) non-empty
required
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Request samples

Content type
application/json
{
  • "password": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

user orders pay-per-view

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of objects (OdxV3UserOrdersPayPerView)
Array
ordered_date
string <date> (Ordered Date)
product_name
string (Product Name)
amount
string (Amount)
method
string (Method)
Default: "CC"
status
string (Status)
Enum: "Paid" "Failed"
option
string (Option)
Default: "Pay-Per-View VOD (Non Refundable)"
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

user/social-auth

auth with facebook

Authorize with response from 'Facebook login'

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
access_token
required
string

Access token

expires_in
required
integer >= 0

Time remaining before token expires (second)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserToken)
token
required
string (Token) non-empty
required
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

auth with apple

Authorize with response from 'Sign in with Apple'

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
code
required
string

Authorization code

redirect_uri
string

Redirect URI used in initial authorization request

email
string <email>
first_name
string
last_name
string

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserToken)
token
required
string (Token) non-empty
required
object (OdxV3UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV3UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook" "phone"
subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

subscription_provider
string or null (Subscription provider)
Enum: "web" "apple" "google" "roku"
subscription_trial_end_date
string or null <date> (Subscription trial end date)
subscription_price
number or null <float> (Subscription price)
subscription_interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
subscription_expire_date
string or null <date> (Subscription expire date)

subscription expire date or admin coupon expire date

subscription_is_cancellable
boolean (Subscription is cancellable)
Default: false

The value True means cancellable with active subscription and False means already canceled or etc.

object (OdxV3UserProfileExternalSerializer)
is_odk_coupon_user
boolean (Is ODK coupon user)
subscription_max_profile_count
integer (Subscription Max Profile Count)
  • This value is the maximum number of Profiles a user can create.
  • If the user is not a subscription user, the value is '1'.
subscription_product_code
string (Subscription Product Code)
member_id
string (Member ID)

ODK User's member ID for Loyalty program (Reward)

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "code": "string",
  • "redirect_uri": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

disconnect

Authorizations:
RequiredToken
path Parameters
backend_name
required
string
Enum: "facebook" "apple"
query Parameters
debug
string

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

de-authorize

path Parameters
backend_name
required
string
Enum: "facebook" "apple"
service_name
required
string
query Parameters
debug
string

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

user/verify-email

verify email

send email to verify account's email

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

verify email confirm

validate hash value to verify email

query Parameters
debug
string

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

Request Body schema: application/json
required
hash
required
string (Hash) non-empty

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "hash": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

user/change-email

change email

send email to change account's email

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
new_email
required
string <email> (New email) non-empty

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "new_email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

change email confirm

change email with hash value

query Parameters
debug
string

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

Request Body schema: application/json
required
hash
required
string (Hash) non-empty

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "hash": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

user/reset-password

reset password

query Parameters
debug
string

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

Request Body schema: application/json
required
hash
required
string (Hash) non-empty
new_password
required
string (New password) [ 1 .. 256 ] characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "hash": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

reset password email

send email to reset forgot password

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
email
required
string <email> (Email) non-empty

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

reset password email confirm

validate hash value to reset password

query Parameters
debug
string

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

Request Body schema: application/json
required
hash
required
string (Hash) non-empty

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "hash": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

user/qr-login

Initialize QR Login

Get initial values for QR login

query Parameters
debug
string

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

from
string
Example: from=samsung
  • If platform is Samsung TV, this field should be 'samsung'. Otherwise, client don't need to send this.
  • If you send '' or null as this field, the value will be included in redirect_url (like, https://odk.com/?device=)
to
string
Example: to=sign-up
  • If you send '' or null as this field, the value will be included in redirect_url (like, https://odk.com/?to=)
product_code
string
Example: product_code=ODK-STANDARD-SAMSUNG-1-MONTH
  • If you send '' or null as this field, the value will be included in redirect_url (like, https://odk.com/?product_code=)
header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
verify_code
string (Verify code) = 6 characters
redirect_url
string (Redirect URL)

base path is decided by BE. If url can be shortened, short_url is returned. If not, this is same as full_redirect_url.

full_redirect_url
string (Full Redirect URL)

base path is decided by BE (Full URL)

qrcode
string (QR code (base64 encoded))

The value full_redirect_url?verify_code=verify_code is encoded

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Verfiy code for QR Login

Verify code for QR Login

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
verify_code
required
string (Verify code) = 6 characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "verify_code": 123456
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

Check status for QR Login

Check status for QR Login. If success, will be returned user's token

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
verify_code
required
string (Verify code) = 6 characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3QRLoginVerifyCheck)
verify_code
string (Verify code) = 6 characters
status
string
Enum: "initialize" "verified" "expired"
token
string
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "verify_code": 123456
}

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

user/qr/pass

Initialize QR Pass

Get initial values for QR Pass

Authorizations:
RequiredToken
query Parameters
debug
string

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

from
string
Example: from=samsung
  • If platform is Samsung TV, this field should be 'samsung'. Otherwise, client don't need to send this.
  • If you send '' or null as this field, the value will be included in redirect_url (like, https://odk.com/?device=)
to
string
Example: to=sign-up
  • If you send '' or null as this field, the value will be included in redirect_url (like, https://odk.com/?to=)
product_code
string
Example: product_code=ODK-STANDARD-SAMSUNG-1-MONTH
  • If you send '' or null as this field, the value will be included in redirect_url (like, https://odk.com/?product_code=)
header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
verify_code
string (Verify code) = 6 characters
redirect_url
string (Redirect URL)

base path is decided by BE. If url can be shortened, short_url is returned. If not, this is same as full_redirect_url.

full_redirect_url
string (Full Redirect URL)

base path is decided by BE (Full URL)

qrcode
string (QR code (base64 encoded))

The value full_redirect_url?verify_code=verify_code is encoded

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Verfiy code for QR Pass

Verify code for QR Pass. If success, CTV account token will be returned,

Authorizations:
OptionalToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
verify_code
required
string (Verify code) = 6 characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
status
string (Status)
Enum: "no_credential" "credential_matched" "credential_mismatched"
  • If request doesn’t include ODX token, status is "no_credential".
  • If request includes ODX token and owner of the token is equal to CTV account, status is "credential_matched".
  • If request includes ODX token and owner of the token is different with CTV account, status is "credential_mismatched".
object
id
string (ID)
email
string <email> (Email)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "verify_code": 123456
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Sync auth from other client

Sync auth from other client (CTV)

Authorizations:
OptionalToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
verify_code
required
string (Verify code) = 6 characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
token
string (Token)

You can know source of token through its length.

  • If its length is 60, it was created from IO.
  • If its length is 40, it was used as legacy device token and migrated to IO.
  • If its length is 32, it was used as legacy web token and migrated to IO.
object
id
string (ID)
email
string <email> (Email)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "verify_code": 123456
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Check status for QR Pass

Check status for QR Pass.

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
verify_code
required
string (Verify code) = 6 characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "verify_code": 123456
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

user/favorites

user favorites list

Authorizations:
RequiredToken
query Parameters
debug
string

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

page
integer

The default value is 1

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
object or null (ProgramImages)
object or null (EpisodeIdentifiers)
is_favorite
boolean
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {}
}

user favorites create

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
program_slug
required
string (Program Slug) non-empty

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (FavoritesProgram)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
object or null (ProgramImages)
poster
string or null <uri> (Poster)
poster_landscape
string or null <uri> (Poster landscape)
poster_portrait
string or null <uri> (Poster portrait)
object or null (EpisodeIdentifiers)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
is_favorite
boolean
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "program_slug": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {}
}

user favorites delete

Authorizations:
RequiredToken
path Parameters
slug
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { }
}

user favorites remove all

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { }
}

registration-status

Show user status based on account_id(phone number, email)

path Parameters
account_id
required
string

User account id to search for in odk db(email or phone number)

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object

user status

login_type
string
Enum: "facebook" "apple" "email" "roku" "phone"
is_registered
boolean
account_id
string
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

otp

send otp

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
account_id
required
string <emailphone> (account_id) non-empty

An email or phone number to send OTP

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3SendOTP)
account_id
integer (user id)
displayable_id
string (String to show users on client side)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "account_id": "hero@odkmedia.net or +13023932048"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

verify otp

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
required
verification
string <emailphone> (account_id)

account id to send OTP

otp
required
string (OTP)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (result)
verification
string (verification)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "verification": "+13023932048",
  • "otp": "2288"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

user/new-token

Create a new token using a legacy token

  • This API will only succeed when authenticating with a legacy token (32 characters).
  • Even if it's a valid token, if it's not a legacy token (32 characters), you'll get a 401 error.
Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3UserTokenOnly)
token
required
string (Token) non-empty
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

navigation

navigation list

query Parameters
debug
string

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

page
integer

The default value is 1

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Home slug for url

service_name
string (Service Name)
Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

Array of objects or null (OdxV3FirstNavigation)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

navigation retrieve

  • The slug of ODK header navigation: header-navigation-default
path Parameters
slug
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3Navigation)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Home slug for url

service_name
string (Service Name)
Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

Array of objects or null (OdxV3FirstNavigation)
Array
slug
required
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
type
required
string (Type)
Enum: "category" "genre" "link"
ratio
string (Ratio)
Enum: "portrait" "landscape"
title
string (Title)
seo_title
string (Seo title)
seo_description
string (Seo description)
seo_keywords
string (Seo keywords)
og_image
string (Og image)
background_image
string (background image)
link
string (link)
Array of objects or null or null (OdxV3SecondNavigation)

The items is a list of child category. The max depth is 3. The schema is the same as the parent category. Please refer to the example data.

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

cover

cover list

Authorizations:
(OptionalTokenProfileOptionalToken)
query Parameters
debug
string

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

page
integer

The default value is 1

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$

Home slug for url

object (CoverContents)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

cover retrieve

  • The slug of ODK main banner: home-cover-default
  • The slug of ODK category page's banner: category-cover-{category_slug} (e.g. category-cover-drama)
Authorizations:
(OptionalTokenProfileOptionalToken)
path Parameters
slug
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3Cover)
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$

Home slug for url

object (CoverContents)
Array of objects (CoverItem)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

curation

curation retrieve

  • The slug of ODK home carousels: home-curation-default
Authorizations:
(OptionalTokenProfileOptionalToken)
path Parameters
slug
required
string
new_carousel_type
bool
Example: true

Include special carousels if True

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3Curation)
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$

Home slug for url

service_name
string (Service Name)
Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

Array of objects (OdxV3CurationContent)
Array
slug
string (Slug)
type
string (Type)
Enum: "episode" "program"
carousel_type
string (Carousel Type)
Enum: "special" "local" "normal" "none"
ratio
string (Ratio)
Enum: "portrait" "landscape"
title
string or null (Title)
title_url
string or null (Title url)
max
integer or null (Max)
manual_ids
Array of integers or null
program_direct_play
boolean or null (Program direct play)
logic_category
integer or null (Logic category)
logic_ordering
string or null (Logic ordering)
Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"
  • Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
  • Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
  • Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"
object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

object
(Array of Carousels (EpisodeList (object) or ProgramList (object) or SimpleEpisodeList (object) or SimpleProgramList (object))) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) or CarouselsForChannel (object) (Carousels)
  • type == episode: Carousels.EpisodeList
  • type == program: Carousels.ProgramList
  • type == episode and carousel_type in [special, local, normal] : Carousels.SimpleEpisodeList
  • type == program and carousel_type in [special, local, normal] : Carousels.SimpleProgramLis
  • logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
  • logic_ordering == episode-continue-watching: CarouselsForContinueWatching

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

curation content list

  • This API returns curation contents without carousel items.
  • The slug of ODK home carousels: home-curation-default
Authorizations:
(OptionalTokenProfileOptionalToken)
path Parameters
slug
required
string
new_carousel_type
bool
Example: true

Include special carousels if True

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3CurationWithoutCarousels)
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$

Home slug for url

service_name
string (Service Name)
Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

contents
Array of slug

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

curation content retrieve

  • This API returns only 1 carousel in contents field that is requested with a content_slug.
  • The slug of ODK home carousels: home-curation-default
Authorizations:
(OptionalTokenProfileOptionalToken)
path Parameters
slug
required
string
new_carousel_type
bool
Example: true

Include special carousels if True

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3CurationContentRetrieve)
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$

Home slug for url

service_name
string (Service Name)
Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (OdxV3CurationContent)
slug
string (Slug)
type
string (Type)
Enum: "episode" "program"
carousel_type
string (Carousel Type)
Enum: "special" "local" "normal" "none"
ratio
string (Ratio)
Enum: "portrait" "landscape"
title
string or null (Title)
title_url
string or null (Title url)
max
integer or null (Max)
manual_ids
Array of integers or null
program_direct_play
boolean or null (Program direct play)
logic_category
integer or null (Logic category)
logic_ordering
string or null (Logic ordering)
Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"
  • Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
  • Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
  • Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"
object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

object
(Array of Carousels (EpisodeList (object) or ProgramList (object) or SimpleEpisodeList (object) or SimpleProgramList (object))) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) or CarouselsForChannel (object) (Carousels)
  • type == episode: Carousels.EpisodeList
  • type == program: Carousels.ProgramList
  • type == episode and carousel_type in [special, local, normal] : Carousels.SimpleEpisodeList
  • type == program and carousel_type in [special, local, normal] : Carousels.SimpleProgramLis
  • logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
  • logic_ordering == episode-continue-watching: CarouselsForContinueWatching

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

playback

playback retrieve

Authorizations:
(OptionalTokenProfileOptionalToken)
path Parameters
id
required
string
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)

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
IP-Version
string
Enum: "ipv4" "ipv6"

Which IP version

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (video)
duration
integer or null

video's duration info (millisecond)

source
string or null
Enum: "inhouse" "relay" "mediahold"

asset type of video source

Array of objects

In case of Non-drm video, there is only one URL of the highest resolution for the current user available, whereas there are two URLs of the highest resolution for the user in case of DRM video.

Array
type
string
Enum: "hls" "file" "widevine" "fairplay"

hls: Non-drm / widevine: widevine and playready(DRM) / fairplay: fairplay(DRM)

url
string
preset
string or null

preset is only used when asset_type is one of inhouse, relay, mediahold.

Array of objects

If asset_type is in inhouse, relay, and mediahold (the asset stored in s3), text_tracks is required.

Array
language
string

key for text_tracks

label
string or null

display name of text_tracks

url
string
codec
string or null
Enum: "ass" "srt" "vtt"
default
boolean or null
id
integer or null <int64>

ID of video.api object(Video Asset)

Array of objects or null

cue_points isn't used in phase 1.

Array
metadata
string or null
name
string

ex: intro-start, intro-end, start, end, ...

type
string

ex: AD, CODE, ...

timecode
string
bumper_duration
integer or null

video's bumper duration info

bumper
string or null
Value: "kcp"
object (OdxV3PlaybackDRM) >= 0 properties

If Non-drm video, drm: {} in response

object (Base)
object (Authorization)
Array of objects

sources(video) + text_tracks(subtitles) = manifests (In URL, adverising parameters are added like sources.)

Array
type
string
Enum: "hls" "file" "widevine" "fairplay"
url
string
preset
string or null

Paid users can watch up to 1080p, but others can watch up to 720p.

Array of objects

language codes and settings for subtitles in manifests

Array
language
string
label
string
default
boolean

Korean always default=true. English also always default=true but when there is no Korean. Others always defualt=false.

cwl_call_cycle
integer (The interval at which the client will make calls.(Milliseconds))
Default: 30000
is_chromecast_able
boolean (Is chromecast able)

Whether the video can be casted to chromecast

object or null (continue-watching)

OdxV3ContinuousWatchingHistory

user_id
integer (User id)
program_id
integer (Program id)
episode_id
integer (Episode id)
session_key
string (Session key)
total_play_time
number (Total play time)

The total viewing time

last_position
number (Last position)

The last watched point

duration
number (Duration)

The video length(duration)

progress_ratio
number (Progress ratio)

last_position divided by total_play_time

watched
boolean (Watched)

True if progress_ratio is larger than 90%

updated_at
string <date-time> (Updated at)
object (OdxV3CWEpisode)
object or null (AgeRating)
label
string (Label)
Enum: "All" "PG" "12+" "13+" "14+" "15+" "16+" "17+" "18+" "19+" "NR"
name
string (Name)
Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
is_block
boolean (Is block)
object or null

If there's no file info for storyboards, this field returns null.

vtt
string or null

vtt file's url for storyboards feature.

object (OdxV3PlaybackEpisodeWithSalesType)
id
integer
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
kind
string
Enum: "series" "main" "trailer" "additional" "clip"
number
integer
part
integer
title
string
object (ProgramForEpisodeList)
object or null (EpisodeImages)
sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
release_date
string <date> (Recently broadcast date)
is_kocowa
boolean (Is KOCOWA)

Whether this episode is in KOCOWA category

object (OdxV3PlaybackEpisode)
object (OdxV3PlaybackProgram)
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
title
string (Title)
synopsis
string (Synopsis)
object (ProgramProvider)
object or null (ProgramImages)
Array of objects or null (Category)
Array of objects or null or null (Genre)
is_favorite
boolean (Is Favorite)
object or null (Video advertisement information)
provider
string
Enum: "gam" "publica"

Advertisement provider

ad_tag_url
string

Full advertisement tag url

client_params
Array of strings

Client must set parameters

Array of objects

VAST tags which will be used on Roku and AppleTV.

object
object or null (External info (KCP))
Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

object

In playback API, this fields has __block key that contains information for block screen.

<error_field_name>
string
__default
string
title
string
message
string
object

Information for block screen. (e.g. user's subscription information, ppv episode's sales info)

type
string
Enum: "ppv" "concurrent-watching-limit" "premium" "region-block" "anonymous-block"

Type of block screen.

object or null
Array of objects or null
object or null
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{}

playback-log

playback log create

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

programs

programs list

Authorizations:
(OptionalTokenProfileOptionalToken)
query Parameters
debug
string

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

categories
integer

ID of program's category

categories__slug
string

Slug of program's category

genres
integer

ID of program's genres

genres__slug
string

Slug of program's genres

release_status
string
Enum: "on-air" "coming-soon" "completed" "unknown"

Program's release status

subtitles
string
Enum: "ko" "en" "es" "zh-hans" "zh-hant" "pt"

Program's subtitles(cc languages)

provider
string

Program's provider slug (ODK only) (e.g. mbc, sbs, kbs) / If etc with drama category slug, all programs except for KBS, MBC, SBS, JTBC, Channel A, TV Chosun, and MBN will be returned.

order
string
Enum: "recent-updated" "popular" "popular-yesterday" "popular-weekly" "popular-monthly" "popular-90days"

Program's order. popular is equal to popular-yesterday

search
string

Text to search data

page
integer

The default value is 1

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$

Program slug

object or null (ProgramImages)
object (Badges)
is_favorite
boolean
content_description
string

This field's value is localized title.

latest_publish_start
string <date-time>

(UTC) Publish_start Datetime of program's latest episode. (e.g. 2022-08-02T00:00:00Z)

publish_start
string <date-time>

(UTC) Publish_start Datetime of program. (e.g. 2022-08-02T00:00:00Z)

kinds_of_episodes
Array of strings (Kinds of episodes)
Items Enum: "series" "main" "trailer" "additional" "clip"

Kinds of episode that the program has.

Array of objects or null (PersonRole)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

program

program retrieve

Authorizations:
(OptionalTokenProfileOptionalToken)
path Parameters
slug
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3Program)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
uuid
string <uuid> (Uuid)

This value is not editable.

title
string (Title) non-empty
secondary_title
string (Secondary Title) non-empty
synopsis
string (Synopsis) non-empty
seo_title
string (Title(SEO)) non-empty
seo_synopsis
string (Synopsis(SEO)) non-empty
seo_keyword
string (Keyword(SEO)) non-empty
produce_year
integer or null (Produce year)

yyyy

release_status
string (Release status)
Enum: "coming-soon" "completed" "on-air" "unknown"
default_sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
object or null (ProgramImages)
poster
string or null <uri> (Poster)
poster_landscape
string or null <uri> (Poster landscape)
poster_portrait
string or null <uri> (Poster portrait)
object or null (OdxV3ProgramMeta)
episode_total
integer or null (Episode total)
produce_countries
Array of strings or null
Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"
cc_languages
Array of strings or null
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
running_time
integer or null (Running time)

unit: minutes

hide_ep_date
boolean (Hide episode date)
iab_content_taxonomies
string or null (IAB Content Taxonomies)
Array of objects or null (Category)
Array
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
title
string (Title) non-empty
Array of objects or null or null (Genre)
Array
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
title
string (Title)
object or null (EpisodeIdentifiers)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
object or null (EpisodeIdentifiers)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
Array of objects or null or null (PersonRole)
Array
role
string (Role) non-empty
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
name
string (Name) non-empty
info
object or null (Info)
is_coming_soon
boolean (Is coming soon)

If this program has episode (except for trailer, clip episodes), this value is true.

kinds_of_episodes
Array of strings (Kinds of episodes)
Items Enum: "series" "main" "trailer" "additional" "clip"

Kinds of episode that the program has.

is_favorite
boolean (Is Favorite)
object or null
object
object
object or null
price
number <float> (Price)
currency
string (Currency) <= 3 characters
product_code
string (Product code) <= 50 characters
tier
string or null (Tier)
Array of objects (OdxV3BundlePromotion)
object
top_left
string or null (Top left)
top_right
string or null (Top right)
bottom_left
string or null (Bottom left)
bottom_right
string or null (Bottom right)
publish_start
string <date-time>

(UTC) Publish_start Datetime of program. (e.g. 2022-08-02T00:00:00Z)

partner
string <slug> (Partner) ^[-a-zA-Z0-9_]+$

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

program episodes list

Authorizations:
(OptionalTokenProfileOptionalToken)
path Parameters
slug
required
string
query Parameters
debug
string

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

kind
Array of strings
Items Enum: "series" "main" "trailer" "additional" "clip"

You can pass several kinds, e.g. kind=series,main.

page
integer

The default value is 1

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
uuid
string <uuid> (Uuid)

This value is not editable.

kind
string (Kind)
Enum: "series" "main" "trailer" "additional" "clip"
number
integer (Number)
part
integer (Part)
release_date
string <date> (Recently broadcast date)
sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
title
string (Title) non-empty
synopsis
string (Synopsis) non-empty
seo_title
string (Title(SEO)) non-empty
seo_synopsis
string (Synopsis(SEO)) non-empty
seo_keyword
string (Keyword(SEO)) non-empty
object or null (EpisodeImages)
video_duration
integer or null (Video duration)

millisecond(ms)

display_duration
string (Display duration)

Display duration of video

video_cc_languages
Array of strings or null
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
object or null (AgeRating)
object (Badges)
object
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

episode

episode retrieve

path Parameters
id
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3Episode)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
kind
string (Kind)
Enum: "series" "main" "trailer" "additional" "clip"
title
string (Title) non-empty
object or null (EpisodeImages)
thumbnail
string or null <uri> (Thumbnail)
seo_title
string (Title(SEO)) non-empty
seo_keyword
string (Keyword(SEO)) non-empty
seo_synopsis
string (Synopsis(SEO)) non-empty
release_date
string <date> (Recently broadcast date)
number
integer (Episode number)
duration
integer (Video duration)

millisecond(ms)

object or null (AgeRating)
label
string (Label)
Enum: "All" "PG" "12+" "13+" "14+" "15+" "16+" "17+" "18+" "19+" "NR"
name
string (Name)
Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
is_block
boolean (Is block)
object (ProgramForEpisodeRetrieve)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
title
string (Title) non-empty
synopsis
string (Synopsis)
object or null (ProgramImages)
produce_year
integer or null (Produce year)

yyyy

object or null (AgeRating)
Array of objects or null or null (Genre)
object or null (OdxV3ProgramMeta)
partner
string <slug> (Partner) ^[-a-zA-Z0-9_]+$
original_episode
integer or null (ID)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

episode/recommendation

episode recommendation retrieve

path Parameters
id
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
Array of items (OdxV3RecommendationPrograms)
object (OdxV3RecommendationProgramItem)
countdown
integer (countdown)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{}

category

category retrieve

path Parameters
slug
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3Category)
id
integer
slug
string <slug> ^[-a-zA-Z0-9_]+$
title
string (title)
object
Array of objects (CategoryFilterOptionItem)

if the category does not have this item, empty array is returned.

Array of objects (CategoryFilterOptionItem)

if the category does not have this item, empty array is returned.

Array of objects (CategoryFilterOptionItem)

if the category does not have this item, empty array is returned.

Array of objects (CategoryFilterOptionItem)

if the category does not have this item, empty array is returned.

Array of objects (CategoryFilterOptionItem)

if the category does not have this item, empty array is returned.

Array of objects (CategoryFilterOptionItem)

if the category does not have this item, empty array is returned.

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

search

search list

Authorizations:
(OptionalTokenProfileOptionalToken)
query Parameters
debug
string

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

q
string
person
string
genre
string
category
string
produce_country
string
produce_year
string
page
integer

The default value is 1

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
uuid
string <uuid> (UUID)

This value is not editable.

service_name
string (Service Name)
Default: "odk"
Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

title
string (Title) non-empty
default_sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
Array of objects or null (SearchCategory)
object or null (ProgramImages)
Array of objects or null (PersonRole)
object (Badges)
is_favorite
boolean

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

payment

product-subscription retrieve

path Parameters
product_code
required
string
Enum: "ODK-PREMIUM-1-MONTH" "ODK-PREMIUM-1-YEAR" "ODK-PREMIUM-SAMSUNG-1-MONTH" "ODK-PREMIUM-SAMSUNG-1-YEAR"
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3PaymentSubscription)
product_code
string <slug> (Product Code) non-empty ^[A-Z0-9_]+$
product_name
string (Product Name) non-empty
price
float (Price)
description
string (Description)

Description of product according to interval unit such as Month and Year

operation_type
string (Operation Type)
Enum: "subscribe" "grade_change" "update_billing_info"

Variable to decide whether product's information is shown or not

fields_on
boolean (Fields On)

If upgrade or downgrade, we don't need card number for recurly subscription, so fields_on = false.

public_key
string (Public Key)

Use Public Key to identify your site when using Recurly.js.

callback_url
string (Callback URL)

temporary empty string before IO-1679

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

product-subscription list

query Parameters
debug
string

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

product_code
string

The product code to filter by

is_active
boolean

Filter by active status. If true, the product list shown to the customer

payment_platform
string
Example: payment_platform=web

The payment platform to filter by / web, apple, apple-tv, google, google-tv, roku

platform
string
Example: platform=web

The payment platform to filter by / web, apple, apple-tv, google, google-tv, roku, samsung

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of objects (OdxV3ProductSubscriptionList)
Array
product_code
string
product_name
string
price
number <float>
description
Array of strings
operation_type
string (Operation Type)

Variable to decide whether product's information is shown or not

fields_on
boolean (Fields On)

If upgrade or downgrade, we don't need card number for recurly subscription, so fields_on = false.

label_type
string
Enum: "HIGHLIGHT" "TAG"
label
string
sub_title
string
subscription_type
string
max_profile_count
integer
position
integer
grade
integer
interval_unit
string
is_active
boolean
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

subscription create

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
product_code
required
string <slug> (Product Code) non-empty ^[A-Z0-9_]+$
token_id
required
string (Token ID) [ 1 .. 22 ] characters

A token generated by Recurly.js

coupon_code
string or null (Coupon Code)
Enum: "odk7dfree" "2mfreeodk"

Recurly Coupons (odk7dfree for ODK-PREMIUM-1-MONTH / 2mfreeodk for ODK-PREMIUM-1-YEAR)

shared_secret
string (Shared Secret)
transaction_id
string (Transaction ID) [ 10 .. 30 ] characters

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "product_code": "string",
  • "token_id": "string",
  • "coupon_code": "odk7dfree",
  • "shared_secret": "string",
  • "transaction_id": "stringstri"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

subscription create apple

If the error code is 460, you are already subscribed and do not need to request again.

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
receipt
required
string <byte> (Base64 encoded receipt data from Apple)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "receipt": "MIJE/AYJKoZIhv..."
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

subscription create apple-tv

If the error code is 460, you are already subscribed and do not need to request again.

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
receipt
required
string <byte> (Base64 encoded receipt data from Apple)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "receipt": "MIJE/AYJKoZIhv..."
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

subscription create google

If the error code is 460, you are already subscribed and do not need to request again.

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
purchase_token
required
string <byte> (purchase token from google)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "purchase_token": "pkcj..."
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

subscription update google

If the error code is 461, it means you don't currently have a subscription, and you should request a subscription creation, not a subscription change.

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
purchase_token
required
string <byte> (purchase token from google)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "purchase_token": "pkcj..."
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

subscription create google-tv

If the error code is 460, you are already subscribed and do not need to request again.

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
purchase_token
required
string <byte> (purchase token from google)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "purchase_token": "pkcj..."
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

subscription update google-tv

If the error code is 461, it means you don't currently have a subscription, and you should request a subscription creation, not a subscription change.

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
purchase_token
required
string <byte> (purchase token from google)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "purchase_token": "pkcj..."
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

subscription cancel

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
product_code
string <slug> (Product Code) non-empty ^[A-Z0-9_]+$
message
string (Message) non-empty
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

subscription change

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
product_code
required
string <slug> (Product Code) non-empty ^[A-Z0-9_]+$

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
product_code
string <slug> (Product Code) non-empty ^[A-Z0-9_]+$
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "product_code": "string"
}

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

subscription renewal

Information about the next subscription.
[Only WEB] A response status of 404 means that there is no next subscription. It will be deprecated in the next version.
[Except WEB] The response status is 200 with no data.

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
product_code
string (Product Code)
start_at
string <date-time> (renewal start date)
type
string (renewal type)
Enum: "expire" "renew" "cancel"
date
date-time or null (renewal date)

expire -> null / renew -> next subscription renewal date / cancel -> current subscription expiration date

subscription_type
string (Subscription type)
Default: "basic"
Enum: "basic" "plus" "premium" "premium-box"

admin-coupon user is also premium

interval_unit
string or null (Subscription interval unit)
Enum: "month" "year"
is_discount
boolean or null (Is discount)

If the user has a discount, this value is true.

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

subscription discount

About discounts

Authorizations:
RequiredToken
query Parameters
debug
string

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

type
required
string
Value: "RETENTION"
Example: type=RETENTION
header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
is_available
boolean <boolean>

If the discount is available for the user.

discount_rate
number <float>

The discount rate for the subscription.

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

apply subscription discount

Apply subscription discounts

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
type
required
string
Enum: "RETENTION" "PROMOTION"

The type of the subscription discount.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
message
string
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "type": "RETENTION"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

subscription reactivate

About Subscription Reactivate

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
type
required
string
Enum: "RETENTION" "PROMOTION"

The type of the subscription discount.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
message
string
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "type": "RETENTION"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

recurly coupon retrieve

Authorizations:
RequiredToken
query Parameters
product_code
required
string
Enum: "ODK-PREMIUM-1-MONTH" "ODK-PREMIUM-1-YEAR"
coupon_code
required
string
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
code
string <slug> (Code) non-empty ^[a-z0-9_]+$
name
string (Name) non-empty
state
string (State) non-empty
duration
string (Duration)
Enum: "forever" "single_use" "temporal"
temporal_amount
integer or null (Temporal amount)
temporal_unit
string or null (Temporal unit)
Enum: "day" "month" "week" "year"
discount_type
string (Discount type)
Enum: "fixed" "percent" "free_trial"
discount_percent
integer (Discount percent)
free_trial_unit
string (Free trial unit)
Enum: "day" "month" "week"

This field can be the empty string.

free_trial_length
integer (Free trial length)
object or null
currency
string (Currency)
amount
float (Amount)
redeem_by
date or null (Redeem by)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

admin coupon retrieve

Authorizations:
RequiredToken
path Parameters
code
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
code
string (Code) >= 3 characters

admin coupon code

expected_valid_to
date (Expected Valid to)

Expected admin coupon expiration date considered with the user's membership

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

admin coupon create

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
code
required
string (Code) >= 3 characters

admin coupon code

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
code
string (Code) >= 3 characters

admin coupon code

valid_from_date
date (Valid from date)

valid from of admin coupon expiration date considered with the user's membership

valid_to_date
date (valid to date)

valid to of admin coupon expiration date considered with the user's membership

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

public-key list

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
public_key
string (Public Key)

Use Public Key to identify your site when using Recurly.js.

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

payment-method list

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
card_type
string (Card type)
Enum: "American Express" "Dankort" "Diners Club" "Discover" "Forbrugsforeningen" "JCB" "Laser" "Maestro" "MasterCard" "Test Card" "Union Pay" "Unknown" "Visa" "Tarjeta Naranja"

Actually used; American Express, Discover, JCB, MasterCard, Visa

last_four
string (Last four) <= 4 characters
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

payment-method partial update

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
token_id
required
string (Token ID) [ 1 .. 22 ] characters

A token generated by Recurly.js

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
card_type
string (Card type)
Enum: "American Express" "Dankort" "Diners Club" "Discover" "Forbrugsforeningen" "JCB" "Laser" "Maestro" "MasterCard" "Test Card" "Union Pay" "Unknown" "Visa" "Tarjeta Naranja"

Actually used; American Express, Discover, JCB, MasterCard, Visa

last_four
string (Last four) <= 4 characters
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "token_id": "string"
}

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "messages": { },
  • "result": {
    }
}

register user and roku customer id relation

Request Body schema: application/json
user_id
required
integer (ODK User ID)

ODK user ID

pay_result
required
object (RokuPay result)

Object. It is result of RokuPay transaction.

Responses

Response Schema: application/json
error_message
string (Error Message)

It explain what make this error response

Request samples

Content type
application/json
{
  • "user_id": 23012,
  • "pay_result": {
    }
}

Response samples

Content type
application/json
{
  • "error_message": "string"
}

payment/purchase

Get product info to purchase

Authorizations:
RequiredToken
path Parameters
product_code
required
string <uuid>
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
product_code
string <uuid> (Product ID(GUID))
product_title
string (Product Title)
product_price
number (Product Price)
slug
string (Content Slug)
tier
string or null (Tier)
az_client_key
string (AuthorizeNet Client Key)
az_login_id
string (AithorizeNet Login id)
program_slug
string <slug> (Program Slug) non-empty ^[a-z0-9_]+$
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Checkout purchased product by Authorize.net

Authorizations:
RequiredToken
path Parameters
product_code
required
string <uuid>
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
data_value
required
string (Data Value from AZNet) non-empty
data_description
required
string (Data Description from AZNet) non-empty
zipcode
string (User input zipcode)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
product_code
string <uuid> (Product ID(GUID))
slug
string (Content Slug)
program_slug
string <slug> (Program Slug) non-empty ^[a-z0-9_]+$
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "data_value": "string",
  • "data_description": "string",
  • "zipcode": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Checkout purchased product by Apple AppStore

Authorizations:
RequiredToken
path Parameters
product_code
required
string <uuid>
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
receipt
required
string <byte> (Base64 encoded receipt data from Apple)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
product_code
string <uuid> (Product ID(GUID))
slug
string (Content Slug)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "receipt": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Checkout purchased product by Google PlayStore

Authorizations:
RequiredToken
path Parameters
product_code
required
string <uuid>
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
receipt
required
string <byte> (Base64 encoded receipt data from Google)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
product_code
string <uuid> (Product ID(GUID))
slug
string (Content Slug)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "receipt": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Purchase Bundle for Promotion with PayPerView and Subscription

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
product_code
required
string <uuid> (Product Code)
token_id
required
string (Token ID) [ 1 .. 22 ] characters

A token generated by Recurly.js

shared_secret
required
string (Shared Secret)
coupon_codes
Array of strings (Coupon Codes)

Recurly Coupons. Currently not required fields because the backend ignores this value.

bundle_product_code
required
string <slug> (Bundle Product Code) non-empty ^[-a-zA-Z0-9_]+$

The product code of ProductSubscription for subscription.

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object (emptyResult)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "product_code": "ef785c24-67cc-4ee4-9990-803d8199d71a",
  • "token_id": "string",
  • "shared_secret": "string",
  • "coupon_codes": [
    ],
  • "bundle_product_code": "ODK-PREMIUM-1-MONTH-1399"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

payment/preview

Preview Purchase Tax Calculation

Calculate taxes and discounts for subscription products in real-time.

Features

  • Automatic state detection based on zip code
  • Real-time tax calculation via Recurly API
  • Coupon code discount calculation
  • Skips trial period and calculates regular price
  • Support for multiple payment platforms

Important Notes

  • No actual payment is processed
  • Tax rates are calculated in real-time and may change
  • Only supports US zip codes (5 or 9 digits)
  • Coupon codes are validated and applied if valid
query Parameters
debug
string

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

product_code
required
string
Example: product_code=ODK-PREMIUM-1-MONTH

Product code for subscription

zip_code
required
string^\d{5}(-\d{4})?$
Example: zip_code=90210

US zip code (5 or 9 digit format)

payment_platform
string
Default: "web"
Enum: "web" "apple" "google"
Example: payment_platform=web

Payment platform (default: web)

coupon_code
string
Example: coupon_code=SAVE20

Coupon code for discount calculation

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string
title
string
messages
object
object
product_code
string
price
string
discount
string
tax
string
total
string
tax_rate
number <float>
region
string
coupon_code
string or null
Response Schema: application/json
code
string
title
string
messages
object
Response Schema: application/json
code
string
title
string
messages
object

Response samples

Content type
application/json
Example
{
  • "code": "",
  • "title": "",
  • "messages": { },
  • "result": {
    }
}

channels

channels epg

query Parameters
debug
string

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

channel
integer

Channel id

date
date

(UTC) date value

start
datetime

(UTC) The date-time from which the EPG schedule can be queried

end
datetime

(UTC) The date-time until which the EPG schedule can be queried

type
string

If value is channel_only, only return channels list without schedule info

page
integer

The default value is 1

page_size
integer

The default value is 20

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)

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)

primary key of channel model

slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
title
string (Title)

Channel title

description
string (Description)

Channel description

stream_url
string (Stream url)

Channel live stream url.

order
integer (Order)

The Channel list is ordered by this value

object or null (ChannelImages)
number
integer (Number)

unique number for channel

color
string (Color)

hexadecimal color code for channel

keywords
string (Keywords)

keywords for channel

Array of objects (OdxV3EPG)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {}
}

live-tv_list

query Parameters
debug
string

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

start
datetime

(UTC) The date-time from which the EPG schedule can be queried

period
integer [ 8 .. 24 ]
Default: 8

If period exists, EPG data will be filtered as EPG's start time less than start + period

channel_limit
integer
Default: 20

the limit number of channels for each category

epg_limit
integer
Default: 4

the limit number of epg data for each channel

page
integer

The default value is 1

page_size
integer

The default value is 10

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)

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
title
string (Title)

ChannelCategory's title

order
integer (Order)

The ChannelCategory's list is ordered by this value

Array of objects (OdxV3LiveTvChannels)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

channels_list

query Parameters
debug
string

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

start
datetime

(UTC) The date-time from which the EPG schedule can be queried

period
integer [ 8 .. 24 ]
Default: 8

If period exists, EPG data will be filtered as EPG's start time less than start + period

categories__slug
required
string

Slug of channel's category

epg_limit
integer
Default: 4

the limit number of epg data for each channel

page
integer

The default value is 1

page_size
integer

The default value is 20

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)

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)

primary key of channel model

slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
title
string (Title)

Channel title

description
string (Description)

Channel description

stream_url
string (Stream url)

Channel live stream url.

order
integer (Order)

The Channel list is ordered by this value

object or null (ChannelImages)
number
integer (Number)

unique number for channel

color
string (Color)

hexadecimal color code for channel

keywords
string (Keywords)

keywords for channel

Array of objects (OdxV3EPG)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {}
}

channels retrieve

query Parameters
debug
string

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

start
datetime

(UTC) The date-time from which the EPG schedule can be queried

period
integer [ 8 .. 24 ]
Default: 8

If period exists, EPG data will be filtered as EPG's start time less than start + period

epg_limit
integer
Default: 4

the limit number of epg data for each channel

page
integer

The default value is 1

page_size
integer

The default value is 20

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)

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3LiveTvChannels)
id
integer (ID)

primary key of channel model

slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
title
string (Title)

Channel title

description
string (Description)

Channel description

stream_url
string (Stream url)

Channel live stream url.

order
integer (Order)

The Channel list is ordered by this value

object or null (ChannelImages)
poster
string or null <uri> (Poster)
poster_landscape
string or null <uri> (Poster landscape)
poster_portrait
string or null <uri> (Poster portrait)
logo
string or null <uri> (Logo)
number
integer (Number)

unique number for channel

color
string (Color)

hexadecimal color code for channel

keywords
string (Keywords)

keywords for channel

Array of objects (OdxV3EPG)
Array
id
integer (ID)
episode_num
integer or null (Episode number)

Episode number if content is episode else null

content_uuid
string (Content UUID value)

Content UUID (for data team)

title
string or null (Title) <= 255 characters

Program title

description
string (Description)

Program description

thumbnail
string or null (Thumbnail) <= 500 characters

Thumbnail url

date
date or null (Date)

(UTC) Schedule date

start_time
string or null <date-time> (Start time)

(UTC) Program start datetime

end_time
string or null <date-time> (End time)

(UTC) Program end datetime

duration
int or null (Duration)

Duration in seconds

start_over
string or null (Start over)

Start over url

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

continuous-watching

continuous watching histories list

Authorizations:
(RequiredTokenProfileToken)
query Parameters
debug
string

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

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of objects (ContinuousWatchingHistory)
Array
id
string (Unique ID)
user_id
integer (User ID)
profile_id
integer (Profile ID)
is_primary
boolean (Is profile primary)
session_key
string or null (Session Key (Only guest user))
program_id
integer (ODX Program ID)
episode_id
integer (ODX Episode ID)
duration
float (Video duration)
last_position
float (last played position)
total_play_time
float (total played time)
progress_ratio
float (Progress Ratio)
watched
boolean (Watched boolean)
deleted
boolean (Deleted boolean)
created_at
datetime (Created At)
updated_at
datetime (Updated At)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

continuous watching histories by episode retrieve

Authorizations:
(RequiredTokenProfileToken)
path Parameters
id
required
string
query Parameters
debug
string

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

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (ContinuousWatchingHistory)
id
string (Unique ID)
user_id
integer (User ID)
profile_id
integer (Profile ID)
is_primary
boolean (Is profile primary)
session_key
string or null (Session Key (Only guest user))
program_id
integer (ODX Program ID)
episode_id
integer (ODX Episode ID)
duration
float (Video duration)
last_position
float (last played position)
total_play_time
float (total played time)
progress_ratio
float (Progress Ratio)
watched
boolean (Watched boolean)
deleted
boolean (Deleted boolean)
created_at
datetime (Created At)
updated_at
datetime (Updated At)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

continuous watching histories by program retrieve

Authorizations:
(RequiredTokenProfileToken)
path Parameters
id
required
string
query Parameters
debug
string

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

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of objects (ContinuousWatchingHistory)
Array
id
string (Unique ID)
user_id
integer (User ID)
profile_id
integer (Profile ID)
is_primary
boolean (Is profile primary)
session_key
string or null (Session Key (Only guest user))
program_id
integer (ODX Program ID)
episode_id
integer (ODX Episode ID)
duration
float (Video duration)
last_position
float (last played position)
total_play_time
float (total played time)
progress_ratio
float (Progress Ratio)
watched
boolean (Watched boolean)
deleted
boolean (Deleted boolean)
created_at
datetime (Created At)
updated_at
datetime (Updated At)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

watching histories list

Authorizations:
(RequiredTokenProfileToken)
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of objects (ContinuousWatchingHistory)
Array
id
string (Unique ID)
user_id
integer (User ID)
profile_id
integer (Profile ID)
is_primary
boolean (Is profile primary)
session_key
string or null (Session Key (Only guest user))
program_id
integer (ODX Program ID)
episode_id
integer (ODX Episode ID)
duration
float (Video duration)
last_position
float (last played position)
total_play_time
float (total played time)
progress_ratio
float (Progress Ratio)
watched
boolean (Watched boolean)
deleted
boolean (Deleted boolean)
created_at
datetime (Created At)
updated_at
datetime (Updated At)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

watching histories delete

Authorizations:
(RequiredTokenProfileToken)
header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

watching histories episode delete

Authorizations:
(RequiredTokenProfileToken)
path Parameters
id
required
string
header Parameters
Service-Name
required
string
Value: "odk"

Only "odk" is supported.

Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

page

page faq tabs

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
Array of objects

This field is value returned by freshdesk api. See https://developers.freshdesk.com/api/#list_all_solution_folders

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

page faq articles

query Parameters
tab_id
required
integer >= 1
header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
Array of objects

This field is value returned by freshdesk api. See https://developers.freshdesk.com/api/#list_all_solution_articles

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

page_terms_of_use

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object

This field is value returned by freshdesk api. See https://developers.freshdesk.com/api/#view_solution_article

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

notice

Notice List

query Parameters
debug
string

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

page
integer

The default value is 1

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
title
string (Title)
link
string <uri> (Link)

External Link

enable
boolean (Enalbe)

Notice enabled

published_at
string <date-time> (Published At)

Create or WIX publish datetime

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {}
}

contact-us

contact us

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
name
required
string (Name) non-empty
email
required
string <email> (Email) non-empty
description
required
string (Description) non-empty
kind
required
string (Kind)
Enum: "CS" "AD"
phone
string or null (Phone)
subject
string or null (Subject)
preferred_language
string (Preferred Language)
Enum: "ko" "en"
status
integer (Status)
Default: 2
priority
integer (Priority)
Default: 2

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
result
object

This field is value returned by freshdesk api. See https://developers.freshdesk.com/api/#create_ticket

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "description": "string",
  • "kind": "CS",
  • "phone": "string",
  • "subject": "string",
  • "preferred_language": "ko",
  • "status": 2,
  • "priority": 2
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": { }
}

tv-guide

TV Guide List

query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3TVGuide)
Array of objects (Category)
Array
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
title
string (Title) non-empty
date
Array of date (Date)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

TV Guide Program List

Authorizations:
(OptionalTokenProfileOptionalToken)
query Parameters
debug
string

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

date
date

episode's release date value (KST)

categories__slug
string

Slug of program's category

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of items (OdxV3TVGuidePrograms)
object (OdxV3TVGuideProgramItem)
  • categories__slug != odk-channels: TVGuideProgram
  • categories__slug == odk-channels: TVGuideChannel
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$

Category slug

category_title
string <slug> (Title) ^[-a-zA-Z0-9_]+$

Category Title

Array of TVGuideProgram (object) or TVGuideChannel (object)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

TV Guide Episode List for widget

query Parameters
debug
string

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

date
date

episode's release date value (KST)

categories__slug
string

Slug of program's category

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of items (OdxV3TVGuideEpisodes)
object (OdxV3TVGuideEpisodeItem)
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$

Category slug

category_title
string <slug> (Title) ^[-a-zA-Z0-9_]+$

Category Title

Array of items
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

TV Guide Episode List for feeds

query Parameters
debug
string

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

date
date

episode's release date value (KST)

categories__slug
string

Slug of program's category

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of items (OdxV3TVGuideFeeds)
object (OdxV3TVGuideFeedsItem)
full_date
string (Full date)

Full date

days_of_week
string (days_of_week)
Array of items (categories)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

profile/avatars

Profile Avatars List

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Avatar-%3Agreen_star%3A

Authorizations:
RequiredToken
query Parameters
debug
string

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of items (OdxV3ProfileAvatars)
object (OdxV3ProfileAvatar)
id
integer (Avatar ID)
image_url
string (image URL)
description
string (description)
order
integer (order)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

profile

Profile Create

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Create%5BinlineExtension%5D-%3Agreen_star%3A

Authorizations:
RequiredToken
query Parameters
debug
string

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

Request Body schema: application/json
name
required
string (name)
language
string (language)

optional, default ko

avatar_id
string (avatar_id)

optional, default null (Lookup via Avatar API)

birthday
string (birthday)

optional, default null (Format, 0000-00-00)

gender
string (gender)

optional, default null (When using 'Other', it must be entered in lowercase.)

pin
string (pin)
  • optional, default null (4 digit)
  • Upcoming features
is_kid
boolean (is_kid)
  • optional, default false
  • Upcoming features

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
object (OdxV3Profile)
id
integer (Profile ID)
  • id is unique per Profile.
name
string (name)
gender
string (gender)
  • Nullable
birthday
string (birthday)
  • Nullable
language
string (language)
  • Nullable
is_active
boolean (is_active)
  • Nullable
is_kid
boolean (is_kid)
  • Default false
is_primary
boolean (is_primary)
  • Default false
has_pin
boolean (has_pin)
  • Default false
object (OdxV3ProfileAvatar)
user
integer (User ID)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "name": "string",
  • "language": "string",
  • "avatar_id": "string",
  • "birthday": "string",
  • "gender": "string",
  • "pin": "string",
  • "is_kid": true
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Profile List

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#List%5BinlineExtension%5D%3Agreen_star%3A

Authorizations:
RequiredToken
query Parameters
debug
string

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
Array of items (OdxV3Profiles)
object (OdxV3Profile)
id
integer (Profile ID)
  • id is unique per Profile.
name
string (name)
gender
string (gender)
  • Nullable
birthday
string (birthday)
  • Nullable
language
string (language)
  • Nullable
is_active
boolean (is_active)
  • Nullable
is_kid
boolean (is_kid)
  • Default false
is_primary
boolean (is_primary)
  • Default false
has_pin
boolean (has_pin)
  • Default false
object (OdxV3ProfileAvatar)
user
integer (User ID)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": [
    ]
}

Profile Retrieve

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Retrieve%5BinlineExtension%5D%3Agreen_star%3A

Authorizations:
(RequiredTokenProfileToken)
query Parameters
debug
string

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
object (OdxV3Profile)
id
integer (Profile ID)
  • id is unique per Profile.
name
string (name)
gender
string (gender)
  • Nullable
birthday
string (birthday)
  • Nullable
language
string (language)
  • Nullable
is_active
boolean (is_active)
  • Nullable
is_kid
boolean (is_kid)
  • Default false
is_primary
boolean (is_primary)
  • Default false
has_pin
boolean (has_pin)
  • Default false
object (OdxV3ProfileAvatar)
user
integer (User ID)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Profile Retrieve

To be written. Go to https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Retrieve%5BinlineExtension%5D%3Agreen_star%3A

Authorizations:
RequiredToken
query Parameters
debug
string

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
object (OdxV3Profile)
id
integer (Profile ID)
  • id is unique per Profile.
name
string (name)
gender
string (gender)
  • Nullable
birthday
string (birthday)
  • Nullable
language
string (language)
  • Nullable
is_active
boolean (is_active)
  • Nullable
is_kid
boolean (is_kid)
  • Default false
is_primary
boolean (is_primary)
  • Default false
has_pin
boolean (has_pin)
  • Default false
object (OdxV3ProfileAvatar)
user
integer (User ID)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Profile Delete

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Delete%5BinlineExtension%5D%3Agreen_star%3A

Authorizations:
RequiredToken
query Parameters
debug
string

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { }
}

Profile partial Update

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Update%5BinlineExtension%5D%3Agreen_star%3A

Authorizations:
RequiredToken
query Parameters
debug
string

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

Request Body schema: application/json
name
required
string (name)
language
string (language)

optional, default ko

avatar_id
string (avatar_id)

optional, default null (Lookup via Avatar API)

birthday
string (birthday)

optional, default null (Format, 0000-00-00)

gender
string (gender)

optional, default null (When using 'Other', it must be entered in lowercase.)

pin
string (pin)
  • optional, default null (4 digit)
  • Upcoming features
is_kid
boolean (is_kid)
  • optional, default false
  • Upcoming features

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
object (OdxV3Profile)
id
integer (Profile ID)
  • id is unique per Profile.
name
string (name)
gender
string (gender)
  • Nullable
birthday
string (birthday)
  • Nullable
language
string (language)
  • Nullable
is_active
boolean (is_active)
  • Nullable
is_kid
boolean (is_kid)
  • Default false
is_primary
boolean (is_primary)
  • Default false
has_pin
boolean (has_pin)
  • Default false
object (OdxV3ProfileAvatar)
user
integer (User ID)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "name": "string",
  • "language": "string",
  • "avatar_id": "string",
  • "birthday": "string",
  • "gender": "string",
  • "pin": "string",
  • "is_kid": true
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

Profile Sign In

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Profile-Sign-In%5BinlineExtension%5D%3Agreen_star%3A

Authorizations:
RequiredToken
query Parameters
debug
string

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

Request Body schema: application/json
pin
string (pin)
  • optional, default null (4 digit)
  • Upcoming features

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object
token
string (token)
object (OdxV3Profile)
id
integer (Profile ID)
  • id is unique per Profile.
name
string (name)
gender
string (gender)
  • Nullable
birthday
string (birthday)
  • Nullable
language
string (language)
  • Nullable
is_active
boolean (is_active)
  • Nullable
is_kid
boolean (is_kid)
  • Default false
is_primary
boolean (is_primary)
  • Default false
has_pin
boolean (has_pin)
  • Default false
object (OdxV3ProfileAvatar)
user
integer (User ID)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

profile_favorites

Profile Favorites List

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#List-%3Agreen_star%3A

Authorizations:
(RequiredTokenProfileToken)
query Parameters
debug
string

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

page
integer

The default value is 1

page_size
integer

The default value is 10

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
object or null (ProgramImages)
object or null (EpisodeIdentifiers)
is_favorite
boolean
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {}
}

Profile Favorites Create

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Create-%3Agreen_star%3A

Authorizations:
(RequiredTokenProfileToken)
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
program_slug
required
string (Program Slug) non-empty

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (FavoritesProgram)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
object or null (ProgramImages)
poster
string or null <uri> (Poster)
poster_landscape
string or null <uri> (Poster landscape)
poster_portrait
string or null <uri> (Poster portrait)
object or null (EpisodeIdentifiers)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
is_favorite
boolean
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "program_slug": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {}
}

Profile Favorites Delete

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Delete-%3Agreen_star%3A

Authorizations:
(RequiredTokenProfileToken)
path Parameters
slug
required
string
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { }
}

Profile Favorites Delete All

https://ondemandkorea.atlassian.net/wiki/spaces/BE/pages/2653356161/API+specification#Remove-All-%3Agreen_star%3A

Authorizations:
(RequiredTokenProfileToken)
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { }
}

Profile Favorites Save To All

Authorizations:
(RequiredTokenProfileToken)
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
program_slug
required
string (Program Slug) non-empty

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (FavoritesProgram)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
object or null (ProgramImages)
poster
string or null <uri> (Poster)
poster_landscape
string or null <uri> (Poster landscape)
poster_portrait
string or null <uri> (Poster portrait)
object or null (EpisodeIdentifiers)
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
sales_type
string or null (SalesType)
Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" null
is_favorite
boolean
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "program_slug": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {}
}

reward

reward-category

Get lists of category and programs for Rewards

Authorizations:
OptionalToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
object (debug)

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

object

Parsing result for User-Agent request header

package_name
string
app_version
string
os
string
os_version
string
device_identifier
string
object
user_agent
string

User-Agent request Header

ip
string
country
string
custom_headers
object

Custom request Header ex) Service-Name

qs
object

Request querystring

body
object

Request body

messages
object (messages)
object
count
integer
next
string <uri>
previous
string <uri>
page_next
integer
page_previous
integer
page_size
integer
Array of objects
Array
id
integer (ID)

Reward category ID

icon_type
string (Icon Type)
Default: "account"
Enum: "account" "subscription" "hot"

Icon type to show the category icon on devices

name
string (Name)

Reward category name

layout_type
string (Layout Type)
Default: "landscape"
Enum: "landscape" "portrait" "list"

Layout type according to reward categories (ODK Exclusive Perks - landscape, Only for Subscribers - portrait, Hot Deals - list)

Array of objects (OdxV3RewardCategoryProgram)
Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

reward-program

Get details of program for Rewards

Authorizations:
OptionalToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3RewardProgram)
id
integer (ID)

Reward program ID

code
string (Code)

Reward program code (Coupon code), The empty string means no coupon code.

partner_name
string (Partner Name)

Partner name of reward program

card_url
string (Card URL)

Card(voucher, including logo and discount rate) image URL

title
string (Title)

Benefit title for reward program

secondary_title
string (Secondary Title)

subtitle for reward program

disclaimer
Array of strings (Disclaimer)

string list for disclaimer sentences

redemption_rule
string (Redemption Rule)
Default: "no_restriction"
Enum: "subscription_required" "sign_in_required" "no_restriction"
time_limit_seconds
integer (Time Limit Seconds)

Voucher time limit in seconds. 3600 seconds is 60 minutes. If time_limit_seconds=0, the coupon will never expire.

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

reward-redemption

Get details of redemption with program for Rewards

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3RewardRedemption)
id
integer (ID)

Reward redemption ID

user
integer (User)

User ID

object (OdxV3RewardRedemptionProgram)
id
integer (ID)

Reward program ID

barcode_url
string (Barcode URL)

Barcode Image URL

time_limit_seconds
integer (Time Limit Seconds)

Voucher time limit in seconds. 3600 seconds is 60 minutes. If time_limit_seconds=0, the coupon will never expire.

instruction
string (Instruction)

Instruction message for reward program

redeemed_at
string <date-time> (Redeemed At)

A timestamp of when a user redeemed the coupon.

expired_at
string <date-time> (Expired At)

A timestamp of when a user's coupon expires.

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

reward-redeem

Create redemption with program for Rewards

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
program_id
required
integer (Reward Program ID)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3RewardRedemption)
id
integer (ID)

Reward redemption ID

user
integer (User)

User ID

object (OdxV3RewardRedemptionProgram)
id
integer (ID)

Reward program ID

barcode_url
string (Barcode URL)

Barcode Image URL

time_limit_seconds
integer (Time Limit Seconds)

Voucher time limit in seconds. 3600 seconds is 60 minutes. If time_limit_seconds=0, the coupon will never expire.

instruction
string (Instruction)

Instruction message for reward program

redeemed_at
string <date-time> (Redeemed At)

A timestamp of when a user redeemed the coupon.

expired_at
string <date-time> (Expired At)

A timestamp of when a user's coupon expires.

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "program_id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}

reward-use

Update used_at of redemption with program for Rewards

Authorizations:
RequiredToken
query Parameters
debug
string

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

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl" "amasian"
Accept-Language
string
Default: en
Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"

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

Request Body schema: application/json
program_id
required
integer (Reward Program ID)

Responses

Response Schema: application/json
code
string (code)
title
string (title)
messages
object (messages)
object (OdxV3RewardUsage)
id
integer (ID)

Reward redemption ID

user
integer (User)

User ID

object (OdxV3RewardUsageProgram)
id
integer (ID)

Reward program ID

confirmation
string (Confirmation)

Confirmation message for reward program

used_at
string <date-time> (Used At)

A timestamp of when a user marked the coupon as used.

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Response Schema: application/json
code
string (code)
title
string (title)
messages
object

This field contains error message and keys of this object are either <field name> or "__default".
ex) "password": "Password must not exceed 60 characters."
ex2) "__default": "Service-Name header is invalid."

Request samples

Content type
application/json
{
  • "program_id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "messages": { },
  • "result": {
    }
}