Available in Classic and VPC
Set up SMS or email notifications to be sent to the admin when an event occurs on a general live channel.
When setting up event notifications, see the following:
- If you set event notifications with the API instead of the NAVER Cloud Platform console, you can set only one of the following reception types: SMS or email.
- To change the reception type, call the API again.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v2/notification/{channelId}/for-general-channel |
Request headers
For information about the headers common to all Live Station APIs, see Live Station request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
channelId |
String | Required | Channel ID
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
alertOn |
Boolean | Required | Event notification settings
|
alertChangeStatus |
Boolean | Optional | Channel status change notification application
|
alertVodUploadFail |
Boolean | Optional | Recording file upload failure notification application
|
alertReStreamFail |
Boolean | Optional | Re-stream relay failure notification application
|
alertShortClipFail |
Boolean | Optional | Short clip creation failure notification application
|
alertStreamFailOver |
Boolean | Optional | Main stream switch notification application
|
alertGeneralChannelError |
Boolean | Optional | Streaming failure error notification application
|
notificationManagerList |
Array | Required | Notification recipient list: notificationManagerList |
notificationManagerList
The following describes notificationManagerList
.
Field | Type | Required | Description |
---|---|---|---|
emailAddress |
String | Conditional | Admin email address
|
cellPhoneNo |
String | Conditional | Admin mobile phone number
|
managerNo |
Integer | Required | Admin number
|
notifyType |
String | Required | Reception type
|
Request example
The request example is as follows:
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"
}
]
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
content |
Object | - | Response result |
content.channelId |
String | - | Channel ID |
content.alertOn |
Boolean | - | Event notification settings
|
content.alertChangeStatus |
Boolean | - | Channel status change notification application
|
content.alertVodUploadFail |
Boolean | - | Recording file upload failure notification application
|
content.alertReStreamFail |
Boolean | - | Re-stream relay failure notification application
|
content.alertShortClipFail |
Boolean | - | Short clip creation failure notification application
|
content.alertStreamFailOver |
Boolean | - | Main stream switch notification application
|
content.reStreamFailThreshold |
Integer | - | Notification condition (base count) |
content.alertGeneralChannelError |
Boolean | - | Streaming failure error notification application
|
content.updatedTime |
Integer | - | Update date and time (millisecond)
|
Response status codes
For information about the HTTP status codes common to all Live Station APIs, see Live Station response status codes.
Response example
The response example is as follows:
{
"content": {
"channelId": "ls-20250814******-zTwK2",
"alertOn": true,
"alertChangeStatus": true,
"alertVodUploadFail": true,
"alertReStreamFail": false,
"alertShortClipFail": true,
"alertStreamFailOver": true,
"reStreamFailThreshold": 2,
"alertGeneralChannelError": true,
"updatedTime": 1755762842073
}
}