채널 목록 조회

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

동시 송출 채널 목록을 조회합니다.

요청

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

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

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`pageNo`	Integer	Optional	페이지 번호 1~N
`pageSizeNo`	Integer	Optional	페이지당 항목 수 1~100

요청 예시

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

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/re-stream/channels' \
--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`	Array	-	채널 목록: content
`total`	Integer	-	전체 응답 수

`content`

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

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

응답 상태 코드

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

응답 예시

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

{
    "content": [
        {
            "channelId": "ls-20250819******-Ik1QU",
            "channelName": "channel001",
            "instanceNo": 1082*****,
            "channelStatus": "READY",
            "streamKey": "zgarlukheigpxu******************",
            "publishUrl": "rtmp://***********.video.media.ntruss.com:8080/relay",
            "globalPublishUrl": "rtmp://***************.video.media.ntruss.com:8080/relay",
            "planType": "STANDARD",
            "createdTime": 1755571786000,
            "platformCount": 2,
            "totalPublishSeconds": 0,
            "alertOn": false,
            "isPublishing": false,
            "alertOptions": {
                "alertChangeStatus": false,
                "alertVodUploadFail": false,
                "alertReStreamFail": false,
                "alertStreamFailOver": false
            },
            "callbackEndpoint": "https://www.example.com",
            "envType": "REAL"
        }
    ],
    "total": 2
}