라이브 시작

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

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

참고

라이브 시작/종료 기능을 지원하지 않는 서비스는 rtmpPath만 제공합니다. 라이브 시작 시 동일 채널에서 송출 중인 라이브가 있는 경우, 강제종료하고 신규 라이브를 시작합니다.

요청

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

PUT /prism/v1/service/live/{liveId}/start

요청 헤더

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

이름	타입	설명	필수 여부
x-prism-access-token	String	OAuth2.0 인증을 통해 발급한 Access Token	Y

요청 경로 파라미터

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

이름	타입	설명	필수 여부
liveId	String	라이브 ID	Y

응답

응답 형식을 설명합니다.

참고

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

이름	타입	설명	필수 여부
live	Object	라이브 객체	Y

live dto

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

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

liveStat dto

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

이름	타입	설명
viewCount	Number	방송 시작부터 누적된 시청자 수
viewerCount	Number	현재 시청자 수 시청자 수 기준 1분 단위로 권장
likeCount	Number	방송 시작부터 누적된 좋아요 수
chatCount	Number	방송 시작부터 누적된 채팅 수

예시

구문 예시를 소개합니다.

요청 예시

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

curl -X PUT /prism/v1/service/live/{liveId}/start
    -H "x-prism-access-token: {access-token}"

응답 예시

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

{
    "success": true,
    "errorCode": 0,
    "errorName": null,
    "message": null,
    "data": {
        "liveId": 57082,
        "title": "라이브 제목 입니다.",
        "description": "라이브 설명 입니다.",
        "reservedAt": "2023-12-13T02:00:00+09:00",
        "startAt": "2023-12-29T23:59:00+09:00",
        "rtmpPath": "rtmp://global.rtmp.lip2.navercorp.com:8080/relay/scr14opcsi1tgvvxl4av1a1x3i3u6dha",
        "status": "ON_AIR",
        "liveLink": "https://example.com/1391275",
        "scope": "PUBLIC",
        "liveStat": {
            "viewCount": null,
            "viewerCount": null,
            "likeCount": null,
            "chatCount": null
        }
    }
}