채널 라이브 목록 조회
    • PDF

    채널 라이브 목록 조회

    • PDF

    기사 요약

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

    사용자 채널의 라이브 목록 정보를 조회하는 API입니다. B2B PRISM Live Studio에서의 사용 플로우를 확인하려면 방송 시작 프로세스를 참고해 주십시오.

    요청

    요청 형식은 다음과 같습니다.

    GET {serviceApiDomain}/prism/v1/service/channel/{channelId}/lives
    

    요청 헤더

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

    이름타입설명필수 여부
    x-prism-access-tokenStringOAuth2.0 인증을 통해 발급한 Access TokenY

    요청 경로 파라미터

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

    이름타입설명필수 여부
    channelIdString조회 대상 채널 IDY

    요청 쿼리 파라미터

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

    이름타입설명필수 여부
    statusString
  • 조회 대상 라이브 상태
  • ALL, RESERVED, ON_AIR, END
  • 기본값: ALL
  • Y

    응답

    응답 형식을 설명합니다.

    참고

    기본 응답 형식은 API 응답 기본 형식을 참고해 주십시오.

    이름타입설명필수 여부
    channelIdString채널 IDY
    livesObject라이브 목록Y

    live dto

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

    이름타입설명필수 여부
    liveIdString라이브 ID. 방송 조회 시 사용됨Y
    titleString라이브 제목을 지원하지 않는 서비스에서는 채널 이름을 전달해 주어야 함Y
    descriptionString라이브 설명N
    reservedAtDate
  • 라이브 예약시간
  • 예약 라이브가 아닌 경우 라이브 생성 시간
  • ISO 8601 형식으로 응답
  • Y
    startAtDate
  • 라이브 시작 시간
  • ISO 8601 형식으로 응답
  • N
    rtmpPathString
  • 송출 RTMP URL
  • rtmp:// 또는 rtmps:// 로 시작
  • 라이브 시작 후에만 제공되는 서비스에서는, 라이브 시작 후에만 rtmpPath를 제공
  • Y
    statusEnumeration [RESERVED, ONAIR, END]
  • 라이브 상태
  • 상태 관리를 하지 않는 서비스의 경우, ON_AIR를 기본값으로 제공
  • Y
    scopeEnumeration [PUBLIC, LIMITED, PRIVATE]
  • 라이브 공개 범위
  • PUBLIC: 공개, LIMITED: 일부 공개, PRIVATE: 비공개
  • Y
    liveLinkString
  • 해당 라이브를 볼 수 있는 서비스 링크
  • 없다면, 채널 홈 링크
  • Y
    liveStatObject라이브 통계 정보N

    liveStat dto

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

    이름타입설명필수 여부
    viewCountNumber방송 시작부터 누적된 시청자 수
    viewerCountNumber
  • 현재 시청자 수
  • 시청자 수 기준 1분 단위로 권장
  • likeCountNumber방송 시작부터 누적된 좋아요 수
    chatCountNumber방송 시작부터 누적된 채팅 수

    예시

    구문 예시를 소개합니다.

    요청 예시

    구문 예시는 다음과 같습니다.

    curl -X GET {serviceApiDomain}/prism/v1/service/channel/{channelId}/lives
        -H "x-prism-access-token: {access-token}"
    

    응답 예시

    구문 예시는 다음과 같습니다.

    {
        "success": true,
        "errorCode": 0,
        "errorName": null,
        "message": null,
        "data": {
            "lives": [
                {
                    "liveId": 14293,
                    "title": "라이브 중 입니다.",
                    "description": "라이브 설명입니다.",
                    "reservedAt": "2023-10-26T17:11:44+09:00",
                    "startAt": "2023-10-26T17:11:44+09:00",
                    "rtmpPath": "rtmp://global.rtmp.lip2.navercorp.com:8080/relay/8cnft2bpuhdm1vlx58vfa5nx78rs",
                    "status": "ON_AIR",
                    "liveLink": "https://test.com/14293",
                    "scope": "LIMITED",
                    "liveStat": {
                        "viewCount": 163,
                        "viewerCount": 3,
                        "likeCount": 46,
                        "chatCount": 2
                    }
                },
                {
                    "liveId": 14286,
                    "title": "라이브 입니다.",
                    "description": "종료된 라이브 입니다.",
                    "reservedAt": "2023-10-26T17:09:15+09:00",
                    "startAt": "2023-10-26T17:09:57+09:00",
                    "rtmpPath": "rtmp://global.rtmp.lip2.navercorp.com:8080/relay/5izsqqbzr71sed7qn8vf8g2hx5at",
                    "status": "END",
                    "liveLink": "https://test.com/14293",
                    "scope": "PUBLIC",
                    "liveStat": {
                        "viewCount": 925,
                        "viewerCount": 60,
                        "likeCount": 166,
                        "chatCount": 2
                    }
                }
            ],
            "channelId": 1000
        }
    }
    

    이 문서가 도움이 되었습니까?

    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.