API docs by Redocly

ODX/V2 API (v2)

Download OpenAPI specification:

base

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"
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 (OdxV2ClientBase)
object (OdxV2SplashScreen)
Array of objects
object
Deprecated
Array of objects

support promotion screens and interstitial ads(for mobile apps)

object (OdxV2ClientVersion)
client_version
string
store_link
string
force_update
string
object (OdxV2ClientConfig)
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"
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)
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 (OdxV2UserToken)
token
required
string (Token) non-empty
required
object (OdxV2UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV2UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook"
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 (OdxV2UserProfileExternalSerializer)
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'.

Request samples

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

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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"
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)
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 (OdxV2UserToken)
token
required
string (Token) non-empty
required
object (OdxV2UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV2UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook"
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 (OdxV2UserProfileExternalSerializer)
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'.
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

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",
  • "debug": {
    },
  • "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"
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)
result
object (emptyResult)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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"
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 (OdxV2UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV2UserInfo)
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)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook"
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 (OdxV2UserProfileExternalSerializer)
object (OdxV2UserProfileExternalKCPInformationSerializer)
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'.

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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"
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 (OdxV2UserInfo)
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)
object (OdxV2UserProfileExternalSerializer)
object (OdxV2UserProfileExternalKCPInformationSerializer)
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)
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 (OdxV2UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV2UserInfo)
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)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook"
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 (OdxV2UserProfileExternalSerializer)
object (OdxV2UserProfileExternalKCPInformationSerializer)
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'.

Request samples

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

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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"
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 (OdxV2UserInfo)
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)
object (OdxV2UserProfileExternalSerializer)
object (OdxV2UserProfileExternalKCPInformationSerializer)
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)
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 (OdxV2UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV2UserInfo)
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)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook"
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 (OdxV2UserProfileExternalSerializer)
object (OdxV2UserProfileExternalKCPInformationSerializer)
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'.

Request samples

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

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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"
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)
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)
result
object (emptyResult)

Request samples

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

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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"
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)
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 (OdxV2UserToken)
token
required
string (Token) non-empty
required
object (OdxV2UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV2UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook"
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 (OdxV2UserProfileExternalSerializer)
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'.

Request samples

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

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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)
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)
Array of objects (OdxV2UserOrdersPayPerView)
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)
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

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)
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

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/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)
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 (OdxV2UserToken)
token
required
string (Token) non-empty
required
object (OdxV2UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV2UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook"
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 (OdxV2UserProfileExternalSerializer)
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'.
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

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)
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

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",
  • "debug": {
    },
  • "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)
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 (OdxV2UserToken)
token
required
string (Token) non-empty
required
object (OdxV2UserProfile)
id
integer (ID)
email
string <email> (Email address) <= 254 characters
object or null (OdxV2UserInfo)
is_email_verified
boolean (Email verified)
name
string or null (Name)
login_type
string (Login type)
Default: "email"
Enum: "email" "apple" "facebook"
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 (OdxV2UserProfileExternalSerializer)
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'.
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

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)
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

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",
  • "debug": {
    },
  • "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)
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)
result
object (emptyResult)
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

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)
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

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

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)
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)
result
object (emptyResult)
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

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/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"
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)
result
object (emptyResult)

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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)
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)
result
object (emptyResult)
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

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",
  • "debug": {
    },
  • "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"
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)
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)
result
object (emptyResult)
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

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",
  • "debug": {
    },
  • "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)
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)
result
object (emptyResult)
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

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",
  • "debug": {
    },
  • "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)
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)
result
object (emptyResult)
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

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",
  • "debug": {
    },
  • "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"
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)
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)
result
object (emptyResult)
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

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",
  • "debug": {
    },
  • "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)
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)
result
object (emptyResult)
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

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",
  • "debug": {
    },
  • "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.

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

Only "odk" is supported.

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 (OdxV2QRLoginInitialization)
verify_code
string (Verify code) = 6 characters
login_url
string (Login URL)
qrcode
string (QR code (base64 encoded))

Response samples

Content type
application/json
{
  • "code": "Code",
  • "title": "Title",
  • "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)
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)
result
object (emptyResult)
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

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",
  • "debug": {
    },
  • "messages": { },
  • "result": { }
}

Verfiy code and get auth with QR code

Verfiy code and get auth with QR code

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
verify_code
required
string (Verify code) = 6 characters

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
verify_code
string (Verify code) = 6 characters

Verify code included in request body

status
string (Status)
Enum: "authenticated" "verified" "credential_mismatched"
  • If request doesn’t include ODX token, status is "authenticated".
  • If request includes ODX token and owner of the token is equal to CTV account, status is "verified".
  • If request includes ODX token and owner of the token is different with CTV account, status is "credential_mismatched".
token
string (Token) = 60 characters
  • If status is "authenticated" or "credential_mismatched", token is a new token of CTV account.
  • If status is "verified", token is the token included in Authorization header.
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

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",
  • "debug": {
    },
  • "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)
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 (OdxV2QRLoginVerifyCheck)
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)
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

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/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"
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)
object or null (EpisodeIdentifiers)
is_favorite
boolean
object
Deprecated
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

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)
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

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"
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)
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 (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
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
object
Deprecated
id
integer (ID)
slug
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$
object or null (ProgramImages)
direct_play_episode_id
integer (Direct Play Episode ID)
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

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)
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

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",
  • "debug": {
    },
  • "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"
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

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)
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

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

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

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)
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

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

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"
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 (OdxV2FirstNavigation)

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"
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 (OdxV2Navigation)
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 (OdxV2FirstNavigation)
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 (OdxV2SecondNavigation)

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",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

cover

cover list

Authorizations:
OptionalToken
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"
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:
OptionalToken
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"
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 (OdxV2Cover)
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",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

curation

curation retrieve

  • The slug of ODK home carousels: home-curation-default
Authorizations:
OptionalToken
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"
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 (OdxV2Curation)
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 (OdxV2CurationContent)
Array
slug
string (Slug)
type
string (Type)
Enum: "episode" "program"
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

(Array of Carousels (EpisodeList (object) or ProgramList (object))) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) or CarouselsForChannel (object) (Carousels)
  • type == episode: Carousels.EpisodeList
  • type == program: Carousels.ProgramList
  • logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
  • logic_ordering == episode-continue-watching: CarouselsForContinueWatching

Response samples

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

curation content list

  • This API returns curation contents without carousel items.
  • The slug of ODK home carousels: home-curation-default
Authorizations:
OptionalToken
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"
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 (OdxV2CurationWithoutCarousels)
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",
  • "debug": {
    },
  • "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:
OptionalToken
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"
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 (OdxV2CurationContentRetrieve)
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 (OdxV2CurationContent)
slug
string (Slug)
type
string (Type)
Enum: "episode" "program"
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

(Array of Carousels (EpisodeList (object) or ProgramList (object))) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) or CarouselsForChannel (object) (Carousels)
  • type == episode: Carousels.EpisodeList
  • type == program: Carousels.ProgramList
  • logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
  • logic_ordering == episode-continue-watching: CarouselsForContinueWatching

Response samples

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

playback

playback retrieve

Authorizations:
OptionalToken
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"
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 (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 (OdxV2PlaybackDRM) >= 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
object or null (continue-watching)

OdxV2ContinuousWatchingHistory

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 (OdxV2CWEpisode)
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 (OdxV2PlaybackEpisodeWithSalesType)
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 (OdxV2PlaybackEpisode)
object (OdxV2PlaybackProgram)
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)
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

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

programs

programs list

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"
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:
OptionalToken
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"
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 (OdxV2Program)
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)
Deprecated
Default: "odk"
Enum: "odk" "odc" "odv" "odl"

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

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

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)
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 (ProgramMeta)
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)
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
direct_play_episode_id
integer or null
Deprecated

ID of episode played when 'play' button is clicked

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
subscription_type
string or null (Subscription Type)
Deprecated
Enum: "basic" "plus" "premium" "premium-box"

Subscription type that paid by this user.

can_apply_trial
boolean or null (Can apply trial)
Deprecated

If user is not anonymous and can apply trial, this value is true.

is_ppv_purchased
boolean or null (Is PPV purchased)
Deprecated

If user is not anonymous and this ppv is already purchased, this value is true.

ppv_expired_at
string or null <date-time> (PPV expired at)
Deprecated

Datetime When PPV expires. If is_purchased is False, this value is None. ex) 2022-09-06T20:18:57Z

object or null
price
number <float> (Price)
currency
string (Currency) <= 3 characters
product_code
string (Product code) <= 50 characters
tier
string or null (Tier)
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",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

program episodes list

Authorizations:
OptionalToken
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"
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)

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)
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

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"
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 (OdxV2Episode)
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 (ProgramMeta)
partner
string <slug> (Partner) ^[-a-zA-Z0-9_]+$
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

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

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"
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 (OdxV2Category)
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",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

search

search list

Authorizations:
OptionalToken
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"
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

Authorizations:
OptionalToken
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)
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 (OdxV2PaymentSubscription)
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)
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

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)
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

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

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)

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)
result
object (emptyResult)
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

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

Response samples

Content type
application/json
{
  • "code": "string",
  • "title": "string",
  • "debug": {
    },
  • "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)
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
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)
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

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)
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

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)
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
product_code
string <slug> (Product Code) non-empty ^[A-Z0-9_]+$
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

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)
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

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

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)
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
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)
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

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)
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

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)
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
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)
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

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)
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
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)
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

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)
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

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)
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
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)
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

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)
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
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)
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

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)
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

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)
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
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)
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

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)
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

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

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

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

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",
  • "debug": {
    },
  • "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"
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)
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
product_code
string <uuid> (Product ID(GUID))
slug
string (Content Slug)
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

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",
  • "debug": {
    },
  • "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"
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)
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
product_code
string <uuid> (Product ID(GUID))
slug
string (Content Slug)
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

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",
  • "debug": {
    },
  • "messages": { },
  • "result": {
    }
}

epg

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

title
string (Title)

Channel title

stream_url
string (Stream url)

Channel live stream url.

order
integer (Order)

The Channel list is ordered by this value

logo
string or null (Logo)
Deprecated

logo field is deprecated and will be removed. Please use images.logo field.

object or null (ChannelImages)
Array of objects (OdxV2EPG)
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

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

continuous-watching

continuous watching histories list

Authorizations:
RequiredToken
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
Enum: "odk" "odc" "odv" "odl"
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)
Array of objects or null (continue-watching)
Array
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 (OdxV2CWEpisode)

Response samples

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

continuous watching histories by episode retrieve

Authorizations:
RequiredToken
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
Enum: "odk" "odc" "odv" "odl"
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 or null (continue-watching)

OdxV2ContinuousWatchingHistory

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 (OdxV2CWEpisode)
id
integer (ID)
slug
string <slug> (Slug) ^[-a-zA-Z0-9_]+$
object (ProgramForEpisodeList)
kind
string (Kind)
Enum: "series" "main" "trailer" "additional" "clip"
number
integer (Number)
part
integer (Part)
title
string (Title) non-empty
object or null (EpisodeImages)
video_duration
integer or null (Video duration)

millisecond(ms)

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)

Response samples

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

continuous watching histories by program retrieve

Authorizations:
RequiredToken
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
Enum: "odk" "odc" "odv" "odl"
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)
Array of objects or null (continue-watching)
Array
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 (OdxV2CWEpisode)

Response samples

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

watching histories list

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"
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)
Array of objects or null (continue-watching)
Array
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 (OdxV2CWEpisode)

Response samples

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

watching histories delete

Authorizations:
RequiredToken
header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl"
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:
RequiredToken
path Parameters
id
required
string
header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl"
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"
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)
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",
  • "debug": {
    },
  • "messages": { },
  • "result": [
    ]
}

page faq articles

query Parameters
tab_id
required
integer >= 1
header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl"
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)
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",
  • "debug": {
    },
  • "messages": { },
  • "result": [
    ]
}

page_terms_of_use

header Parameters
Service-Name
required
string
Enum: "odk" "odc" "odv" "odl"
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)
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",
  • "debug": {
    },
  • "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"
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)
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

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

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",
  • "debug": {
    },
  • "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"
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 (OdxV2TVGuide)
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)
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

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

TV Guide Program List

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"
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)
Array of items (OdxV2TVGuidePrograms)
object (OdxV2TVGuideProgramItem)
  • 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)
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

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": [
    ]
}

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"
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)
Array of items (OdxV2TVGuideEpisodes)
object (OdxV2TVGuideEpisodeItem)
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)
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

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": [
    ]
}