MENU
      View short-clip information

        View short-clip information


        Article summary

        An API to view short-clip information of Live Station. Provides the short-clip list view API to view short-clip list to view information on short-clips.

        Requests

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

        Request headers

        Header nameRequiredDescription
        x-ncp-apigw-timestampYESTime 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 longer
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyYESAccess key ID value issued from 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
        x-ncp-region_codeYESRegion code (KR)

        Responses

        Field nameTypeDescriptionNote
        channelIdStringChannel ID used in creating short-clip
        snapshotIdIntegerSnapshot ID used in creating short-clip
        shortclipObjectShort-clip object
        shortclip.idIntegerShort-clip ID
        shortclip.statusStringShort-clip statusCREATING,COMPLETED,PROCESSING_FAIL,UPLOAD_FAIL
        shortclip.outputObjectInformation in which the created short-clip is to be stored
        shortclip.output.accessControlStringOption which specifies the scope of disclosure of the Object Storage Bucket in which the created short-clip is to be stored
        Default: PRIVATE
        PRIVATE,PUBLIC_READ
        shortclip.output.bucketNameStringBucket name of the Object Storage in which the created short-clip is to be stored
        shortclip.output.fileNameStringFile name of the created short-clip
        shortclip.output.filePathStringfilePath of the Object Storage in which the created short-clip is to be stored
        filePaths must start with "/"
        shortclip.createdTimeIntegerTime of creation of the created short-clip file
        shortclip.updatedTimeIntegerUpdate time of the created short-clip file
        shortclip.fileSizeIntegerFile size of the created short-clip
        shortclip.durationIntegerPlayback time of the created short-clip

        Examples

        Response examples

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

        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.