Create schedule
- Print
- PDF
Create schedule
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
The API that creates Live Station VOD schedules. Schedule information search API is provided to see created schedule details.
VOD schedule
- By creating a schedule, videos (.mp4) uploaded to Object Storage can be set to be streamed live on a specified time (startTime).
- Up to 50 videos can be played. Refer below for more details.
Notes for creating VOD schedules
- Schedules can be only created when the VOD channel status is READY.
- If schedules already exist for a channel, then you can't create additional schedules.
- Schedules can be set again when a scheduled live broadcasting ends or a future schedule is deleted.
- The schedule start time (startTime) is requested based on KST (UTC+9).
Request
POST https://livestation.apigw.ntruss.com/api/v2/vod/schedule
Request header
| Header name | Requirement status | Description |
|---|---|---|
| x-ncp-apigw-timestamp | YES | It indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds, and if the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalidx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | YES | Access key ID value issued on the NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | YES | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | YES | Specifies the request body content type as application/jsonContent-Type: application/json |
| x-ncp-region_code | YES | Region code (KR) |
Request body
| Field name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| channelId | Yes | String | channelId of the VOD channel to stream the schedule to | Channels that will be used to proceed with schedule. Can't use the channels if schedules are already registered. |
| startTime | Yes | Integer | Can't input a time that is earlier than the time of request Minimum input time: Current request time + after 10 minutes Maximum input time: Current request time + 14 days | Start time for streaming input VOD Start time format: yyyymmddhhss Based on KST (UTC+9) |
| vodList[] | Yes | Array | Only the .mp4 extension is supported Up to 50 videos can be input | |
| vodList[].bucketName | Yes | String | Name of Object Storage bucket where the video to stream is stored | |
| vodList[].filePath | Yes | String | Object Storage's filePath where the video to stream is stored filePaths must start with "/" |
Response
| Field name | Type | Description | Remarks |
|---|---|---|---|
| scheduleId | Integer | ||
| channelId | String | ||
| createdTime | Timestamp | String | epoch time |
| startTime | Timestamp | epoch time | |
| updatedTime | Timestamp | ||
| status | String | CREATING,PROCESSING,PROCESSING_FAIL,UPDATING,READY,FINISH,DELETED | |
| vodList | Array |
Example
Request example
POST /api/v2/vod/schedule
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=
x-ncp-region_code:KR
Request body
{
"channelId": "ls-20211122220557-mUv3r",
"startTime": "20211124002500",
"vodList": [
{
"bucketName": "myBucket",
"filePath": "/myFile.mp4"
},
{
"bucketName": "myBucket2",
"filePath": "/mp4/myFile2.mp4"
},
{
"bucketName": "myBucket2,
"filePath": "/mp4/myFile3.mp4"
}
]
}
Response example
HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Feb 2021 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
{
"content": {
"scheduleId": 10053,
"channelId": "ls-20211122220557-mUv3r",
"createdTime": 1637679144884,
"startTime": 1637681100000,
"updatedTime": 1637679144884,
"status": "CREATING",
"vodList": [
"/myBucket/myFile.mp4",
"/myBucket2/mp4/myFile2.mp4",
"/myBucket2/mp4/myFile3.mp4"
]
}
}
Was this article helpful?