Callback Endpoint 등록

Live Station 에서 발생한 이벤트를 수신할 수 있는 Callback Endpoint 를 등록하는 API입니다.
Callback Endpoint는 전체 채널에 대한 콜백 설정과 개별 채널 콜백 설정을 구분하여 이용할 수 있습니다.

Callback 발송 데이터

Callback endpoint 를 등록하면 Live Station 에서 이벤트가 발생할 때마다 설정된 endpoint URL 로 아래와 같은 형태의 데이터가 전송됩니다. (HTTP POST 사용)

Callback 발송 응답 바디

Callback 발송 응답 예시

{
       "id": 1234,
       "logLevel": "INFO",
       "channelId": "ls-20200327140131-aBCD3",
       "event": "STREAM_UPDATE",
       "timestamp": 1599218791425
}

요청

요청별 콜백 발송 동작

요청 헤더

전체 채널 콜백 설정 요청 바디

개별 채널 콜백 설정 요청 바디

응답

전체 채널 콜백 설정 응답

일반 채널 콜백 설정 응답

리스트림 채널 콜백 설정 응답

예시

전체 채널 콜백 설정 요청 예시

POST /api/fin-v2/events/callbackEndpoint
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:FKR

{
  "callbackUrl": "https://my-callback-endpoint"
}

전체 채널 콜백 설정 응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
   "content": {
      "callbackUrl": "https://my-callback-endpoint",
       "updateTime": 1614751615488
   }
}

일반 채널별 콜백 설정 요청 예시

POST /api/fin-v2/channels/{channelId}/callbackEndpoint
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:FKR

{
  "callbackUrl": "https://my-callback-endpoint"
}

일반 채널별 콜백 설정 응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Sep 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" : {
        "channelId" : "ls-20200323114720-bMoDF",
        "channelName" : "mychannel",
        "instanceNo" : 1163899,
        "qualitySetId" : 6,
        "qualitySetName" : "360p-set",
        "outputProtocol" : "HLS, DASH",
        "channelStatus" : "READY",
        "isRecording" : false,
        "useDVR" : true,
        "immediateOnAir" : false,
        "timemachineMin" : 360,
        "cdn" : {
            "instanceNo" : "1163900",
            "serviceName" : "cdn-ls-20200323114720-bMoDF",
            "statusName" : "running",
            "cdnType" : "CDN_PLUS",
            "cdnDomain" : "mycdn.cdn.ntruss.com"
        },
       "record": {
            "type": "AUTO_UPLOAD",
            "bucketName": "hls",
            "filePath": "/livestation",
            "format": "MP4",
            "accessControl": "PRIVATE"
       },
        "publishUrl": "rtmp://live-station-rtmp-url",
        "streamKey": "jjiantco4psakuwd5526u2glcxrqaar4",
        "totalPublishSeconds" : 0,
        "createdTime" : 1584931640000,
        "recentPublishStartTime": 0,
        "alertOn" : false,
        "alertOptions" : {
            "alertChangeStatus" : false,
            "alertVodUploadFail" : false,
            "alertReStreamFail" : false
        },
        "callbackEndpoint": "https://my-callback-endpoint",
        "envType": "REAL"
    }
}

리스트림 채널별 콜백 설정 요청 예시

POST /api/fin-v2/re-stream/channels/{channelId}/callbackEndpoint
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:FKR

{
  "callbackUrl": "https://my-callback-endpoint"
}

리스트림 채널별 콜백 설정 응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Feb 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": {
    "channelId": "ls-20210225185132-FxGSn",
    "channelName": "mycallback-20210225185132",
    "instanceNo": 1627140,
    "channelStatus": "READY",
    "streamKey": "7xtotpxpkjnyhmjbe7k7jaa952q6lmhl",
    "publishUrl": "rtmp://live-station-rtmp-url",
    "planType": "STANDARD",
    "createdTime": 1614246692000,
    "restream": [
      {
        "id": "itis",
        "rtmpUrl": "rtmp://notworking-just-testcase.only",
        "streamKey": "12345",
        "password": "itispassword",
        "targetName": "YOUTUBE"
      }
    ],
    "platformCount": 1,
    "totalPublishSeconds": 0,
    "alertOn": false,
    "isPublishing": false,
    "alertOptions": {
      "alertChangeStatus": false,
      "alertVodUploadFail": false,
      "alertReStreamFail": false
    },
    "callbackEndpoint": "https://my-callback-endpoint",
    "envType": "REAL"
  }
}

VOD 채널별 콜백 설정 응답 예시

{
  "content": {
    "channelId": "ls-20211122220557-mUv3r",
    "channelName": "mycallback-20211235185132",
    "instanceNo": 2043025,
    "qualitySetId": 4,
    "qualitySetName": "720p-set",
    "outputProtocol": "HLS",
    "status": "READY",
    "cdn": {
      "instanceNo": "1541959",
      "serviceName": "cdn-ls-20201204112949-D7RTL",
      "instanceStatusCode": "RUN",
      "status": "RUNNING",
      "statusName": "running",
      "cdnType": "CDN_PLUS",
      "cdnDomain": "vcjjysxafrpa1541959.cdn.beta.ntruss.com",
      "isRunning": true
    },
    "totalPublishSeconds": 0,
    "createdTime": 1637586357000,
    "updatedTime": 1637587476000,
    "alertOn": false,
    "alertOptions": {
      "alertChangeStatus": false
    },
    "callbackEndpoint": "https://my-callback-endpoint",
    "envType": "REAL",
    "type": "VOD",
  }
}