LongVideo mobile client operations - - Alibaba Cloud Documentation Center

Overview

This topic describes the API operations of the LongVideo mobile client.

Response structure

The AppServer returns JSON-formatted data for all requests. Only structure data is described in the return result of all API operations.

result	Boolean	Indicates whether the operation is successful.
requestId	String	The GUID generated by the AppServer for the request.
code	String	The code generated by the AppServer for the request.
message	String	The message returned by the AppServer to describe the result of the operation or the cause of an error.
data	Object	The business structure data returned by the AppServer. The data structure varies with the business.

Long video

getRecommnedTvPlayList

You can call this operation to query recommended TV plays.

Method	GET
URL	/longVideo/getRecommnedTvPlayList
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	pageIndex	Integer	Yes	The start page number. It starts from 1.
	pageSize	Integer	Yes	The number of entries to return on each page.

Response parameters
	Parameter	Type	Description
	total	String	The total number of videos.
	tag	String	The tags of recommended TV plays. Separate multiple tags with commas (,).
	tvPlayList	List<tvPlay>	The list of recommended TV play information.

The following table lists parameters in tvPlay.

Parameter	Type	Description
id	String	The ID.
tvId	String	The ID of the TV play.
tvName	String	The name of the TV play.
title	String	The title of the TV play.
description	String	The description of the TV play.
coverUrl	String	The URL of the TV play thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
size	String	The length of the video. Unit: milliseconds.
tags	String	The tags of the TV play. Separate multiple tags with commas (,).
cateId	String	The ID of the category to which the TV play belongs.
cateName	String	The name of the category to which the TV play belongs.
total	String	The total number of episodes in the TV play.
creationTime	String	The time when the TV play was created.
isRecommend	String	Indicates whether the TV play is recommended. Valid values: true and false.
isRelease	String	Indicates whether the TV play is published. Valid values: true and false.
isHomePage	String	Indicates whether the TV play is displayed on the homepage. Valid values: true and false.

Sample response:

{
  "result": "true",
  "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  "message": "",
  "code": "200",
  "data": {
    "total": 1,
    "tvPlayList": [
      {
        "id": "25",
        "tvId": "15",
        "longVideoId": "23rfewc23",
        "title": "test video",
        "description": "test33", 
        "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
         "total": 7,
        "creationTime": "2019-01-09 22:11:29.0", 
        "firstFrameUrl": "", 
        "cateId": 12,
        "cateName": "12",
        "tags": "Test",
        "isRelease": "true",
        "isHomePage":"false",
        "isRecommend": "true"
      }
    ]
  }
}

getHomePageTvPlayList

You can call this operation to query TV plays that are displayed on the homepage.

Method	GET
URL	/longVideo/getHomePageTvPlayList
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	pageIndex	Integer	Yes	The start page number. It starts from 1.
	pageSize	Integer	Yes	The number of entries to return on each page.

Response parameters
	Parameter	Type	Description
	tagTvPlayList	tvPlayObjet	The list of TV plays under each tag.

The following table lists parameters in tvPlayObjet.

Parameter	Type	Description
total	String	The total number of videos.
tvPlayList	List<tvPlay>	The list of TV play information.
tag	String	The name of the tag.

The following table lists parameters in tvPlay.

Parameter	Type	Description
id	String	The ID.
tvId	String	The ID of the TV play.
title	String	The title of the TV play.
description	String	The description of the TV play.
coverUrl	String	The URL of the TV play thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
tags	String	The tags of the TV play. Separate multiple tags with commas (,).
cateId	String	The ID of the category to which the TV play belongs.
cateName	String	The name of the category to which the TV play belongs.
total	String	The total number of episodes in the TV play.
creationTime	String	The time when the TV play was created.
isRecommend	String	Indicates whether the TV play is recommended. Valid values: true and false.
isRelease	String	Indicates whether the TV play is published. Valid values: true and false.
isHomePage	String	Indicates whether the TV play is displayed on the homepage. Valid values: true and false.

Sample response:

{
    "result": "true",
    "requestId": "684a9cd4-b04b-4f83-974a-59e8f158cc33",
    "message": "",
    "code": "200",
    "data": {
    "tagTvPlayList": [
            {
                "tvPlayList": [ 
                    {
                        "id": "29",
                        "tvId": "892838",
                        "tvName": "Journey to the West",
                        "title": "Journey to the West",
                        "description": "Journey to the West",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/image/cover/B5A336835256457690F5F0B32D725538-6-2.png",
                        "creationTime": "2019-07-18 19:43:00.0",
                        "firstFrameUrl": "",
                        "size": 0,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "Four Great Classic Novels",
                        "isRecommend": "false",
                        "isHomePage": "true",
                        "isRelease": "true",
                        "total": "7"
                    }
                ],
                "total": 1,
                "tag": "Four Great Classic Novels"
            },
            {
                "tvPlayList": [
                    {
                        "id": "43",
                        "tvId": "169568",
                        "tvName": "H265-HLS encryption-five-channel streaming encryption",
                        "title": "H265-HLS encryption-five-channel streaming encryption",
                        "description": "",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/image/cover/36A87FC2EC7D47B49DB75CE72D86F5DA-6-2.png",
                        "creationTime": "2019-07-24 16:50:39.0",
                        "firstFrameUrl": "",
                        "size": 0,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "Song,Programming Technique",
                        "isRecommend": "false",
                        "isHomePage": "true",
                        "isRelease": "true",
                        "total": "5"
                    },
                    {
                        "id": "38",
                        "tvId": "579028",
                        "tvName": "Chinese Society",
                        "title": "Chinese Society",
                        "description": "Chinese Society",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/image/cover/5A6C5CA1D2B149098B56FF2B521D3271-6-2.png",
                        "creationTime": "2019-07-18 22:44:37.0",
                        "firstFrameUrl": "",
                        "size": 0,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "Song",
                        "isRecommend": "false",
                        "isHomePage": "true",
                        "isRelease": "true",
                        "total": "10"
                    }
                ],
                "total": 2,
                "tag": "Song"
            } 
        ]
    ...
    }
}

getRecommendLongVideosList

You can call this operation to query recommended long videos.

Method	GET
URL	/longVideo/getRecommendLongVideosList
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	pageIndex	Integer	No	The start page number. It starts from 1.
	pageSize	Integer	No	The number of entries to return on each page.

Response parameters
	Parameter	Type	Description
	total	String	The total number of videos.
	videoList	List<LongVideo>	The list of recommended long video information.

The following table lists parameters in LongVideo.

Parameter	Type	Description
title	String	The title of the video.
videoId	String	The ID of the video.
description	String	The description of the video.
duration	String	The length of the video. Unit: seconds.
coverUrl	String	The URL of the video thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
size	String	The size of the video mezzanine file. Unit: bytes.
tags	String	The tags of the video. Separate multiple tags with commas (,).
tvId	String	The ID of the TV play.
tvName	String	The name of the TV play.
dotList	List<dot>	The marker list of the video.
sort	String	The sequence number of the video.
creationTime	String	The time when the video was created.
transcodeStatus	String	The transcoding status of the video.
snapshotStatus	String	The snapshot status of the video.
censorStatus	String	The audit status of the video.
isVip	String	Indicates whether the video is exclusive for VIP users. Valid values: true and false.
isRecommend	String	Indicates whether the video is recommended. Valid values: true and false.
isHomePage	String	Indicates whether the video is displayed on the homepage. Valid values: true and false.

The following table lists parameters in dot.

Parameter	Type	Description
id	String	The ID.
videoId	String	The ID of the video.
time	String	The time when the marker was set. Unit: seconds.
content	String	The description of the marker.

Sample response:

{
  "result": "true",
  "requestId": "afga23534t-geggtw4-hw4htnytj-45yhsrth",
  "message": "",
  "code": "200",
  "data": {
      "total": 3,
        "videoList": [
            {
                "id": "726",
                "tvId": "597967",
                "tvName": "Mantis Shrimp",
                "title": "Mantis Shrimp Episode 96. LongVideo V1.0. ApsaraVideo VOD solution",
                "description": "",
                "coverUrl": "http://alivc-demo-vod.aliyuncs.com/29987454cedb4bd59807cff68d70bc9c/snapshots/normal/528D74D8-16C213FAF12-1103-1445-334-2638600001.jpg",
                "creationTime": "2019-07-24 07:51:57.0",
                "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/29987454cedb4bd59807cff68d70bc9c/snapshots/normal/528D74D8-16C213FAF12-1103-1445-334-2638600001.jpg",
                "size": 1485375,
                "cateId": 0,
                "cateName": "",
                "tags": "Mantis Shrimp",
                "isRecommend": "true",
                "isHomePage": "false",
                "videoId": "29987454cedb4bd59807cff68d70bc9c",
                "duration": 12,
                "transcodeStatus": "success",
                "snapshotStatus": "success",
                "censorStatus": "success",
                "snapshotList": null,
                "dotList": [
                    {
                        "id": "1593",
                        "videoId": "29987454cedb4bd59807cff68d70bc9c",
                        "time": "5",
                        "content": "Set a marker every 10 seconds. ApsaraVideo VOD is an all-in-one audio- and video-on-demand solution. It integrates audio and video upload, automatic transcoding, media resource management, and Content Delivery Network (CDN) for accelerated content delivery."
                    }
                ],
                "sort": "93",
                "isVip": "false"
            }
            ...
        ]
  }
}

getLongVideosList

You can call this operation to query long videos in each category on the homepage.

Method	GET
URL	/longVideo/getLongVideosList
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	pageIndex	Integer	Yes	The start page number. It starts from 1.
	pageSize	Integer	Yes	The number of entries to return on each page.

Response parameters
	Parameter	Type	Description
	tagVideoList	videoObject	The list of long videos under each tag.

The following table lists parameters in videoObject.

Parameter	Type	Description
total	String	The total number of videos.
tag	String	The tags of the video.
videoList	List<LongVideo>	The list of long video information.

The following table lists parameters in LongVideo.

Parameter	Type	Description
title	String	The title of the video.
videoId	String	The ID of the video.
description	String	The description of the video.
duration	String	The length of the video. Unit: seconds.
coverUrl	String	The URL of the video thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
size	String	The size of the video mezzanine file. Unit: bytes.
tags	String	The tags of the video. Separate multiple tags with commas (,).
tvId	String	The ID of the TV play.
tvName	String	The name of the TV play.
sort	String	The sequence number of the video.
creationTime	String	The time when the video was created.
transcodeStatus	String	The transcoding status of the video.
snapshotStatus	String	The snapshot status of the video.
dotList	List<dot>	The marker list of the video.
censorStatus	String	The audit status of the video.
isRecommend	String	Indicates whether the video is recommended. Valid values: true and false.
isHomePage	String	Indicates whether the video is displayed on the homepage. Valid values: true and false.
isVip	String	Indicates whether the video is exclusive for VIP users. Valid values: true and false.

The following table lists parameters in dot.

Parameter	Type	Description
id	String	The ID.
videoId	String	The ID of the video.
time	String	The time when the marker was set. Unit: seconds.
content	String	The description of the marker.

Sample response:

{
    "result": "true",
    "requestId": "5ddec56a-62ce-4b7d-b4c2-0327bbc99d82",
    "message": "",
    "code": "200",
    "data": {
        "tagVideoList": [
            {
                "total": 4,
                "videoList": [ 
                    {
                        "id": "794",
                        "tvId": "",
                        "tvName": "",
                        "title": "LongVideo V1.0. ApsaraVideo VOD solution",
                        "description": "",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/b0af542b2e1f4641b422e45853ce826f/snapshots/normal/137F9189-16C261B9287-1103-1445-334-2638600001.jpg",
                        "creationTime": "2019-07-25 06:30:36.0",
                        "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/b0af542b2e1f4641b422e45853ce826f/snapshots/normal/137F9189-16C261B9287-1103-1445-334-2638600001.jpg",
                        "size": 34715663,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "Water Margin",
                        "isRecommend": "false",
                        "isHomePage": "true",
                        "videoId": "b0af542b2e1f4641b422e45853ce826f",
                        "duration": 300.0,
                        "transcodeStatus": "success",
                        "snapshotStatus": "success",
                        "censorStatus": "success",
                        "snapshotList": null,
                        "dotList": [

                                "id":"1431",
                                "videoId":"a7152b0b6c104b17a02a91d38d4c1b8e",
                                "time":"5",
                                "content":"My xxxxxxxx"
                            }],
                        "sort": null,
                        "isVip": "false"
                    } ,
                    {
                        "id": "518",
                        "tvId": " ",
                        "tvName": " ",
                        "title": "Alibaba Cloud demo-Alibaba Cloud Speeds up IoT Strategy at Airship-powered Computing Conference",
                        "description": "",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/ecb4b107b6e14f38a51467631fbcefdc/snapshots/normal/54F88C22-16C081BB2C8-1103-1445-334-2638600001.jpg",
                        "creationTime": "2019-07-19 10:42:08.0",
                        "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/ecb4b107b6e14f38a51467631fbcefdc/snapshots/normal/54F88C22-16C081BB2C8-1103-1445-334-2638600001.jpg",
                        "size": 1779576,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "Water Margin 1",
                        "isRecommend": "true",
                        "isHomePage": "true",
                        "videoId": "f898cb669e5448ae88067c69aaab34ee",
                        "duration": 21.0,
                        "transcodeStatus": "success",
                        "snapshotStatus": "success",
                        "censorStatus": "success",
                        "snapshotList": null,
                        "dotList": [],
                        "sort": null,
                        "isVip": "false"
                    }
                ],
                "tag": "Water Margin",
            }, 
            {
                "total": 1,
                "videoList": [
                    {
                        "id": "619",
                        "tvId": "579028",
                        "tvName": "Chinese Society",
                        "title": "How to improve performance with sports data",
                        "description": "",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/b6874f5ef3884f14ac26b3a32deb003c/snapshots/normal/F9B4E20-16C0F18C987-1103-1445-334-2638600001.jpg",
                        "creationTime": "2019-07-20 19:16:18.0",
                        "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/b6874f5ef3884f14ac26b3a32deb003c/snapshots/normal/F9B4E20-16C0F18C987-1103-1445-334-2638600001.jpg",
                        "size": 3654338,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "Follow,TikTok hot videos",
                        "isRecommend": "false",
                        "isHomePage": "true",
                        "videoId": "c5a588e77bb24267921101189861ea30",
                        "duration": 18.0,
                        "transcodeStatus": "success",
                        "snapshotStatus": "success",
                        "censorStatus": "success",
                        "snapshotList": null,
                        "dotList": [],
                        "sort": "9",
                        "isVip": "false"
                    }
                ],
                "tag": "Follow"
            }
        ]

    }
}

getVipLongVideosList

You can call this operation to query videos exclusive for VIP users.

Method	GET
URL	/longVideo/getVipLongVideosList
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	pageIndex	Integer	No	The start page number. It starts from 1.
	pageSize	Integer	No	The number of entries to return on each page.

Response parameters
	Parameter	Type	Description
	tagVideoList	videoObject	The list of long videos under each tag.

The following table lists parameters in videoObject.

Parameter	Type	Description
total	String	The total number of videos.
tag	String	The tags of the video.
videoList	List<LongVideo>	The list of long video information.

The following table lists parameters in LongVideo.

Parameter	Type	Description
title	String	The title of the video.
videoId	String	The ID of the video.
description	String	The description of the video.
duration	String	The length of the video. Unit: seconds.
coverUrl	String	The URL of the video thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
size	String	The size of the video mezzanine file. Unit: bytes.
tags	String	The tags of the video. Separate multiple tags with commas (,).
tvId	String	The ID of the TV play.
tvName	String	The name of the TV play.
sort	String	The sequence number of the video.
creationTime	String	The time when the video was created.
transcodeStatus	String	The transcoding status of the video.
snapshotStatus	String	The snapshot status of the video.
dotList	List<dot>	The marker list of the video.
censorStatus	String	The audit status of the video.
isRecommend	String	Indicates whether the video is recommended. Valid values: true and false.
isHomePage	String	Indicates whether the video is displayed on the homepage. Valid values: true and false.
isVip	String	Indicates whether the video is exclusive for VIP users. Valid values: true and false.

The following table lists parameters in dot.

Parameter	Type	Description
id	String	The ID.
videoId	String	The ID of the video.
time	String	The time when the marker was set. Unit: seconds.
content	String	The description of the marker.

Sample response:

{
    "result": "true",
    "requestId": "debfb2e8-6bac-4d03-8048-6495787e7fa5",
    "message": "",
    "code": "200",
    "data": {
     "tagVideoList": [
            {
                "total": 3,
                "videoList": [
                    {
                        "id": "525",
                        "tvId": "",
                        "tvName": "",
                        "title": "Alibaba Cloud demo-Scrolling text-v8",
                        "description": "",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/8e32181534a748c282d5e29b3bbb5f35/snapshots/normal/3BE4BBCB-16C097BB310-1103-1445-334-2638600001.jpg",
                        "creationTime": "2019-07-19 17:06:37.0",
                        "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/8e32181534a748c282d5e29b3bbb5f35/snapshots/normal/3BE4BBCB-16C097BB310-1103-1445-334-2638600001.jpg",
                        "size": 25392218,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "VIP,Traffic",
                        "isRecommend": "false",
                        "isHomePage": "false",
                        "videoId": "8e32181534a748c282d5e29b3bbb5f35",
                        "duration": 600,
                        "transcodeStatus": "success",
                        "snapshotStatus": "success",
                        "censorStatus": "success",
                        "snapshotList": null,
                        "dotList": [
                            {
                                "id": "1416",
                                "videoId": "8e32181534a748c282d5e29b3bbb5f35",
                                "time": "10",
                                "content": "a10"
                            } 
                        ],
                        "sort": null,
                        "isVip": "true"
                    },
                    {
                        "id": "517",
                        "tvId": "892838",
                        "tvName": "Journey to the West",
                        "title": "test002",
                        "description": "",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/3ceaf061f0a44edab0bfb155c0494350/snapshots/normal/59024859-16C081B6027-1103-1445-334-2638600001.jpg",
                        "creationTime": "2019-07-19 10:41:47.0",
                        "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/3ceaf061f0a44edab0bfb155c0494350/snapshots/normal/59024859-16C081B6027-1103-1445-334-2638600001.jpg",
                        "size": 1346429,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "VIP",
                        "isRecommend": "false",
                        "isHomePage": "false",
                        "videoId": "3ceaf061f0a44edab0bfb155c0494350",
                        "duration": 14,
                        "transcodeStatus": "success",
                        "snapshotStatus": "success",
                        "censorStatus": "success",
                        "snapshotList": null,
                        "dotList": [],
                        "sort": "4",
                        "isVip": "true"
                    },
                    {
                        "id": "516",
                        "tvId": "892838",
                        "tvName": "Journey to the West",
                        "title": "test111",
                        "description": "",
                        "coverUrl": "http://alivc-demo-vod.aliyuncs.com/28b7c55cfcba443880ad99eae78f4571/snapshots/normal/4F41D7FD-16C081AC461-1103-1445-334-2638600001.jpg",
                        "creationTime": "2019-07-19 10:41:07.0",
                        "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/28b7c55cfcba443880ad99eae78f4571/snapshots/normal/4F41D7FD-16C081AC461-1103-1445-334-2638600001.jpg",
                        "size": 3061916,
                        "cateId": 0,
                        "cateName": "",
                        "tags": "VIP",
                        "isRecommend": "false",
                        "isHomePage": "false",
                        "videoId": "28b7c55cfcba443880ad99eae78f4571",
                        "duration": 16,
                        "transcodeStatus": "success",
                        "snapshotStatus": "success",
                        "censorStatus": "success",
                        "snapshotList": null,
                        "dotList": [
                            {
                                "id": "1202",
                                "videoId": "28b7c55cfcba443880ad99eae78f4571",
                                "time": "12",
                                "content": "3334545454"
                            }
                        ],
                        "sort": "3",
                        "isVip": "true"
                    }
                ],
                "tag": "VIP"
            } 
        ]
    }
}

getLongVideoById

You can call this operation to query long videos based on the TV play ID.

Method	GET
URL	/longVideo/getLongVideoById
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	tvId	String	Yes	The ID of the TV play.
Response parameters
	Parameter	Type		Description
	total	String		The total number of videos.
	videoList	List<LongVideo>		The list of long video information.

The following table lists parameters in LongVideo.

Parameter	Type	Description
title	String	The title of the video.
videoId	String	The ID of the video.
description	String	The description of the video.
duration	String	The length of the video. Unit: seconds.
coverUrl	String	The URL of the video thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
size	String	The size of the video mezzanine file. Unit: bytes.
tags	String	The tags of the video. Separate multiple tags with commas (,).
tvId	String	The ID of the TV play.
tvName	String	The name of the TV play.
dotList	List<dot>	The marker list of the video.
sort	String	The sequence number of the video.
creationTime	String	The time when the video was created.
transcodeStatus	String	The transcoding status of the video.
snapshotStatus	String	The snapshot status of the video.
censorStatus	String	The audit status of the video.
isRecommend	String	Indicates whether the video is recommended. Valid values: true and false.
isHomePage	String	Indicates whether the video is displayed on the homepage. Valid values: true and false.
isVip	String	Indicates whether the video is exclusive for VIP users. Valid values: true and false.

The following table lists parameters in dot.

Parameter	Type	Description
id	String	The ID.
videoId	String	The ID of the video.
time	String	The time when the marker was set. Unit: seconds.
content	String	The description of the marker.

Sample response:

{
  "result": "true",
  "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  "message": "",
  "code": "200",
  "data": {
    "total": 7,
    "videoList": [
      {
        "id": "25",
        "videoId": "23rfewc23",
        "title": "test video",
        "description": "test33",
        "duration": 12,
        "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
        "creationTime": "2019-01-09 22:11:29.0",
        "status": "",
        "firstFrameUrl": "",
        "size": 56,
        "tvId": 12,
        "tvName": "12",
        "dotList": [],
        "sort": "Sequence number",
        "tags": "Test",
        "shareUrl": "",
        "transcodeStatus": "",
        "snapshotStatus": "",
        "censorStatus": "onCensor",
        "isRecommend":"false",
        "isHomePage":"false",
        "isVip":"false"
      }
    ]
  }
}

randomUser

You can call this operation to create a random user.

Method	GET
URL	/longVideoUser/randomUser
Request parameters
Response parameters
	token	String	The token.
	userId	String	The ID of the user.
	nickName	String	The nickname of the user.
	avatar	String	The avatar of the user.
	gmtCreate	String	The time when the user was created.
	gmtModified	String	The time when the user information was modified.

Sample response:

{
    "result": "true",
    "requestId": "12b9032c-3404-4a5a-bb74-83022046ad0b",
    "message": "",
    "code": "200",
    "data": {
        "id": "5",
        "userId": "865997",
        "nickName": "Gloria",
        "avatarUrl": "http://example.aliyundoc.com/heads/05.png",
        "gmtCreate": "2019-06-24 17:53:28.0",
        "gmtModified": "",
        "token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI4NjU5OTciLCJpYXQiOjE1NjEzNzAwMDgsInN1YiI6IntcInVzZUlkXCI6XCI4NjU5OTdcIn0ifQ.cklcJwOvYUxOnqEBjnr2eplh2SeZquDuc4vwCQp3kPs"
    }
}

getSimilarTvPlayList

You can call this operation to query TV plays similar to a specified TV play.

Method	GET
URL	/longVideo/getSimilarTvPlayList
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	tvId	String	Yes	The ID of the TV play.

Response parameters
	Parameter	Type	Description
	total	String	The total number of videos.
	tvPlayList	List<tvPlay>	The list of TV play information.

The following table lists parameters in tvPlay.

Parameter	Type	Description
id	String	The ID.
tvId	String	The ID of the TV play.
title	String	The title of the TV play.
description	String	The description of the TV play.
coverUrl	String	The URL of the TV play thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
tags	String	The tags of the TV play. Separate multiple tags with commas (,).
cateId	String	The ID of the category to which the TV play belongs.
cateName	String	The name of the category to which the TV play belongs.
total	String	The total number of episodes in the TV play.
creationTime	String	The time when the TV play was created.
isRecommend	String	Indicates whether the TV play is recommended. Valid values: true and false.
isRelease	String	Indicates whether the TV play is published. Valid values: true and false.
isHomePage	String	Indicates whether the TV play is displayed on the homepage. Valid values: true and false.

Sample response:

{
  "result": "true",
  "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  "message": "",
  "code": "200",
  "data": {
    "total": 7,
    "tvPlayList": [
      {
        "id": "25",
         "tvId": "15", 
        "title": "test video",
        "description": "test33", 
        "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
         "total": 7,
        "creationTime": "2019-01-09 22:11:29.0", 
        "firstFrameUrl": "", 
        "cateId": 12,
        "cateName": "12",
        "tags": "Test",
        "isRelease": "true",
        "isHomePage":"true",
        "isRecommend": "false" 
      }
    ]
  }
}

getSimilarLongVideosList

You can call this operation to query long videos similar to a specified video.

Method	GET
URL	/longVideo/getSimilarLongVideosList
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	videoId	String	Yes	The ID of the video.

Response parameters
	Parameter	Type	Description
	total	String	The total number of videos.
	videoList	List<LongVideo>	The list of recommended long video information.

The following table lists parameters in LongVideo.

Parameter	Type	Description
title	String	The title of the video.
videoId	String	The ID of the video.
description	String	The description of the video.
duration	String	The length of the video. Unit: seconds.
coverUrl	String	The URL of the video thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
size	String	The size of the video mezzanine file. Unit: bytes.
tags	String	The tags of the video. Separate multiple tags with commas (,).
tvId	String	The ID of the TV play.
tvName	String	The name of the TV play.
dotList	List<dot>	The marker list of the video.
sort	String	The sequence number of the video.
creationTime	String	The time when the video was created.
transcodeStatus	String	The transcoding status of the video.
snapshotStatus	String	The snapshot status of the video.
censorStatus	String	The audit status of the video.
isVip	String	Indicates whether the video is exclusive for VIP users. Valid values: true and false.
isRecommend	String	Indicates whether the video is recommended. Valid values: true and false.
isHomePage	String	Indicates whether the video is displayed on the homepage. Valid values: true and false.

Sample response:

{
  "result": "true",
  "requestId": "afga23534t-geggtw4-hw4htnytj-45yhsrth",
  "message": "",
  "code": "200",
  "data": {
    "total": 7,
    "longVideoList": [
      {
        "id": "25",
        "videoId": "23rfewc23",
        "title": "test video",
        "description": "test33",
        "duration": 12,
        "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
        "creationTime": "2019-01-09 22:11:29.0",
        "status": "",
        "firstFrameUrl": "",
        "size": 56,
        "tvId": 12,
        "tvName": "12",
        "dotList": [],
        "tags": "Test",
        "shareUrl": "",
        "transcodeStatus": "",
        "snapshotStatus": "",
        "censorStatus": "onCensor",
        "sort": "1",
        "isRecommend":"true",
        "isHomePage":"false",
        "isVip":"false"
      }
    ]
  }
}

getTagsListByType

You can call this operation to query tags based on the tag type.

Method	GET
URL	/longVideo/getTagsListByType
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	type	String	Yes	The tag type. Valid values: 1, 2, and 3. A value of 1 indicates long video, 2 indicates TV play, and 3 indicates VIP video.

Response parameters
	Parameter	Type	Description
	tagList	List<Tag>	The list of tag information.

The following table lists parameters in Tag.

Parameter	Type	Description
id	String	The ID.
tagId	String	The ID of the tag.
tagName	String	The name of the tag.
type	String	The type of the tag. Valid values: 1, 2, and 3. A value of 1 indicates long video, 2 indicates TV play, and 3 indicates VIP video.

Sample response:

{
    "result": "true",
    "requestId": "73ca7051-e517-485c-a5c4-2472c9a4c886",
    "message": "Tags have been queried.",
    "code": "200",
    "data": [
        {
            "id": "1",
            "tagId": "1324",
            "tagName": "Feature program",
            "type": "1"
        }
    ]
}

getVipLongVideosListbyTag

You can call this operation to query long videos exclusive for VIP users based on a specified tag.

Method	GET
URL	/longVideo/getVipLongVideosListbyTag
Request parameters
	Parameter	Type	Required?	Description
	token	String	Yes	The token.
	pageIndex	Integer	Yes	The start page number. It starts from 1.
	pageSize	Integer	Yes	The number of entries to return on each page.
	tag	String	Yes	The video tag.

Response parameters
	Parameter	Type	Description
	longVideoList	videoObject	The list of long videos exclusive for VIP users.

The following table lists parameters in videoObject.

Parameter	Type	Description
total	String	The total number of videos.
videoList	List<LongVideo>	The list of long videos exclusive for VIP users.

The following table lists parameters in LongVideo.

Parameter	Type	Description
title	String	The title of the video.
videoId	String	The ID of the video.
description	String	The description of the video.
duration	String	The length of the video. Unit: seconds.
coverUrl	String	The URL of the video thumbnail.
firstFrameUrl	String	The URL of the first frame snapshot.
size	String	The size of the video mezzanine file. Unit: bytes.
tags	String	The tags of the video. Separate multiple tags with commas (,).
tvId	String	The ID of the TV play.
tvName	String	The name of the TV play.
dotList	List<dot>	The marker list of the video.
sort	String	The sequence number of the video.
creationTime	String	The time when the video was created.
transcodeStatus	String	The transcoding status of the video.
snapshotStatus	String	The snapshot status of the video.
censorStatus	String	The audit status of the video.
isVip	String	Indicates whether the video is exclusive for VIP users. Valid values: true and false.
isRecommend	String	Indicates whether the video is recommended. Valid values: true and false.
isHomePage	String	Indicates whether the video is displayed on the homepage. Valid values: true and false.

The following table lists parameters in dot.

Parameter	Type	Description
id	String	The ID.
videoId	String	The ID of the video.
time	String	The time when the marker was set. Unit: seconds.
content	String	The description of the marker.

Sample response:

{
  "result": "true",
  "requestId": "afga23534t-geggtw4-hw4htnytj-45yhsrth",
  "message": "",
  "code": "200",
  "data": {
    "total": 7,
    "videoList": [
      {
        "id": "25",
        "videoId": "23rfewc23",
        "title": "test video",
        "description": "test33",
        "duration": 12,
        "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
        "creationTime": "2019-01-09 22:11:29.0",
        "status": "",
        "firstFrameUrl": "",
        "size": 56,
        "tvId": 12,
        "tvName": "12",
        "dotList": [],
        "tags": "Test",
        "shareUrl": "",
        "transcodeStatus": "",
        "snapshotStatus": "",
        "censorStatus": "onCensor",
        "sort": "1",
        "isRecommend":"true",
        "isHomePage":"false",
        "isVip":"false"
      }
    ]
  }
}

Tool kit

getToolKit

You can call this operation to query the download link of a tool kit.

Method	POST
URL	/tool/getToolKit
Request parameters
	Parameter	Type	Required?	Description
	toolKitName	String	Yes	The name of the tool kit.
	type	String	Yes	The type of the tool kit. Valid values: 1 and 2. A value of 1 indicates that the tool kit is dedicated for Android, and 2 indicates that the tool kit is dedicated for iOS.
Response parameters
	id	String	Yes	The ID of the tool kit.
	toolKitName	String	Yes	The name of the tool kit.
	URL	String	Yes	The download link of the tool kit.
	type	String	Yes	The type of the tool kit. Valid values: 1 and 2. A value of 1 indicates that the tool kit is dedicated for Android, and 2 indicates that the tool kit is dedicated for iOS.

Sample response:

{
    "result": "true",
    "requestId": "d5cec15b-7216-4fe7-a400-07d561831f7a",
    "message": "The tool kit information has been queried.",
    "code": "200",
    "data": {
        "id": "3",
        "toolKitName": "shortVideoBase",
        "url": "https://alivc-demo-cms.alicdn.com/versionProduct/installPackage/shortVideo/base/shortVideoBase_update_iOS.plist",
        "type": "2"
    }
}