이벤트 알람 설정
    • PDF

    이벤트 알람 설정

    • PDF

    Article Summary

    Live Station에서 발생 하는 일부 이벤트를 SMS 또는 EMAIL 을 통해 수신 할 수 있는 API 입니다. 제공 되는 이벤트는 이벤트 목록 조회 API를 통해 확인할 수 있습니다.

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

    요청

    관리자 그룹 목록 조회

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

    관리자 그룹 상세 조회

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

    이벤트 알람 설정

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

    이벤트 알람 설정 요청 바디

    필드명필수 여부타입제약 사항설명
    alertOnYesBoolean요청 채널의 알람 설정
    alertVodUploadFailYesBoolean녹화 파일 업로드 실패시 알람 발송
    alertChangeStatusYesBoolean채널 상태 변경시 알람 발송
    alertGeneralChannelErrorYesBoolean
    alertShortClipFailYesBoolean숏클립 생성 실패시 알람 발송
    notificationManagerList[]YesObject[]알람 통보 대상 상세 정보
    notificationManagerList[].emailAddressNoStringnotifyType 이 EMAIL 인 경우 입력
    notificationManagerList[].cellPhoneNoNoIntegernotifyType 이 SMS 인 경우 입력
    notificationManagerList[].managerNoYesInteger알람 통보 대상
    notificationManagerList[].notifyTypeYesStringSMS, EMAILSMS 또는 EMAIL

    요청 헤더

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

    이벤트 알람 설정 요청 응답

    필드명타입설명비고
    channelIdString
    alertOnBoolean
    alertChangeStatusBoolean
    alertVodUploadFailBoolean
    alertGeneralChannelErrorBoolean
    alertShortClipFailBooelan
    alertReStreamFailBoolean
    alertStreamFailOverBooelan
    reStreamFailThresholdInteger
    updatedTimeTimestampepoch 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,
        "alertGeneralChannelError": false,
        "alertReStreamFail": false,
        "reStreamFailThreshold": 0,
        "alertStreamFailOver": true,
        "alertShortClipFail": true,
        "updatedTime": 1656400018246
      }
    }
    

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

    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.