Callback Endpoint 등록(VOD2LIVE)

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

VOD2LIVE 채널의 이벤트를 수신할 콜백 엔드포인트를 등록합니다.

참고

콜백 발송 데이터 및 발송 동작에 대한 설명은 Callback Enpoint 등록을 참조해 주십시오.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /api/v2/vod/channels/{channelId}/callbackEndpoint

요청 헤더

Live Station API에서 공통으로 사용하는 헤더에 대한 정보는 Live Station 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
channelId String Required 채널 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
callbackEndpoint String Required 콜백 엔드포인트 URL

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/vod/channels/ls-20250820******-FdJkJ/callbackEndpoint' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json' \
--data '{
    "callbackEndpoint": "https://www.callback-endpoint.com"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
content Object - 채널 정보
content.channelId String - 채널 아이디
content.channelName String - 채널 이름
content.instanceNo Integer - 채널 인스턴스 번호
content.qualitySetId Integer - 화질 설정 아이디
content.qualitySetName String - 화질 설정 이름
content.outputProtocol String - Output Protocol
content.channelStatus String - 채널 상태
  • CREATING | READY | PUBLISHING | DELETED | BLOCK | RESERVED | FORCE_BLOCK | FORCE_DELETED
    • CREATING: 생성 중
    • READY: 준비
    • PUBLISHING: 송출 중
    • DELETED: 반납
    • BLOCK: 정지
    • RESERVED: 송출 예약
    • FORCE_BLOCK: 강제 정지
    • FORCE_DELETED: 사용 불가
content.cdn Object - CDN 설정
content.cdn.instanceNo String - CDN 인스턴스 아이디
content.cdn.serviceName String - CDN 서비스 이름
content.cdn.statusName String - CDN 상태
  • RUNNING | PUBLISHING | STOPPING | STOPPED | CREATING | CHANGING | CDN_NOT_FOUND
content.cdn.cdnType String - CDN 유형
  • GLOBAL_CDN | GLOBAL_EDGE
content.cdn.cdnDomain String - CDN 서비스 도메인
content.cdn.profileId Integer - Global Edge 프로필 아이디
content.cdn.regionType String - Global Edge 서비스 지역
content.totalPublishSeconds Integer - 채널 사용 시간(초)
content.createdTime Integer - 채널 생성 일시(밀리초)
  • Unix Timestamp 형식
content.updatedTime Integer - 채널 업데이트 일시(밀리초)
  • Unix Timestamp 형식
content.alertOn Boolean - 이벤트 알람 설정 여부
  • true | false
    • true: 설정
    • false: 설정 안 함
content.recentPublishTime Integer - 최근 송출 시작 일시(밀리초)
  • Unix Timestamp 형식
  • 최초 송출 전인 경우, 미표시
content.alertOptions Object - 이벤트 알람 설정
content.alertOptions.alertChangeStatus Boolean - 채널 상태 변경 알람 적용 여부
  • true | false
    • true: 적용
    • false: 적용 안 함
content.callbackEndpoint String - 콜백 엔드포인트 URL
content.envType String - 채널 타입
  • DEV | STAGE | REAL
content.type String - 채널 종류
  • VOD
content.scheduleList Array - 스케줄 목록: scheduleList
content.drmEnabledYn Boolean - Multi DRM 사용 여부
  • true | false
    • true: 사용
    • false: 사용 안 함
content.drm Object - Multi DRM 설정
  • content.drmEnabledYntrue인 경우, 하위 정보 표시
content.drm.siteId String - 사이트 아이디
content.drm.contentId String - 콘텐츠 아이디

scheduleList

scheduleList에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
scheduleId Integer - 스케줄 아이디
status String - 스케줄 상태

응답 상태 코드

Live Station API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Live Station 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "content": {
        "channelId": "ls-20250820******-FdJkJ",
        "channelName": "vl2_mychannel2",
        "instanceNo": 10******1,
        "qualitySetId": 4,
        "qualitySetName": "720p-set",
        "outputProtocol": "HLS",
        "channelStatus": "RESERVED",
        "cdn": {
            "instanceNo": "11577",
            "serviceName": "edge-ls-20250814*******-PZohi",
            "statusName": "RUNNING",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "*************.edge.naverncp.com",
            "profileId": 4207,
            "regionType": "KOREA"
        },
        "totalPublishSeconds": 0,
        "createdTime": 1755664159000,
        "updatedTime": 1755752406000,
        "alertOn": false,
        "alertOptions": {
            "alertChangeStatus": false
        },
        "callbackEndpoint": "https://www.callback-endpoint.com",
        "envType": "REAL",
        "type": "VOD",
        "scheduleList": [
            {
                "scheduleId": 1296,
                "status": "READY"
            }
        ],
        "drmEnabledYn": false
    }
}