LINE TV API reference
LINE TV API
Object definitions

LINE TV API reference

LINE TV API

Spotlight curation module types

Gets a spotlight data unit list such as represent_clip, editor_pick_clip, and theme_playlist.

Spotlight is the home of LINE TV, which has channels, playlists, clips, and more.

HTTP request

GET https://api.line.me/line-tv/v1/curation/list?lineChannelId={lineChannelId}&country=th

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {Channel Access Token}

Query parameters

Parameter Type Required Description
lineChannelId String Required Channel ID. Found on the LINE Developers console.
country String Required th

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/curation/list?lineChannelId={LineChannelId}&country=th' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object Names of the curation DataModule

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "supportModule": [
            {
                "dataModel": "clip",
                "name": "represent_clip"
            },
            {
                "dataModel": "clip",
                "name": "editor_pick_clip"
            },
            {
                "dataModel": "clip",
                "name": "hot_clip"
            },
            {
                "dataModel": "clip",
                "name": "theme_clip"
            },
            {
                "dataModel": "playlist",
                "name": "theme_playlist"
            },
            {
                "dataModel": "channel",
                "name": "hot_channel"
            },
            {
                "dataModel": "clip",
                "name": "special_clip"
            }
        ]
    }
}

Spotlight curation module

Gets spotlight data.

HTTP request

GET https://api.line.me/line-tv/v1/curation?lineChannelId={lineChannelId}&country=th&module={moduleName}

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
lineChannelId Required Channel ID. Found on the LINE Developers console.
country Required th
module Required One of:
  • represent_clip: Clip that appears at the top of the main page
  • editor_pick_clip: Clips based on editor's selection
  • hot_clip: Popular clips
  • theme_clip: Clips of a theme
  • theme_playlist: Playlists of a theme
  • hot_channel: Popular channels
  • special_clip: Clip chosen by the editor that appears in the special area.

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/curation?lineChannelId={LineChannelId}&country=th&module={moduleName}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object Clip object
Channel object
Playlist object

Values for the module query parameters

represent_clip area hot_channel and editor_pick_clip areas theme_playlist area theme_clip area special_clip area for mobile and PC

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "clips": [
            {
                "serviceUrl": "https://tv.line.me/v/357314_2-4-exo-comeback-and-drama-special",
                "displayPlayTime": "19:26",
                "clipTitle": "(2/4) EXO Comeback and Drama Special",
                "clipNo": 357314,
                "likeitPoint": 14003,
                "thumbnailUrl": "https://tv-img.pstatic.net/tv2-pt/20150409_142/xeQjG_1428561664637fqJ09_JPEG/531C04F3C319F38C36E3A23053FF91133C4_muploader_m_480P_854_1024_128_02.jpg?type=fcrop_234_132",
                "playCount": 202966,
                "clipSubtitle": ""
            },
            ...
        ],
        "channels": null,
        "playlists": null,
        "moduleName": "theme_clip"
    }
}

Category list

Gets a category list such as drama, music, etc.

HTTP request

GET https://api.line.me/line-tv/v1/category/list?lineChannelId={lineChannelId}&country=th

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Query parameters

Parameter Required Description
lineChannelId Required Channel ID. Found on the LINE Developers console.
country Required th

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/category/list?lineChannelId={LineChannelId}&country=th' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object

Category list locations

Category list location Category list location

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "tabs": [
            {
                "categoryName": "ละคร",
                "categoryCode": "DRAMA",
                "categoryEnName": "DRAMA",
                "serviceUrl": "https://tv.line.me/c/drama"
            },
            {
                "categoryName": "บันเทิง",
                "categoryCode": "ENTERTAINMENT",
                "categoryEnName": "ENTERTAINMENT",
                "serviceUrl": "https://tv.line.me/c/entertainment"
            },
            {
                "categoryName": "เพลง",
                "categoryCode": "ARTIST",
                "categoryEnName": "MUSIC",
                "serviceUrl": "https://tv.line.me/c/music"
            },
            {
                "categoryName": "การ์ตูน",
                "categoryCode": "CHILD",
                "categoryEnName": "ANIMATION",
                "serviceUrl": "https://tv.line.me/c/animation"
            },
            {
                "categoryName": "ไลฟ์สไตล์",
                "categoryCode": "LIFE",
                "categoryEnName": "LIFESTYLE",
                "serviceUrl": "https://tv.line.me/c/lifestyle"
            },
            {
                "categoryName": "กีฬา",
                "categoryCode": "SPORTS",
                "categoryEnName": "SPORTS",
                "serviceUrl": "https://tv.line.me/c/sports"
            }
        ]
    }
}

Category

Gets category home data.

HTTP request

GET https://api.line.me/line-tv/v1/category?lineChannelId={lineChannelId}&country=th&categoryCode={categoryCode}&page=1&countPerPage=10

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {Channel Access Token}

Query parameters

Parameter Type Required Description
lineChannelId String Required Channel ID. Found on the LINE Developers console.
country String Required th
categoryCode String Required Drama, entertainment, artist, etc. See Category list for complete details.
page Integer Optional Default: 1
countPerPage Integer Optional Default: 10

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/category?lineChannelId={lineChannelId}&country=th&categoryCode={categoryCode}&page=1&countPerPage=10' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object Clip object
Channel object

LINE TV category home

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "representClip": {
            "serviceUrl": "https://tv.line.me/v/357314_2-4-exo-comeback-and-drama-special",
            "displayPlayTime": "19:26",
            "clipTitle": "(2/4) EXO Comeback and Drama Special",
            "clipNo": 357314,
            "likeitPoint": 14003,
            "thumbnailUrl": "https://tv-img.pstatic.net/tv2-pt/20150409_142/xeQjG_1428561664637fqJ09_JPEG/531C04F3C319F38C36E3A23053FF91133C4_muploader_m_480P_854_1024_128_02.jpg?type=fcrop_234_132",
            "playCount": 202966,
            "clipSubtitle": ""
        },
        "channels": [
            {
                "channelId": "lineglobal",
                "channelEmblem": "",
                "thumbnailUrl": "https://tv-img.pstatic.net/tv1-pt/20141231_237/y8Mcb_1420011347217G1soW_PNG/1420011347204.png?type=f234_336",
                "channelName": "LINE Global",
                "badgeType": "NEW",
                "serviceUrl": "https://tv.line.me/lineglobal"
            },
            ...
        ],
        "hasMore": true
    }
}

Ranking

Gets clip ranking data.

HTTP request

GET https://api.line.me/line-tv/v1/ranking/clip?lineChannelId={lineChannelId}&country=th&page=1&countPerPage=10

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Query parameters

Parameter Type Required Description
lineChannelId String Required Channel ID. Found on the LINE Developers console.
country String Required th
page Integer Optional Default: 1
countPerPage Integer Optional Default: 10

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/ranking/clip?lineChannelId={lineChannelId}&country=th&page=1&countPerPage=10' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object Clip object

clip_ranking area

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "clips": [
            {
                "serviceUrl": "https://tv.line.me/v/357314_2-4-exo-comeback-and-drama-special",
                "displayPlayTime": "19:26",
                "clipTitle": "(2/4) EXO Comeback and Drama Special",
                "clipNo": 357314,
                "likeitPoint": 14003,
                "thumbnailUrl": "https://tv-img.pstatic.net/tv2-pt/20150409_142/xeQjG_1428561664637fqJ09_JPEG/531C04F3C319F38C36E3A23053FF91133C4_muploader_m_480P_854_1024_128_02.jpg?type=fcrop_234_132",
                "playCount": 202966,
                "clipSubtitle": ""
            },
            ...
        ],
        "hasMore": true
    }
}

Gets a clip search result.

HTTP request

GET https://api.line.me/line-tv/v1/search/clip?lineChannelId={lineChannelId}&country=th&query={query}

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Query parameters

Parameter Type Required Description
lineChannelId String Required Channel ID. Found on the LINE Developers console.
country String Required th
query String Required Search query

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/search/clip?lineChannelId={lineChannelId}&country=th&query={query}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object Clip object

Search results example

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "clips": [
            {
                "serviceUrl": "https://tv.line.me/v/357314_2-4-exo-comeback-and-drama-special",
                "displayPlayTime": "19:26",
                "clipTitle": "(2/4) EXO Comeback and Drama Special",
                "clipNo": 357314,
                "likeitPoint": 14003,
                "thumbnailUrl": "https://tv-img.pstatic.net/tv2-pt/20150409_142/xeQjG_1428561664637fqJ09_JPEG/531C04F3C319F38C36E3A23053FF91133C4_muploader_m_480P_854_1024_128_02.jpg?type=fcrop_234_132",
                "playCount": 202966,
                "clipSubtitle": ""
            },
            ...
        ],
        "hasMore": true,
        "total": 738
    }
}

Station home list

Gets the station home (TV station) list.

HTTP request

GET https://api.line.me/line-tv/v1/station/list?lineChannelId={lineChannelId}&country=th

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Query parameters

Parameter Type Required Description
lineChannelId String Required Channel ID. Found on the LINE Developers console.
country String Required th

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/station/list?lineChannelId={lineChannelId}&country=th' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object Station object

Station home list

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "stations": [
            {
                "stationId": "Station Id",
                "stationName": "Station Name",
                "serviceUrl": "https://tv.line.me/st/stationId",
                "stationLogo": "Station Logo Thumbnail Url"
            },
            ...
        ]
    }
}

Station home

Gets the Station Home (TV Station) data.

HTTP request

GET https://api.line.me/line-tv/v1/station?lineChannelId={lineChannelId}&country=th&stationId={stationId}

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Query parameters

Parameter Type Required Description
lineChannelId String Required Channel ID. Found on the LINE Developers console.
country String Required th
stationId String Required warnermusicthailand, gmmtv, gdh, etc. See Station Home List for complete details.

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/station?lineChannelId={lineChannelId}&country=th&stationId={stationId}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object Clip object
Channel object
Station object

Station home

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "popularClip": {
            "clips": [
                {
                    "serviceUrl": "https://tv.line.me/v/357314_2-4-exo-comeback-and-drama-special",
                    "displayPlayTime": "19:26",
                    "clipTitle": "(2/4) EXO Comeback and Drama Special",
                    "clipNo": 357314,
                    "likeitPoint": 14003,
                    "thumbnailUrl": "https://tv-img.pstatic.net/tv2-pt/20150409_142/xeQjG_1428561664637fqJ09_JPEG/531C04F3C319F38C36E3A23053FF91133C4_muploader_m_480P_854_1024_128_02.jpg?type=fcrop_234_132",
                    "playCount": 202966,
                    "clipSubtitle": ""
                },
               ...
            ],
            "hasMore": true
        },
        "popularChannel": {
            "channels": [
                {
                    "channelId": "lineglobal",
                    "channelEmblem": "",
                    "thumbnailUrl": "https://tv-img.pstatic.net/tv1-pt/20141231_237/y8Mcb_1420011347217G1soW_PNG/1420011347204.png?type=f234_336",
                    "channelName": "LINE Global",
                    "badgeType": "NEW",
                    "serviceUrl": "https://tv.line.me/lineglobal"
                },
                ...
            ],
            "hasMore": true
        },
        "fanCount": 2511027,
        "clipCount": 8474,
        "stationId": "StationId",
        "playCount": 2183422631,
        "likeitCount": 2960598,
        "channelCount": 67,
        "stationName": "Station Id",
        "stationDesc": "Station Desc",
        "stationBigBanner": "Station Big Banner Url",
        "stationBanner": {
            "imgUrl": "Station Banner Url",
            "linkUrl": ""
        },
        "stationLogo": "Station Logo Url"
    }
}

Live schedule

Gets live schedule information.

HTTP request

GET https://api.line.me/line-tv/v1/live/schedule?lineChannelId={lineChannelId}&country=th

Request headers

Request header Description
Content-Type application/json
Authorization Bearer {channel access token}

Query parameters

Parameter Type Required Description
lineChannelId String Required Channel ID. Found on the LINE Developers console.
country String Required th

Example request

curl -v -X GET 'https://api.line.me/line-tv/v1/live/schedule?lineChannelId={lineChannelId}&country=th' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {AccessToken}'

// No sample code available

# No sample code available

// No sample code available

# No sample code available

# No sample code available

# No sample code available

// No sample code available

Response

Returns a 200 HTTP status code and a JSON object with the following information.

Property Type Description
header Object
body Object Live object

live_schedule area

Example response

{
    "header": {
        "message": "",
        "code": 0
    },
    "body": {
        "lives": [
            {
                "serviceUrl": "https://tv.line.me/special/live/liveNo",
                "channelName": "Channel Name",
                "playCount": 8150,
                "liveTitle": "Channel Title",
                "thumbnailUrl": "https://tv-img.pstatic.net/tv1-pt/20190701_202/ZAXcw_156194683874691MxL_J/...jpg",
                "liveNo": 0,
                "liveStatus": "LIVE",
                "liveStartDate": "2019-07-01 14:00:00 (KST +0900)",
                "liveEndDate": "2019-07-22 13:50:00 (KST +0900)",
                "likeitPoint": 25
            },
            ...
        ]
    }
}

Object definitions

Clip object

The clip is the video content, whereas the clip object is the video information.

Property Type Description
clipNo Long Clip unique ID
clipTitle String Clip title
likeitPoint Long Likeit count
playCount Long Play count
displayPlayTime String Playtime of clip
thumbnailUrl String Thumbnail URL
serviceUrl String URL of LINE TV service

Clip object example

{
  "clip": {
    "serviceUrl": "https://tv.line.me/v/357314_2-4-exo-comeback-and-drama-special",
    "displayPlayTime": "19:26",
    "clipTitle": "(2/4) EXO Comeback and Drama Special",
    "clipNo": 357314,
    "likeitPoint": 14003,
    "thumbnailUrl": "https://tv-img.pstatic.net/tv2-pt/20150409_142/xeQjG_1428561664637fqJ09_JPEG/531C04F3C319F38C36E3A23053FF91133C4_muploader_m_480P_854_1024_128_02.jpg?type=fcrop_234_132",
    "playCount": 202966,
    "clipSubtitle": ""
  }
}

Channel object

The channel is the parent model of the video and playlist. The channel object contains the channel.

Property Type Description
channelId String Channel ID
channelName String Channel name
thumbnailUrl String thumbnail Url
serviceUrl String Url of LINE TV service
badgeType String NEW, UPDATE
channelEmblem String Round type thumbnail Url

Channel object example

{
  "channels": {
    "channelId": "lineglobal",
    "channelEmblem": "",
    "thumbnailUrl": "https://tv-img.pstatic.net/tv1-pt/20141231_237/y8Mcb_1420011347217G1soW_PNG/1420011347204.png?type=f234_336",
    "channelName": "LINE Global",
    "badgeType": "NEW",
    "serviceUrl": "https://tv.line.me/lineglobal"
  }
}

Playlist object

Property Type Description
title String
subtitle String text
playlists Arrays of Detail playlist objects

Playlist object example

{
    "playlists": [{
        "title": "รวมผลงานการผลิตจาก LINE TV ORIGINALS ",
        "subtitle": "การันตีความสนุก ครบรส ดูได้จนจบเรื่อง",
        "playlists": [{
            Detail Playlist object
        }]
    }]
}

Detail playlist object

Playlist object

Property Type Description
clipCount Integer Count of clips
playlistNo Integer Playlist unique ID
thumbnailUrl String Playlist thumbnail URL
playlistTitle String Playlist title
serviceUrl String URL of LINE TV service

Detail playlist object example

{
    "playlists": [{
        "title": "รวมผลงานการผลิตจาก LINE TV ORIGINALS ",
        "subtitle": "การันตีความสนุก ครบรส ดูได้จนจบเรื่อง",
        "playlists": [{
            "clipCount": 40,
            "playlistNo": 486387,
            "thumbnailUrl": "https://tv-img.pstatic.net/tv1-pt/20190716_240/dGNga_1563210813509RQLLO_PNG/1563210813465.png?type=fcrop_234_132",
            "playlistTitle": "พรุ่งนี้...จะไม่มีแม่แล้ว",
            "serviceUrl": "https://tv.line.me/v/8310669/list/486387"
        }]
    }]
}

Station object

The station is the parent model of the channel. The station object contains the (TV Station) data.

Property Type Description
stationId String Station unique ID
stationName String Station name
stationDesc String Station description
stationLogo String Logo thumbnail URL
stationBigBanner String Big banner thumbnail URL
playCount Long Play count
likeitCount Long Likeit count
fanCount Long Fan count
clipCount Long Count of clips
channelCount Long Count of channels
popularClip Array of Clip objects List of clips in order of popularity
popularChannel Array of Channel objects List of channels in order of popularity
stationBanner Object Banner thumbnail URL and link

Station object example

{
    "popularClip": {
        "clips": [{
                clip json
            },
            {
                clip json
            }
        ],
        "hasMore": true
    },
    "popularChannel": {
        "channels": [{
                channel json
            },
            {
                channel json
            }
        ],
        "hasMore": true
    },
    "likeitCount": 2963405,
    "fanCount": 2513708,
    "stationId": "gmmtv",
    "stationDesc": "Station desc",
    "stationLogo": "Station logo thumbnail url",
    "clipCount": 8474,
    "playCount": 2185407824,
    "stationBigBanner": "Station big banner url",
    "stationBanner": {
        "imgUrl": "Station banner url",
        "linkUrl": ""
    },
    "channelCount": 67,
    "stationName": "Station name"
}

Live object

Live video is real-time content streaming.

Property Type Description
serviceUrl String URL of LINETV service
channelName String Name of the channel that has live
playCount String Play count
liveTitle String Live title
thumbnailUrl String Live thumbnail URL
liveNo String Live unique no
liveStatus String NOT_AVAILABLE_LIVE(Deleted or not exposure), UPCOMING(Before live), LIVE(Live), PREPARE_CLIP(Live end), LIVE_END(Live end), MOVE_TO_CLIP(Live end), BLOCK(Block by administrator)
liveStartDate String Start date
liveEndDate String End date
likeitPoint String Likeit count

Live object example

{
    "live": {
             "serviceUrl": "https://tv.line.me/special/live/liveNo",
             "channelName": "Channel Name",
             "playCount": 8150,
             "liveTitle": "Channel Title",
             "thumbnailUrl": "https://tv-img.pstatic.net/tv1-pt/20190701_202/ZAXcw_156194683874691MxL_J/...jpg",
             "liveNo": 0,
             "liveStatus": "LIVE",
             "liveStartDate": "2019-07-01 14:00:00 (KST +0900)",
             "liveEndDate": "2019-07-22 13:50:00 (KST +0900)",
             "likeitPoint": 25
     }
}

{{ $t("form.question.helpful") }}

{{ $t("form.question.detail") }}

{{ $t("form.question.improve") }}

{{ $t("form.info.start") }}{{ $t("form.info.link") }}{{ $t("form.info.end") }}

{{ $t("form.result.success") }}
{{ $t("form.result.error") }}
{{ $t("form.result.errorLink") }}