MENU
      Get Re-Stream channel list

        Get Re-Stream channel list


        Article summary

        An API to search the list of all Re-Stream channels created in Live Station.

        Requests

        GET https://livestation.apigw.ntruss.com/api/v2/re-stream/channels?pageNo={pageNo}&pageSizeNo={pageSizeNo}
        HTTP

        Request Parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        pageNoNoIntegerNo restrictionPage index to search
        pageSizeNoNoInteger1-100- Number of channels to include when searching lists
        e.g., Assuming 60 channels are created, if the pageSize is 1 and the pageSizeNo is 30, then 30 channel lists will be searched per page.

        Request headers

        Header nameRequirement statusDescription
        x-ncp-apigw-timestampYESIt indicates the time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds and the request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyYESValue of Access Key ID issued on NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2YESSignature encrypted with the Access Key ID value and Secret Key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        x-ncp-region_codeYESRegion code (KR)

        Responses

        Field nameTypeDescriptionRemarks
        channelIdString
        channelNameString
        instanceNoInteger
        channelStatusStringCREATING, READY, PUBLISH, DELETED, BLOCK, FORCE_BLOCK, FORCE_DELETED
        createdTimeInteger
        publishUrlString
        globalPublishUrlStringURL for supporting overseas transmission
        streamKeyString
        planTypeStringSTANDARD, PROFESSIONAL
        platformCountInteger
        totalPublishSecondsInteger
        recentPublishStartTimeInteger
        alertOnBooleanif alertOn == true, alertOptions should be set
        alertOptionsObject
        alertOptions.alertChangeStatusBoolean
        alertOptions.alertVodUploadFailBoolean
        alertOptions.alertReStreamFailBoolean
        isPublishingBoolean
        envTypeStringDEV, STAGE, REAL
        callbackEndpointString

        Examples

        Request Examples

        GET /api/v2/re-stream/channels?pageNo=1&pageSizeNo=5
        HOST: livestation.apigw.ntruss.com
        Content-Type: application/json
        x-ncp-apigw-timestamp:1621247953566
        x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
        x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
        x-ncp-region_code:KR
        HTTP

        Response examples

        HTTP/1.1 200 OK
        Server: nginx
        Date: Mon, 17 May 2021 10:39:13 GMT
        Content-Type: application/json;charset=utf-8
        Connection: keep-alive
        Access-Control-Allow-Origin: *
        x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
        
        {
          "content": [
            {
              "channelId": "ls-20210303183939-FPl57",
              "channelName": "mychannel1",
              "instanceNo": 1636923,
              "channelStatus": "READY",
              "streamKey": "sghkubvlihljzs1hcpnr9afcn8vyfx0j",
              "publishUrl": "rtmp://live-station-rtmp-url",
              "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
              "planType": "STANDARD",
              "createdTime": 1614764380000,
              "platformCount": 1,
              "totalPublishSeconds": 0,
              "alertOn": false,
              "isPublishing": false,
              "alertOptions": {
                "alertChangeStatus": false,
                "alertVodUploadFail": false,
                "alertReStreamFail": false
              },
              "callbackEndpoint": "https://my-callback-endpoint",
              "envType": "STAGE"
            },
            {
              "channelId": "ls-20210303182116-Xfv8C",
              "channelName": "mychannel2",
              "instanceNo": 1636821,
              "channelStatus": "READY",
              "streamKey": "kiwybf3fehttq31qks2anafc965oogyf",
              "publishUrl": "rtmp://live-station-rtmp-url",
              "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
              "planType": "STANDARD",
              "createdTime": 1614763276000,
              "platformCount": 2,
              "totalPublishSeconds": 0,
              "alertOn": false,
              "isPublishing": false,
              "alertOptions": {
                "alertChangeStatus": false,
                "alertVodUploadFail": false,
                "alertReStreamFail": false
              },
              "callbackEndpoint": "https://my-callback-endpoint",
              "envType": "REAL"
            },
            {
              "channelId": "ls-20210302104436-GtJw5",
              "channelName": "mychannnel3",
              "instanceNo": 1632553,
              "channelStatus": "READY",
              "streamKey": "bnvcvgyxyc1asu77fihv6ae7wz3j897c",
              "publishUrl": "rtmp://live-station-rtmp-url",
              "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
              "planType": "STANDARD",
              "createdTime": 1614649476000,
              "platformCount": 1,
              "totalPublishSeconds": 0,
              "alertOn": false,
              "isPublishing": false,
              "alertOptions": {
                "alertChangeStatus": false,
                "alertVodUploadFail": false,
                "alertReStreamFail": false
              },
              "callbackEndpoint": "https://my-callback-endpoint",
              "envType": "REAL"
            },
            {
              "channelId": "ls-20210302104256-gk927",
              "channelName": "mychannel4",
              "instanceNo": 1632552,
              "channelStatus": "READY",
              "streamKey": "ejn5jpuc3g2yvq1thn3z9ae7vp093ndg",
              "publishUrl": "rtmp://live-station-rtmp-url",
              "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
              "planType": "STANDARD",
              "createdTime": 1614649376000,
              "platformCount": 1,
              "totalPublishSeconds": 0,
              "alertOn": false,
              "isPublishing": false,
              "alertOptions": {
                "alertChangeStatus": false,
                "alertVodUploadFail": false,
                "alertReStreamFail": false
              },
              "callbackEndpoint": "https://my-callback-endpoint",
              "envType": "REAL"
            },
            {
              "channelId": "ls-20210225185132-FxGSn",
              "channelName": "mychannel5",
              "instanceNo": 1627140,
              "channelStatus": "READY",
              "streamKey": "7xtotpxpkjnyhmjbe7k7jaa952q6lmhl",
              "publishUrl": "rtmp://live-station-rtmp-url",
              "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
              "planType": "STANDARD",
              "createdTime": 1614246692000,
              "platformCount": 1,
              "totalPublishSeconds": 0,
              "alertOn": false,
              "isPublishing": false,
              "alertOptions": {
                "alertChangeStatus": false,
                "alertVodUploadFail": false,
                "alertReStreamFail": false
              },
              "callbackEndpoint": "https://my-callback-endpoint",
              "envType": "REAL"
            }
          ],
          "total": 26
        }
        HTTP

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.