All Products
Search
Document Center

LongVideo mobile client operations

Last Updated: Oct 15, 2019

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:

  1. {
  2. "result": "true",
  3. "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "total": 1,
  8. "tvPlayList": [
  9. {
  10. "id": "25",
  11. "tvId": "15",
  12. "longVideoId": "23rfewc23",
  13. "title": "test video",
  14. "description": "test33",
  15. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  16. "total": 7,
  17. "creationTime": "2019-01-09 22:11:29.0",
  18. "firstFrameUrl": "",
  19. "cateId": 12,
  20. "cateName": "12",
  21. "tags": "Test",
  22. "isRelease": "true",
  23. "isHomePage":"false",
  24. "isRecommend": "true"
  25. }
  26. ]
  27. }
  28. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "684a9cd4-b04b-4f83-974a-59e8f158cc33",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "tagTvPlayList": [
  8. {
  9. "tvPlayList": [
  10. {
  11. "id": "29",
  12. "tvId": "892838",
  13. "tvName": "Journey to the West",
  14. "title": "Journey to the West",
  15. "description": "Journey to the West",
  16. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/image/cover/B5A336835256457690F5F0B32D725538-6-2.png",
  17. "creationTime": "2019-07-18 19:43:00.0",
  18. "firstFrameUrl": "",
  19. "size": 0,
  20. "cateId": 0,
  21. "cateName": "",
  22. "tags": "Four Great Classic Novels",
  23. "isRecommend": "false",
  24. "isHomePage": "true",
  25. "isRelease": "true",
  26. "total": "7"
  27. }
  28. ],
  29. "total": 1,
  30. "tag": "Four Great Classic Novels"
  31. },
  32. {
  33. "tvPlayList": [
  34. {
  35. "id": "43",
  36. "tvId": "169568",
  37. "tvName": "H265-HLS encryption-five-channel streaming encryption",
  38. "title": "H265-HLS encryption-five-channel streaming encryption",
  39. "description": "",
  40. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/image/cover/36A87FC2EC7D47B49DB75CE72D86F5DA-6-2.png",
  41. "creationTime": "2019-07-24 16:50:39.0",
  42. "firstFrameUrl": "",
  43. "size": 0,
  44. "cateId": 0,
  45. "cateName": "",
  46. "tags": "Song,Programming Technique",
  47. "isRecommend": "false",
  48. "isHomePage": "true",
  49. "isRelease": "true",
  50. "total": "5"
  51. },
  52. {
  53. "id": "38",
  54. "tvId": "579028",
  55. "tvName": "Chinese Society",
  56. "title": "Chinese Society",
  57. "description": "Chinese Society",
  58. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/image/cover/5A6C5CA1D2B149098B56FF2B521D3271-6-2.png",
  59. "creationTime": "2019-07-18 22:44:37.0",
  60. "firstFrameUrl": "",
  61. "size": 0,
  62. "cateId": 0,
  63. "cateName": "",
  64. "tags": "Song",
  65. "isRecommend": "false",
  66. "isHomePage": "true",
  67. "isRelease": "true",
  68. "total": "10"
  69. }
  70. ],
  71. "total": 2,
  72. "tag": "Song"
  73. }
  74. ]
  75. ...
  76. }
  77. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "afga23534t-geggtw4-hw4htnytj-45yhsrth",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "total": 3,
  8. "videoList": [
  9. {
  10. "id": "726",
  11. "tvId": "597967",
  12. "tvName": "Mantis Shrimp",
  13. "title": "Mantis Shrimp Episode 96. LongVideo V1.0. ApsaraVideo for VOD solution",
  14. "description": "",
  15. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/29987454cedb4bd59807cff68d70bc9c/snapshots/normal/528D74D8-16C213FAF12-1103-1445-334-2638600001.jpg",
  16. "creationTime": "2019-07-24 07:51:57.0",
  17. "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/29987454cedb4bd59807cff68d70bc9c/snapshots/normal/528D74D8-16C213FAF12-1103-1445-334-2638600001.jpg",
  18. "size": 1485375,
  19. "cateId": 0,
  20. "cateName": "",
  21. "tags": "Mantis Shrimp",
  22. "isRecommend": "true",
  23. "isHomePage": "false",
  24. "videoId": "29987454cedb4bd59807cff68d70bc9c",
  25. "duration": 12,
  26. "transcodeStatus": "success",
  27. "snapshotStatus": "success",
  28. "censorStatus": "success",
  29. "snapshotList": null,
  30. "dotList": [
  31. {
  32. "id": "1593",
  33. "videoId": "29987454cedb4bd59807cff68d70bc9c",
  34. "time": "5",
  35. "content": "Set a marker every 10 seconds. ApsaraVideo for 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."
  36. }
  37. ],
  38. "sort": "93",
  39. "isVip": "false"
  40. }
  41. ...
  42. ]
  43. }
  44. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "5ddec56a-62ce-4b7d-b4c2-0327bbc99d82",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "tagVideoList": [
  8. {
  9. "total": 4,
  10. "videoList": [
  11. {
  12. "id": "794",
  13. "tvId": "",
  14. "tvName": "",
  15. "title": "LongVideo V1.0. ApsaraVideo for VOD solution",
  16. "description": "",
  17. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/b0af542b2e1f4641b422e45853ce826f/snapshots/normal/137F9189-16C261B9287-1103-1445-334-2638600001.jpg",
  18. "creationTime": "2019-07-25 06:30:36.0",
  19. "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/b0af542b2e1f4641b422e45853ce826f/snapshots/normal/137F9189-16C261B9287-1103-1445-334-2638600001.jpg",
  20. "size": 34715663,
  21. "cateId": 0,
  22. "cateName": "",
  23. "tags": "Water Margin",
  24. "isRecommend": "false",
  25. "isHomePage": "true",
  26. "videoId": "b0af542b2e1f4641b422e45853ce826f",
  27. "duration": 300.0,
  28. "transcodeStatus": "success",
  29. "snapshotStatus": "success",
  30. "censorStatus": "success",
  31. "snapshotList": null,
  32. "dotList": [
  33. "id":"1431",
  34. "videoId":"a7152b0b6c104b17a02a91d38d4c1b8e",
  35. "time":"5",
  36. "content":"My xxxxxxxx"
  37. }],
  38. "sort": null,
  39. "isVip": "false"
  40. } ,
  41. {
  42. "id": "518",
  43. "tvId": " ",
  44. "tvName": " ",
  45. "title": "Alibaba Cloud demo-Alibaba Cloud Speeds up IoT Strategy at Airship-powered Computing Conference",
  46. "description": "",
  47. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/ecb4b107b6e14f38a51467631fbcefdc/snapshots/normal/54F88C22-16C081BB2C8-1103-1445-334-2638600001.jpg",
  48. "creationTime": "2019-07-19 10:42:08.0",
  49. "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/ecb4b107b6e14f38a51467631fbcefdc/snapshots/normal/54F88C22-16C081BB2C8-1103-1445-334-2638600001.jpg",
  50. "size": 1779576,
  51. "cateId": 0,
  52. "cateName": "",
  53. "tags": "Water Margin 1",
  54. "isRecommend": "true",
  55. "isHomePage": "true",
  56. "videoId": "f898cb669e5448ae88067c69aaab34ee",
  57. "duration": 21.0,
  58. "transcodeStatus": "success",
  59. "snapshotStatus": "success",
  60. "censorStatus": "success",
  61. "snapshotList": null,
  62. "dotList": [],
  63. "sort": null,
  64. "isVip": "false"
  65. }
  66. ],
  67. "tag": "Water Margin",
  68. },
  69. {
  70. "total": 1,
  71. "videoList": [
  72. {
  73. "id": "619",
  74. "tvId": "579028",
  75. "tvName": "Chinese Society",
  76. "title": "How to improve performance with sports data",
  77. "description": "",
  78. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/b6874f5ef3884f14ac26b3a32deb003c/snapshots/normal/F9B4E20-16C0F18C987-1103-1445-334-2638600001.jpg",
  79. "creationTime": "2019-07-20 19:16:18.0",
  80. "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/b6874f5ef3884f14ac26b3a32deb003c/snapshots/normal/F9B4E20-16C0F18C987-1103-1445-334-2638600001.jpg",
  81. "size": 3654338,
  82. "cateId": 0,
  83. "cateName": "",
  84. "tags": "Follow,TikTok hot videos",
  85. "isRecommend": "false",
  86. "isHomePage": "true",
  87. "videoId": "c5a588e77bb24267921101189861ea30",
  88. "duration": 18.0,
  89. "transcodeStatus": "success",
  90. "snapshotStatus": "success",
  91. "censorStatus": "success",
  92. "snapshotList": null,
  93. "dotList": [],
  94. "sort": "9",
  95. "isVip": "false"
  96. }
  97. ],
  98. "tag": "Follow"
  99. }
  100. ]
  101. }
  102. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "debfb2e8-6bac-4d03-8048-6495787e7fa5",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "tagVideoList": [
  8. {
  9. "total": 3,
  10. "videoList": [
  11. {
  12. "id": "525",
  13. "tvId": "",
  14. "tvName": "",
  15. "title": "Alibaba Cloud demo-Scrolling text-v8",
  16. "description": "",
  17. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/8e32181534a748c282d5e29b3bbb5f35/snapshots/normal/3BE4BBCB-16C097BB310-1103-1445-334-2638600001.jpg",
  18. "creationTime": "2019-07-19 17:06:37.0",
  19. "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/8e32181534a748c282d5e29b3bbb5f35/snapshots/normal/3BE4BBCB-16C097BB310-1103-1445-334-2638600001.jpg",
  20. "size": 25392218,
  21. "cateId": 0,
  22. "cateName": "",
  23. "tags": "VIP,Traffic",
  24. "isRecommend": "false",
  25. "isHomePage": "false",
  26. "videoId": "8e32181534a748c282d5e29b3bbb5f35",
  27. "duration": 600,
  28. "transcodeStatus": "success",
  29. "snapshotStatus": "success",
  30. "censorStatus": "success",
  31. "snapshotList": null,
  32. "dotList": [
  33. {
  34. "id": "1416",
  35. "videoId": "8e32181534a748c282d5e29b3bbb5f35",
  36. "time": "10",
  37. "content": "a10"
  38. }
  39. ],
  40. "sort": null,
  41. "isVip": "true"
  42. },
  43. {
  44. "id": "517",
  45. "tvId": "892838",
  46. "tvName": "Journey to the West",
  47. "title": "test002",
  48. "description": "",
  49. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/3ceaf061f0a44edab0bfb155c0494350/snapshots/normal/59024859-16C081B6027-1103-1445-334-2638600001.jpg",
  50. "creationTime": "2019-07-19 10:41:47.0",
  51. "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/3ceaf061f0a44edab0bfb155c0494350/snapshots/normal/59024859-16C081B6027-1103-1445-334-2638600001.jpg",
  52. "size": 1346429,
  53. "cateId": 0,
  54. "cateName": "",
  55. "tags": "VIP",
  56. "isRecommend": "false",
  57. "isHomePage": "false",
  58. "videoId": "3ceaf061f0a44edab0bfb155c0494350",
  59. "duration": 14,
  60. "transcodeStatus": "success",
  61. "snapshotStatus": "success",
  62. "censorStatus": "success",
  63. "snapshotList": null,
  64. "dotList": [],
  65. "sort": "4",
  66. "isVip": "true"
  67. },
  68. {
  69. "id": "516",
  70. "tvId": "892838",
  71. "tvName": "Journey to the West",
  72. "title": "test111",
  73. "description": "",
  74. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/28b7c55cfcba443880ad99eae78f4571/snapshots/normal/4F41D7FD-16C081AC461-1103-1445-334-2638600001.jpg",
  75. "creationTime": "2019-07-19 10:41:07.0",
  76. "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/28b7c55cfcba443880ad99eae78f4571/snapshots/normal/4F41D7FD-16C081AC461-1103-1445-334-2638600001.jpg",
  77. "size": 3061916,
  78. "cateId": 0,
  79. "cateName": "",
  80. "tags": "VIP",
  81. "isRecommend": "false",
  82. "isHomePage": "false",
  83. "videoId": "28b7c55cfcba443880ad99eae78f4571",
  84. "duration": 16,
  85. "transcodeStatus": "success",
  86. "snapshotStatus": "success",
  87. "censorStatus": "success",
  88. "snapshotList": null,
  89. "dotList": [
  90. {
  91. "id": "1202",
  92. "videoId": "28b7c55cfcba443880ad99eae78f4571",
  93. "time": "12",
  94. "content": "3334545454"
  95. }
  96. ],
  97. "sort": "3",
  98. "isVip": "true"
  99. }
  100. ],
  101. "tag": "VIP"
  102. }
  103. ]
  104. }
  105. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "total": 7,
  8. "videoList": [
  9. {
  10. "id": "25",
  11. "videoId": "23rfewc23",
  12. "title": "test video",
  13. "description": "test33",
  14. "duration": 12,
  15. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  16. "creationTime": "2019-01-09 22:11:29.0",
  17. "status": "",
  18. "firstFrameUrl": "",
  19. "size": 56,
  20. "tvId": 12,
  21. "tvName": "12",
  22. "dotList": [],
  23. "sort": "Sequence number",
  24. "tags": "Test",
  25. "shareUrl": "",
  26. "transcodeStatus": "",
  27. "snapshotStatus": "",
  28. "censorStatus": "onCensor",
  29. "isRecommend":"false",
  30. "isHomePage":"false",
  31. "isVip":"false"
  32. }
  33. ]
  34. }
  35. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "12b9032c-3404-4a5a-bb74-83022046ad0b",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "id": "5",
  8. "userId": "865997",
  9. "nickName": "Gloria",
  10. "avatarUrl": "http://live-appserver-sh.alivecdn.com/heads/05.png",
  11. "gmtCreate": "2019-06-24 17:53:28.0",
  12. "gmtModified": "",
  13. "token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI4NjU5OTciLCJpYXQiOjE1NjEzNzAwMDgsInN1YiI6IntcInVzZUlkXCI6XCI4NjU5OTdcIn0ifQ.cklcJwOvYUxOnqEBjnr2eplh2SeZquDuc4vwCQp3kPs"
  14. }
  15. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "total": 7,
  8. "tvPlayList": [
  9. {
  10. "id": "25",
  11. "tvId": "15",
  12. "title": "test video",
  13. "description": "test33",
  14. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  15. "total": 7,
  16. "creationTime": "2019-01-09 22:11:29.0",
  17. "firstFrameUrl": "",
  18. "cateId": 12,
  19. "cateName": "12",
  20. "tags": "Test",
  21. "isRelease": "true",
  22. "isHomePage":"true",
  23. "isRecommend": "false"
  24. }
  25. ]
  26. }
  27. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "afga23534t-geggtw4-hw4htnytj-45yhsrth",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "total": 7,
  8. "longVideoList": [
  9. {
  10. "id": "25",
  11. "videoId": "23rfewc23",
  12. "title": "test video",
  13. "description": "test33",
  14. "duration": 12,
  15. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  16. "creationTime": "2019-01-09 22:11:29.0",
  17. "status": "",
  18. "firstFrameUrl": "",
  19. "size": 56,
  20. "tvId": 12,
  21. "tvName": "12",
  22. "dotList": [],
  23. "tags": "Test",
  24. "shareUrl": "",
  25. "transcodeStatus": "",
  26. "snapshotStatus": "",
  27. "censorStatus": "onCensor",
  28. "sort": "1",
  29. "isRecommend":"true",
  30. "isHomePage":"false",
  31. "isVip":"false"
  32. }
  33. ]
  34. }
  35. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "73ca7051-e517-485c-a5c4-2472c9a4c886",
  4. "message": "Tags have been queried.",
  5. "code": "200",
  6. "data": [
  7. {
  8. "id": "1",
  9. "tagId": "1324",
  10. "tagName": "Feature program",
  11. "type": "1"
  12. }
  13. ]
  14. }

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:

  1. {
  2. "result": "true",
  3. "requestId": "afga23534t-geggtw4-hw4htnytj-45yhsrth",
  4. "message": "",
  5. "code": "200",
  6. "data": {
  7. "total": 7,
  8. "videoList": [
  9. {
  10. "id": "25",
  11. "videoId": "23rfewc23",
  12. "title": "test video",
  13. "description": "test33",
  14. "duration": 12,
  15. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  16. "creationTime": "2019-01-09 22:11:29.0",
  17. "status": "",
  18. "firstFrameUrl": "",
  19. "size": 56,
  20. "tvId": 12,
  21. "tvName": "12",
  22. "dotList": [],
  23. "tags": "Test",
  24. "shareUrl": "",
  25. "transcodeStatus": "",
  26. "snapshotStatus": "",
  27. "censorStatus": "onCensor",
  28. "sort": "1",
  29. "isRecommend":"true",
  30. "isHomePage":"false",
  31. "isVip":"false"
  32. }
  33. ]
  34. }
  35. }

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:

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