Get Re-Stream channel information
    • PDF

    Get Re-Stream channel information

    • PDF

    Article Summary

    An API to search the detailed information of Re-Stream channel created in Live Station.

    Requests

    GET https://livestation.apigw.ntruss.com/api/v2/re-stream/channels/{channelId}
    

    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
    restreamObject[]
    restream[].targetNameString
    restream[].rtmpUrlString
    restream[].streamKeyString
    restream[].idStringDisplayed if set.
    restream[].passwordStringDisplayed if set.
    platformCountInteger
    totalPublishSecondsInteger
    recentPublishStartTimeInteger
    alertOnBoolean
    alertOptionsObject
    alertOptions.alertChangeStatusBoolean
    alertOptions.alertVodUploadFailBoolean
    alertOptions.alertReStreamFailBoolean
    isPublishingBoolean
    envTypeStringDEV, STAGE, REAL
    callbackEndpointString

    Examples

    Request Examples

    GET /api/v2/re-stream/channels/ls-20200324144322-qfphX
    HOST: livestation.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-timestamp:1521787414578
    x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
    x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
    x-ncp-region_code:KR
    

    Response examples

    HTTP/1.1 200 OK
    Server: nginx
    Date: Mon, 2 Mar 2021 09:53:32 GMT
    Content-Type: application/json;charset=utf-8
    Connection: keep-alive
    Access-Control-Allow-Origin: *
    x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
    
    {
        "content": {
            "alertOn": false,
            "alertOptions": {
                "alertChangeStatus": false,
                "alertReStreamFail": false,
                "alertVodUploadFail": false
            },
            "channelId": "ls-20200324144322-qfphX",
            "channelName": "myrestream",
            "channelStatus": "READY",
            "createdTime": 1585641254000,
            "instanceNo": 1173425,
            "isPublishing": false,
            "planType": "STANDARD",
            "platformCount": 2,
            "publishUrl": "rtmp://live-station-rtmp-url",
            "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
            "streamKey": "jjiantco4psakuwd5526u2glcxrqaar4",
            "restream": [
                {
                    "rtmpUrl": "rtmp://notworking-just-testcase.only",
                    "targetName": "YOUTUBE"
                },
                {
                    "id": "itisid",
                    "password": "itispassword",
                    "rtmpUrl": "rtmp://notworking-just-testcase.only",
                    "streamKey": "12345",
                    "targetName": "TWITCH"
                }
            ],
            "totalPublishSeconds": 0,
            "callbackEndpoint": "https://my-callback-endpoint",
            "envType": "DEV"
        }
    }
    

    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.