Contents x
    Retrieve a video info by customerVideoId
      • Print
      Contents

      Retrieve a video info by customerVideoId

        • Print
        Article summary

        Get
        /v2/{accessKey}/video/customerVideoId/{customerVideoId}
        Header parameters
        Authorization
        stringRequired

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        customerVideoId
        stringRequired

        Customer's video ID and must be unique(defined by the customer)

        Responses
        200

        200

        Result
        "{\n    \"videoId\": \"100\",\n    \"customerVideoId\": \"SHOPLIVE_VIDEO_1\",\n    \"title\": \"Updated Shoplive Introduction Video\",\n    \"description\": \"Description is updated\",\n    \"tags\":[\"tag1\"],\n    \"filename\": \"shoplive_introduction_video.mp4\",\n    \"width\": 1080,\n    \"height\": 1920,\n    \"filesize\": \"38128539\",\n    \"videoSourceUrl\": \"https://resource.shoplive.cloud/videos/vod/archive/{accessKey}/{streamKey}.mp4\",\n    \"thumbnailImageUrl\": \"https://image.shoplive.cloud/{streamKey}.jpg\",\n    \"liveStreamUrl\": \"https://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240.m3u8\",\n    \"liveStreamUrls\": \"https://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240/320p.m3u8\",\n    \"vodStreamUrl\": \"https://resource.shoplive.cloud/videos/vod/hls/{streamKey}.m3u8\",\n    \"vodStreamUrls\": \"https://resource.shoplive.cloud/videos/vod/hls/{streamKey}_320p/index.m3u8\",\n    \"duration\": 202000,\n    \"uploadProgress\": 100,\n    \"createdAt\": \"2022-12-09T09:17:04Z\",\n      \"updatedAt\": \"2022-12-09T09:17:04Z\"\n      \n}"
        object
        videoId
        string
        Example100
        customerVideoId
        string
        ExampleSHOPLIVE_VIDEO_1
        title
        string
        ExampleUpdated Shoplive Introduction Video
        description
        string
        ExampleDescription is updated
        tags
        Array of string
        string
        Exampletag1
        filename
        string
        Exampleshoplive_introduction_video.mp4
        width
        integer
        Default0
        Example1080
        height
        integer
        Default0
        Example1920
        filesize
        string
        Example38128539
        videoSourceUrl
        string
        Examplehttps://resource.shoplive.cloud/videos/vod/archive/{accessKey}/{streamKey}.mp4
        thumbnailImageUrl
        string
        Examplehttps://image.shoplive.cloud/{streamKey}.jpg
        liveStreamUrl
        string
        Examplehttps://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240.m3u8
        liveStreamUrls
        string
        Examplehttps://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240/320p.m3u8
        vodStreamUrl
        string
        Examplehttps://resource.shoplive.cloud/videos/vod/hls/{streamKey}.m3u8
        vodStreamUrls
        string
        Examplehttps://resource.shoplive.cloud/videos/vod/hls/{streamKey}_320p/index.m3u8
        duration
        integer
        Default0
        Example202000
        uploadProgress
        integer
        Default0
        Example100
        createdAt
        string
        Example2022-12-09T09:17:04Z
        updatedAt
        string
        Example2022-12-09T09:17:04Z
        4XX

        4XX

        Result
        "{\n    \"_s\": -000,\n    \"_e\": \"Error message\"\n}"
        What's Next