Classic/VPC 환경에서 이용 가능합니다.
일반 라이브 채널에서 이벤트 발생 시 관리자에게 SMS 또는 이메일 알람이 전송되도록 설정합니다.
참고
이벤트 알람 설정 시 다음 내용을 참고해 주십시오.
- 네이버 클라우드 플랫폼 콘솔이 아닌 API로 이벤트 알람을 설정하는 경우, SMS 또는 이메일 중 하나의 수신 타입으로만 설정할 수 있습니다.
- 수신 타입을 변경하려면 API를 다시 호출해 주십시오.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
POST | /api/v2/notification/{channelId}/for-general-channel |
요청 헤더
Live Station API에서 공통으로 사용하는 헤더에 대한 정보는 Live Station 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
channelId |
String | Required | 채널 아이디
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
alertOn |
Boolean | Required | 이벤트 알람 설정 여부
|
alertChangeStatus |
Boolean | Optional | 채널 상태 변경 알람 적용 여부
|
alertVodUploadFail |
Boolean | Optional | 녹화 파일 업로드 실패 알람 적용 여부
|
alertReStreamFail |
Boolean | Optional | 동시 송출 릴레이 실패 알람 적용 여부
|
alertShortClipFail |
Boolean | Optional | 숏클립 생성 실패 알람 적용 여부
|
alertStreamFailOver |
Boolean | Optional | 메인 스트림 전환 알람 적용 여부
|
alertGeneralChannelError |
Boolean | Optional | 송출 실패 에러 알람 적용 여부
|
notificationManagerList |
Array | Required | 통보 대상 목록: notificationManagerList |
notificationManagerList
notificationManagerList
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
emailAddress |
String | Conditional | 관리자 메일 주소
|
cellPhoneNo |
String | Conditional | 관리자 휴대폰 번호
|
managerNo |
Integer | Required | 관리자 번호
|
notifyType |
String | Required | 수신 타입
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/notification/ls-20250814******-zTwK2/for-general-channel' \
--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-raw '{
"alertOn": true,
"alertChangeStatus": true,
"alertVodUploadFail": true,
"alertReStreamFail": false,
"alertShortClipFail": true,
"alertStreamFailOver": true,
"alertGeneralChannelError": true,
"notificationManagerList": [
{
"emailAddress": "ghdrlfehd@navercloud.com",
"cellPhoneNo": "01012345678",
"managerNo": ******,
"notifyType": "SMS"
}
]
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
content |
Object | - | 응답 결과 |
content.channelId |
String | - | 채널 아이디 |
content.alertOn |
Boolean | - | 이벤트 알람 설정 여부
|
content.alertChangeStatus |
Boolean | - | 채널 상태 변경 알람 적용 여부
|
content.alertVodUploadFail |
Boolean | - | 녹화 파일 업로드 실패 알람 적용 여부
|
content.alertReStreamFail |
Boolean | - | 동시 송출 릴레이 실패 알람 적용 여부
|
content.alertShortClipFail |
Boolean | - | 숏클립 생성 실패 알람 적용 여부
|
content.alertStreamFailOver |
Boolean | - | 메인 스트림 전환 알람 적용 여부
|
content.reStreamFailThreshold |
Integer | - | 알람 발생 조건(기준 횟수) |
content.alertGeneralChannelError |
Boolean | - | 송출 실패 에러 알람 적용 여부
|
content.updatedTime |
Integer | - | 업데이트 일시(밀리초)
|
응답 상태 코드
Live Station API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Live Station 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"content": {
"channelId": "ls-20250814******-zTwK2",
"alertOn": true,
"alertChangeStatus": true,
"alertVodUploadFail": true,
"alertReStreamFail": false,
"alertShortClipFail": true,
"alertStreamFailOver": true,
"reStreamFailThreshold": 2,
"alertGeneralChannelError": true,
"updatedTime": 1755762842073
}
}