이벤트 알람 설정

API를 통해 General 채널의 일부 이벤트를 SMS 또는 이메일을 통해 수신할 수 있습니다.
API를 통한 이벤트 알람 설정은 SMS,이메일 중 하나만 지원합니다.
알람 설정을 위해 아래 세 가지 API를 요청합니다.
- 관리자 그룹 목록 조회
- 관리자 그룹 상세 조회
- 이벤트 알람 설정
관리자 그룹 목록 조회와 관리자 그룹 상세 조회는 통보 대상자 조회를 통해 조회 및 수정할 수 있습니다.
수신 타입 수정이 필요한 경우 3) 이벤트 알람 설정을 통해 수정할 수 있습니다.

요청

관리자 그룹 목록 조회

GET https://livestation.apigw.ntruss.com/api/v2/notification/manager-groups

관리자 그룹 상세 조회

GET https://livestation.apigw.ntruss.com/api/v2/notification/manager-groups/{manageGroupNo}

이벤트 알람 설정

POST https://livestation.apigw.ntruss.com/api/v2/notification/{channelId}/for-general-channel

이벤트 알람 설정 요청 바디

필드명	필수 여부	타입	제약 사항	설명
alertOn	Yes	Boolean		요청 채널의 알람 설정
alertVodUploadFail	Optional	Boolean		녹화 파일 업로드 실패 시 알람 발송
alertChangeStatus	Optional	Boolean		채널 상태 변경 시 알람 발송
alertGeneralChannelError	Optional	Boolean		채널 에러 발생시 알람 발송
alertShortClipFail	Optional	Boolean		숏클립 생성 실패 시 알람 발송
alertStreamFailOver	Optional	Boolean		메인 스트림 전환시 알람 발송
notificationManagerList[]	Yes	Object[]		알람 통보 대상 상세 정보
notificationManagerList[].emailAddress	No	String		notifyType이 이메일인 경우 입력
notificationManagerList[].cellPhoneNo	No	Integer		notifyType이 SMS인 경우 입력
notificationManagerList[].managerNo	Yes	Integer		알람 통보 대상
notificationManagerList[].notifyType	Yes	String	SMS, 이메일	SMS 또는 이메일

필드명

필수 여부

타입

제약 사항

설명

alertOn

Yes

Boolean

요청 채널의 알람 설정

alertVodUploadFail

Optional

Boolean

녹화 파일 업로드 실패 시 알람 발송

alertChangeStatus

Optional

Boolean

채널 상태 변경 시 알람 발송

alertGeneralChannelError

Optional

Boolean

채널 에러 발생시 알람 발송

alertShortClipFail

Optional

Boolean

숏클립 생성 실패 시 알람 발송

alertStreamFailOver

Optional

Boolean

메인 스트림 전환시 알람 발송

notificationManagerList[]

Yes

Object[]

알람 통보 대상 상세 정보

notificationManagerList[].emailAddress

String

notifyType이 이메일인 경우 입력

notificationManagerList[].cellPhoneNo

Integer

notifyType이 SMS인 경우 입력

notificationManagerList[].managerNo

Yes

Integer

알람 통보 대상

notificationManagerList[].notifyType

Yes

String

SMS, 이메일

SMS 또는 이메일

요청 헤더

헤더명	필수 여부	설명
x-ncp-apigw-timestamp	YES	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	YES	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	YES	Request body content type을 application/json으로 지정 `Content-Type: application/json`

헤더명

필수 여부

설명

x-ncp-apigw-timestamp

YES

- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄
- API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-apigw-timestamp:{Timestamp}

x-ncp-iam-access-key

YES

네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Sub Account Access Key}

x-ncp-apigw-signature-v2

YES

Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v2:{API Gateway Signature}

Content-Type

YES

Request body content type을 application/json으로 지정
Content-Type: application/json

필드명	타입	비고
channelId	String
alertOn	Boolean
alertChangeStatus	Boolean
alertVodUploadFail	Boolean
alertGeneralChannelError	Boolean
alertShortClipFail	Booelan
alertStreamFailOver	Booelan
alertReStreamFail	Boolean
reStreamFailThreshold	Integer
updatedTime	Timestamp	epoch time

필드명

타입

설명

비고

channelId

String

alertOn

Boolean

alertChangeStatus

Boolean

alertVodUploadFail

Boolean

alertGeneralChannelError

Boolean

alertShortClipFail

Booelan

alertStreamFailOver

Booelan

alertReStreamFail

Boolean

reStreamFailThreshold

Integer

updatedTime

Timestamp

epoch time

예시

요청 예시

POST /api/v2/notification/ls-20220623115623-fHnXy/for-general-channel HOST: livestation.apigw.ntruss.com Content-Type: application/json x-ncp-apigw-timestamp:1521787414578 x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M= { "alertOn": true, "alertShortClipFail": true, "notificationManagerList": [ { "emailAddress": "navercloud_livestation@navercorp.com", "managerNo": 7112, "notifyType": "EMAIL" } ] }

POST /api/v2/notification/ls-20220623115623-fHnXy/for-general-channel HOST: livestation.apigw.ntruss.com Content-Type: application/json x-ncp-apigw-timestamp:1521787414578 x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M= { "alertOn": true, "alertShortClipFail": true, "notificationManagerList": [ { "cellPhoneNo": "01012345678", "managerNo": 7112, "notifyType": "SMS" } ] }

응답 예시

HTTP/1.1 200 OK Server: nginx Date: Wed, 28 Jun 2022 09:53:32 GMT Content-Type: application/json;charset=utf-8 Connection: keep-alive Access-Control-Allow-Origin: * x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4 { "content": { "channelId": "ls-20220623115623-fHnXy", "alertOn": true, "alertChangeStatus": false, "alertVodUploadFail": false, "alertReStreamFail": false, "alertShortClipFail": false, "alertStreamFailOver": true, "reStreamFailThreshold": 2, "alertGeneralChannelError": false, "updatedTime": 1671527899089 } }

이벤트 알람 설정

요청

관리자 그룹 목록 조회

관리자 그룹 상세 조회