English

# 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.

Example request

    # HTTP request

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

    # Request headers

    Content-Type

    application/json

    Authorization

    Bearer {Channel Access Token}

    # Query parameters

    lineChannelId

    String

    Required

    Channel ID. Found on the LINE Developers Console.

    country

    String

    Required

    th

    # Response

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

    header

    Object

    body

    Object

    Names of the curation DataModule

    Example response

      # Spotlight curation module

      Gets spotlight data.

      Example request

        # HTTP request

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

        # Request headers

        Content-Type

        application/json

        Authorization

        Bearer {channel access token}

        # Query parameters

        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.

        # Response

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

        header

        Object

        body

        Object

        Clip object
        Channel object
        Playlist object

        Example response

          # 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

          # Category list

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

          Example request

            # HTTP request

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

            # Request headers

            Content-Type

            application/json

            Authorization

            Bearer {channel access token}

            # Query parameters

            lineChannelId

            Required

            Channel ID. Found on the LINE Developers Console.

            country

            Required

            th

            # Response

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

            header

            Object

            body

            Object

            Example response

              # Category list locations

              Category list location Category list location

              # Category

              Gets category home data.

              Example request

                # HTTP request

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

                # Request headers

                Content-Type

                application/json

                Authorization

                Bearer {Channel Access Token}

                # Query parameters

                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

                # Response

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

                header

                Object

                body

                Object

                Clip object
                Channel object

                LINE TV category home

                Example response

                  # Ranking

                  Gets clip ranking data.

                  Example request

                    # HTTP request

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

                    # Request headers

                    Content-Type

                    application/json

                    Authorization

                    Bearer {channel access token}

                    # Query parameters

                    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

                    # Response

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

                    header

                    Object

                    body

                    Object

                    Clip object

                    clip_ranking area

                    Example response

                      Gets a clip search result.

                      Example request

                        # HTTP request

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

                        # Request headers

                        Content-Type

                        application/json

                        Authorization

                        Bearer {channel access token}

                        # Query parameters

                        lineChannelId

                        String

                        Required

                        Channel ID. Found on the LINE Developers Console.

                        country

                        String

                        Required

                        th

                        query

                        String

                        Required

                        Search query

                        # Response

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

                        header

                        Object

                        body

                        Object

                        Clip object

                        Search results example

                        Example response

                          # Search ranking

                          Gets a list of search rankings from the last hour.

                          Example request

                            # HTTP request

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

                            # Request headers

                            Content-Type

                            application/json

                            Authorization

                            Bearer {channel access token}

                            # Query parameters

                            lineChannelId

                            String

                            Required

                            Channel ID. Found on the LINE Developers Console.

                            country

                            String

                            Required

                            th

                            # Response

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

                            header

                            Object

                            body

                            Object

                            Search results example

                            Example response

                              # Station home list

                              Gets the station home (TV station) list.

                              Example request

                                # HTTP request

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

                                # Request headers

                                Content-Type

                                application/json

                                Authorization

                                Bearer {channel access token}

                                # Query parameters

                                lineChannelId

                                String

                                Required

                                Channel ID. Found on the LINE Developers Console.

                                country

                                String

                                Required

                                th

                                # Response

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

                                header

                                Object

                                body

                                Object

                                Station object

                                Station home list

                                Example response

                                  # Station home

                                  Gets the Station Home (TV Station) data.

                                  Example request

                                    # HTTP request

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

                                    # Request headers

                                    Content-Type

                                    application/json

                                    Authorization

                                    Bearer {channel access token}

                                    # Query parameters

                                    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.

                                    # Response

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

                                    header

                                    Object

                                    body

                                    Object

                                    Clip object
                                    Channel object
                                    Station object

                                    Station home

                                    Example response

                                      # Live schedule

                                      Gets live schedule information.

                                      Example request

                                        # HTTP request

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

                                        # Request headers

                                        Content-Type

                                        application/json

                                        Authorization

                                        Bearer {channel access token}

                                        # Query parameters

                                        lineChannelId

                                        String

                                        Required

                                        Channel ID. Found on the LINE Developers Console.

                                        country

                                        String

                                        Required

                                        th

                                        # Response

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

                                        header

                                        Object

                                        body

                                        Object

                                        Live object

                                        live_schedule area

                                        Example response

                                          # Object definitions

                                          # Clip object

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

                                          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

                                            # Channel object

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

                                            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

                                              # Playlist object

                                              title

                                              String

                                              subtitle

                                              String

                                              text

                                              playlists

                                              Arrays of Detail playlist objects

                                              Playlist object example

                                                # Detail playlist object

                                                Playlist object

                                                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

                                                  # Station object

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

                                                  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

                                                    # Live object

                                                    Live video is real-time content streaming.

                                                    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