Setting notifications
    • PDF

    Setting notifications

    • PDF

    Article Summary

    The API allows you to receive some events happening on Live Station via SMS or email. You can check provided events through the event list search API.

    Note

    Set event notifications

    • Through the API, you can receive some events from the General channel via SMS or email.
    • Event notification setting through API supports either SMS or email.
    • The following three APIs are requested to set the notification.
      • View the admin group lists
      • View the admin group details
      • Set event notifications
    • You can search and edit the list of administrator groups and detailed administrator groups through the view notification recipient.
    • If the reception type needs to be edited, it can be edited through 3) Set event notifications.

    Requests

    View the admin group lists

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

    View the admin group details

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

    Set event notifications

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

    Event notification setup request bodies

    Field nameRequirement statusTypeRestrictionsDescription
    alertOnYesBooleanSet notification of request channel
    alertVodUploadFailOptionalBooleanDeliver notification upon failure to upload a recorded file
    alertChangeStatusOptionalBooleanDeliver notification upon change of channel status
    alertGeneralChannelErrorOptionalBooleanDeliver notification if error occurs in channel
    alertShortClipFailOptionalBooleanDeliver notification upon failure to create short clip
    alertStreamFailOverOptionalBooleanDeliver notification upon transition of main stream
    notificationManagerList[]YesObject[]Notification recipient details
    notificationManagerList[].emailAddressNoStringEnter if notifyType is email
    notificationManagerList[].cellPhoneNoNoIntegerEnter if notifyType is SMS
    notificationManagerList[].managerNoYesIntegerNotification recipient
    notificationManagerList[].notifyTypeYesStringSMS, emailSMS or email

    Request headers

    Header nameRequirement statusDescription
    x-ncp-apigw-timestampYES- This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 (UTC).
    - If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyYESValue of access key ID issued in the NAVER Cloud Platform portal
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2YESSignature encrypted with the access key ID value and secret key
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeYESSpecifies the request body content type as application/json
    Content-Type: application/json

    Event notification setup request responses

    Field nameTypeDescriptionRemarks
    channelIdString
    alertOnBoolean
    alertChangeStatusBoolean
    alertVodUploadFailBoolean
    alertGeneralChannelErrorBoolean
    alertShortClipFailBooelan
    alertStreamFailOverBooelan
    alertReStreamFailBoolean
    reStreamFailThresholdInteger
    updatedTimeTimestampepoch time

    Examples

    Request examples

    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"
        }
      ]
    }
    

    Response examples

    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
      }
    }
    

    Was this article helpful?

    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.