채널 조회

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

동시 송출 채널의 상세 정보를 조회합니다.

요청

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

메서드	URI
GET	/api/v2/re-stream/channels/{channelId}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`channelId`	String	Required	채널 아이디 채널 목록 조회 참조

요청 예시

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

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/re-stream/channels/ls-20250821******-GHiLB' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`content`	Object	-	채널 정보
`content.channelId`	String	-	채널 아이디
`content.channelName`	String	-	채널 이름
`content.instanceNo`	Integer	-	채널 인스턴스 번호
`content.channelStatus`	String	-	채널 상태 `CREATING` \| `READY` \| `PUBLISHING` \| `DELETED` \| `BLOCK` \| `FORCE_BLOCK` \| `FORCE_DELETED` `CREATING`: 생성 중 `READY`: 준비 `PUBLISHING`: 송출 중 `DELETED`: 반납 `BLOCK`: 정지 `FORCE_BLOCK`: 강제 정지 `FORCE_DELETED`: 사용 불가
`content.streamKey`	String	-	스트림 키
`content.publishUrl`	String	-	기본 송출 URL
`content.globalPublishUrl`	String	-	해외 송출 URL
`content.planType`	String	-	요금제 타입 `STANDARD` \| `PROFESSIONAL` `STANDARD`: 최대 3개 플랫폼으로 동시 송출 가능 `PROFESSIONAL`: 최대 5개 플랫폼으로 동시 송출 가능
`content.createdTime`	Integer	-	채널 생성 일시(밀리초) Unix Timestamp 형식
`content.restream`	Array	-	동시 송출 플랫폼 정보: restream
`content.platformCount`	Integer	-	동시 송출 플랫폼 수
`content.totalPublishSeconds`	Integer	-	채널 사용 시간(초)
`content.alertOn`	Boolean	-	이벤트 알람 설정 여부 `true` \| `false` `true`: 설정 `false`: 설정 안 함
`content.isPublishing`	Boolean	-	송출 여부 `true` \| `false` `true`: 송출 중 `false`: 송출 중 아님
`content.alertOptions`	Object	-	이벤트 알람 설정
`content.alertOptions.alertChangeStatus`	Boolean	-	동시 송출용 채널 상태 변경 알람 적용 여부 `true` \| `false` `true`: 적용 `false`: 적용 안 함
`content.alertOptions.alertVodUploadFail`	Boolean	-	녹화 파일 업로드 실패 알람 적용 여부 `true` \| `false` `true`: 적용 `false`: 적용 안 함
`content.alertOptions.alertReStreamFail`	Boolean	-	동시 송출 릴레이 실패 알람 적용 여부 `true` \| `false` `true`: 적용 `false`: 적용 안 함
`content.alertOptions.reStreamFailThreshold`	Integer	-	알람 발생 조건(기준 횟수) 알람 최초 설정 전인 경우, 미표시
`content.alertOptions.alertStreamFailOver`	Boolean	-	메인 스트림 전환 알람 적용 여부 `true` \| `false` `true`: 적용 `false`: 적용 안 함
`content.callbackEndpoint`	String	-	콜백 엔드포인트 URL 유효 값 존재 시 표시
`content.envType`	String	-	채널 타입 `REAL` \| `DEV` \| `STAGE`

`restream`

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

필드	타입	필수 여부	설명
`id`	String	-	RTMP 인증 아이디 인증 정보가 설정된 경우, 표시
`rtmpUrl`	String	-	동시 송출 플랫폼 RTMP URL
`streamKey`	String	-	동시 송출 플랫폼 스트림 키
`password`	String	-	RTMP 인증 비밀번호 인증 정보가 설정된 경우, 표시 첫 번째 문자를 제외한 문자열은 마스킹 처리
`targetName`	String	-	동시 송출 플랫폼 이름

응답 상태 코드

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

응답 예시

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

{
    "content": {
        "channelId": "ls-20250821******-GHiLB",
        "channelName": "channel000",
        "instanceNo": 1083*****,
        "channelStatus": "READY",
        "streamKey": "1uxvnw2z6bxqqy******************",
        "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
        "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
        "planType": "STANDARD",
        "createdTime": 1755757259000,
        "restream": [
            {
                "rtmpUrl": "rtmp://x.rtmp.youtube.com/live2",
                "streamKey": "****-****-****-****-****",
                "targetName": "YOUTUBE"
            }
        ],
        "platformCount": 1,
        "totalPublishSeconds": 177,
        "recentPublishTime": 1755845515000,
        "alertOn": true,
        "isPublishing": false,
        "alertOptions": {
            "alertChangeStatus": true,
            "alertVodUploadFail": false,
            "alertReStreamFail": true,
            "reStreamFailThreshold": 1,
            "alertStreamFailOver": false
        },
        "callbackEndpoint": "https://www.example.com",
        "envType": "REAL"
    }
}