Create schedule
- Print
- PDF
Create schedule
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
An API to create VOD schedules of Live Station. Provides the Schedule information view APIto view the created schedule information.
Note
- You can stream videos (mp4) uploaded to Object Storage live at a set time (start Time) through schedule creation.
- Supports up to 50 video playbacks. For more details, see the following information.
Caution
The following are the cautions for creating VOD schedules.
- You can only create the schedule when the VOD channel status is READY.
- If a reserved schedule already exists for the channel, you cannot create an additional schedule.
- After ending a scheduled broadcast or deleting a pending schedule, you can create a new schedule.
- Schedule start time is requested based on KST (UTC+9).
Requests
POST https://livestation.apigw.ntruss.com/api/v2/vod/schedule
Request headers
| Header name | Required | Description |
|---|---|---|
| x-ncp-apigw-timestamp | YES | Time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference compared to the API Gateway server is 5 minutes or longerx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | YES | Access key ID value issued from 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 bodies
| Field name | Required | Type | Service limits | Description |
|---|---|---|---|---|
| channelId | Yes | String | Channel ID of the VOD Channel for streaming the schedule | Channels with existing schedules are not available for scheduling |
| startTime | Yes | Integer | Time earlier than the request time cannot be entered Minimum input time: current request time + time after 10 minutes Maximum input time: current request time + 14 days | Start time to stream the entered VOD Start time format: yyyyMMddHHmmss Based on KST (UTC+9) |
| vodList | Yes | Array | Only mp4 file extension is allowed Up to 50 videos can be entered | |
| vodList.bucketName | Yes | String | Bucket name of the Object Storage where the video to be streamed is stored | |
| vodList.filePath | Yes | String | FilePath of the Object Storage where the video to be streamed is stored filePaths must start with "/" |
Responses
| Field name | Type | Description | Note |
|---|---|---|---|
| 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 |
Examples
Request examples
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 examples
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?