Search shortclip info
  • PDF

Search shortclip info

  • PDF

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

This is an API for retrieving short clip information of Live Station. Shortclip List Inquiry API is provided for short clip list inquiry for short clip information inquiry.

Request

GET https://livestation.apigw.ntruss.com/api/v2/channels/{channelId}/shortclip/{id}

Request header

Header Required Description
x-ncp-apigw-timestamp YES It is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key YES Access Key ID issued from the NAVER CLOUD PLATFORM portal.
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 YES Signature encrypted with your Access Key ID and Secret Key.
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type YES Set the request body content type to application/json.
Content-Type: application/json
x-ncp-region_code YES Region code (KR)

Response

field name Required type Restrictions Description
channelId Yes String Channel ID used to create the shortclip
snapshotId Yes Integer Snapshot ID used to create the shortclip
shortclip Yes Object Shortclip Object
shortclip.id Yes Integer Shortclip ID
shortclip.status Yes String CREATING,COMPLETED,PROCESSING_FAIL,UPLOAD_FAIL Shortclip Status
shortclip.output Yes Object Information where the created shortclip will be saved
shortclip.output.accessControl Yes String PRIVATE,PUBLIC_READ Option to designate the public scope of the Object Storage Bucket where the created shortclip will be saved
Default: PRIVATE
shortclip.output.bucketName Yes String Bucket name of object storage where the created shortclip will be saved
shortclip.output.fileName Yes String File name of the created shortclip
shortclip.output.filePath Yes String FilePath of the object storage where the created shortclip will be saved
filePath must start with "/"
shortclip.createdTime Yes Integer Creation time of the created shortclip file
shortclip.updatedTime Yes Integer Update time of the created shortclip file
shortclip.fileSize No Integer File size of the created shortclip
shortclip.duration No Integer Duration of the created shortclip

Example

Example response

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 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",
    "snapshotId": 1047,
    "shortclip": {
      "id": 1060,
      "status": "CREATING",
      "createdTime": 1655979377666,
      "updatedTime": 1655979377666,
      "output": {
        "accessControl": "PRIVATE",
        "bucketName": "myTestBucket",
        "filePath": "/",
        "fileName": "1024-1655290646131.mp4"
      }
    }
  }
}

Was this article helpful?