Contents x
    Search videos
      • Print
      Contents

      Search videos

        • Print
        Article summary

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

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        Query parameters
        keyword
        string

        Keyword to search title and description of videos

        sortAscending
        boolean

        Sort the result of the query

        Defaultfalse
        page
        integer (int32)

        Parameter for pagination. Default is 1.

        Default1
        count
        integer (int32)

        Specify the number of the result in one page (max : 30)

        Default30
        customerVideoId
        string

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

        Default"null"
        tags
        array of string

        Comma separated tags for search. Pleas use tagSearchOperator to specify AND or OR query.

        tagSearchOperator
        string

        Please specify search operator when searching by tags (AND / OR)

        Responses
        200

        200

        Result
        "{\n    \"results\": [\n        {\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},\n        {\n    \"videoId\": \"200\",\n    \"customerVideoId\": \"SHOPLIVE_VIDEO_2\",\n    \"title\": \"Updated Shoplive Introduction Video2\",\n    \"description\": \"Description is updated 2\",\n    \"tags\":[\"tag2\"],\n    \"filename\": \"shoplive_introduction_video2.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}\n    ],\n    \"totalCount\": 2\n}"
        Expand All
        object
        results
        Array of object
        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
        totalCount
        integer
        Default0
        Example2
        4XX

        4XX

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