全部产品
云市场

长视频控制台接口说明

更新时间:2019-10-15 14:53:36

简介

本文档是长视频解决方案的控制台接口文档说明。

返回值结构说明

所有请求均返回此JSON格式的数据,所有API只描述[data]结构数据。

result bool 操作是否成功
requestId string 服务端生成的本次请求ID。
code string 服务端生成的本次请求code。
message string 服务端消息多用于描述错误原因。
data object 服务端返回的业务结构体数据,不同业务数据结构不同。

长视频控制台

longVideoUpload

本地上传长视频。

method post
url /console/longVideo/longVideoUpload
param
名称 类型 是否必需 描述
consoleToken string token
videoId string 视频id
title string 视频标题
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"3099ee2b-aa30-4c38-b28e-12dc1e1b5229",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

createTvPlay

新增电视剧。

method post
url /console/longVideo/createTvPlay
param
名称 类型 是否必需 描述
consoleToken string token
title string 电视剧标题
tvName string 电视剧名称
file MultipartFile 二进制文件流
description string 电视剧描述
tags string 电视剧标签.多个用逗号分隔。
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"36f336d6-e3c2-4031-8f13-3d6fc38f1a18",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

updateTvPlayInfo

控制台编辑电视剧信息。

method post
url /console/longVideo/updateTvPlayInfo
param
名称 类型 是否必需 描述
consoleToken string token
tvId string 电视剧id
title string 电视剧标题
tvName string 电视剧名称
file MultipartFile 二进制文件流
description string 电视剧描述
tags string 电视剧标签.多个用逗号分隔。
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"90c08fe0-1dc9-4fdf-8c68-4b3ae5a1d9d8",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

updateLongVideoInfo

编辑长视频基本信息 。

method post
url /console/longVideo/updateLongVideoInfo
param
名称 类型 是否必需 描述
consoleToken string token
videoId string 长视频id
title string 长视频标题
description string 长视频描述
tags string 长视频标签.多个用英文逗号分隔。
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"ba62239e-76cf-4a63-9823-907c0ee3c528",
  5. "message":"编辑长视频基本信息完成",
  6. "data":{}
  7. }
  8. }

getLongVideos

根据条件获取长视频列表

method get
url /console/longVideo/getLongVideos
param
名称 类型 是否必需 描述
consoleToken string token
pageIndex int 起始页 (从1开始)
pageSize int 每页条数
isRecommend string 是否为推荐视频(是:true,否:false)
isVip string 是否为vip视频(是:true,否:false)
isHomePage string 是否为首页视频(是:true,否:false)
videoId string 视频id
tags string 标签
tvId string 电视剧id
title string 标题
startTime string 开始时间
endTime string 结束时间
censorStatus string 审核状态
return param
名称 类型 描述
total string 长视频总条数
longVideoList List<LongVideo> 长视频信息列表

LongVideo

名称 类型 描述
title string 视频标题
videoId string 视频id
description string 视频描述
duration string 视频时长(秒)
coverUrl string 视频封面URL
firstFrameUrl string 首帧地址
size string 视频源文件大小(字节)。
tags string 视频标签.多个用逗号分隔。
tvId string 电视剧id。
tvName string 电视剧名称。
creationTime string 创建时间
snapshotList list 截图列表
dotList List<dot> 打点信息列表。
transcodeStatus string 转码状态。
snapshotStatus string 截图状态
censorStatus string 审核状态
sort string 序号
isRecommend string 是否推荐(是:true,否:false)
isHomePage string 是否首页(是:true,否:false)
isVip string 是否vip(是:true,否:false)

dot

名称 类型 描述
id string id
videoId string 视频id
time string 时间点(单位:秒)
content string 内容

result:

  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": "802",
  11. "tvId": "579028",
  12. "tvName": "社会CHINA",
  13. "title": "社会CHINA第8集.长视频v1.0.阿里视频云解决方案",
  14. "description": "",
  15. "coverUrl": "http://alivc-demo-vod.aliyuncs.com/d90ab79a49814425b338fc1c6f0eb19d/snapshots/normal/2AF06037-16C26293FE1-1103-1445-334-2638600001.jpg",
  16. "creationTime": "2019-07-25 06:45:33.0",
  17. "firstFrameUrl": "http://alivc-demo-vod.aliyuncs.com/d90ab79a49814425b338fc1c6f0eb19d/snapshots/normal/2AF06037-16C26293FE1-1103-1445-334-2638600001.jpg",
  18. "size": 16960798,
  19. "cateId": 0,
  20. "cateName": "",
  21. "tags": "社会CHINA",
  22. "isRecommend": "false",
  23. "isHomePage": "false",
  24. "videoId": "d90ab79a49814425b338fc1c6f0eb19d",
  25. "duration": 138,
  26. "transcodeStatus": "success",
  27. "snapshotStatus": "success",
  28. "censorStatus": "success",
  29. "snapshotList": [
  30. "http://alivc-demo-vod.aliyuncs.com/d90ab79a49814425b338fc1c6f0eb19d/snapshots/normal/444AE83D-16C26294085-1103-1445-334-2638600001.jpg",
  31. "http://alivc-demo-vod.aliyuncs.com/d90ab79a49814425b338fc1c6f0eb19d/snapshots/normal/444AE83D-16C26294085-1103-1445-334-2638600002.jpg"
  32. ],
  33. "dotList": [],
  34. "sort": "8",
  35. "isVip": "false"
  36. }
  37. ]
  38. }
  39. }

getTvPlayList

根据条件获取电视剧列表

method get
url /console/longVideo/getTvPlayList
param
名称 类型 是否必需 描述
consoleToken string token
pageIndex int 起始页 (从1开始)
pageSize int 每页条数
tvId string 电视剧id
title string 标题
startTime string 开始时间
endTime string 结束时间
isRecommend string 是否为推荐电视剧(是:true,否:false)
isHomePage string 是否为首页电视剧(是:true,否:false)
isRelease string 发布状态(上架:true,下架:false )
return param
名称 类型 描述
total string 视频总条数
tvPlayList List<tvPlay> 电视剧信息列表

tvPlay

名称 类型 描述
id string id
tvId string tvId
title string 电视剧标题
description string 电视剧标题描述
coverUrl string 封面URL
firstFrameUrl string 首帧地址
tags string 电视剧标题标签.多个用逗号分隔。
cateId string 电视剧标题分类id。
cateName string 电视剧标题分类名称。
creationTime string 创建时间
sort string 总集数
isRelease string 是否发布(是:true,否:false)

result:

  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. "tvId": "15",
  12. "longVideoId": "23rfewc23",
  13. "title": "test video",
  14. "description": "test33",
  15. "coverUrl": "https://alivc-demo-vod.aliyuncs.com/image9sfsa0-dfcoverurl.png",
  16. "creationTime": "2019-01-09 22:11:29.0",
  17. "firstFrameUrl": "",
  18. "cateId": 12,
  19. "sort": "2",
  20. "cateName": "12",
  21. "tags": "测试",
  22. "shareUrl": ""
  23. }
  24. ]
  25. }
  26. }

setLongVideoSort

设置长视频序号(集数)。

method post
url /console/longVideo/setLongVideoSort
param
名称 类型 是否必需 描述
consoleToken string token
videoId string 长视频id
tvId string 电视剧id
tvName string 电视剧名称
sort string 长视频集数
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"12jjhkjf23-23423jhrhuhfi9o2-2hgti",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

relieveLongVideoSort

解除长视频与电视剧关联。

method post
url /console/longVideo/relieveLongVideoSort
param
名称 类型 是否必需 描述
consoleToken string token
videoId string 长视频id
tvId string 电视剧id
sort string 长视频集数
return param

result:

  1. {
  2. "result": "true",
  3. "requestId": "510aaa4f-0788-4d0e-bfce-44c4ff85366f",
  4. "message": "解除长视频与电视剧关联完成",
  5. "code": "200",
  6. "data": null
  7. }

deleteTvPlay

删除电视剧。

method post
url /console/longVideo/deleteTvPlay
param
名称 类型 是否必需 描述
consoleToken string token
tvId string 电视剧id
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"aj12318-aafd-47ef-bd234h98f89-219670",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

deleteLongVideo

删除长视频。

method post
url /console/longVideo/deleteLongVideo
param
名称 类型 是否必需 描述
consoleToken string token
videoId string 长视频id
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"23r2fjjvwf-24gt2veggv-243yjn-h4",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

updateTvPlayReleaseStatus

上下架电视剧。

method post
url /console/longVideo/updateTvPlayReleaseStatus
param
名称 类型 是否必需 描述
consoleToken string token
tvId string 电视剧id
isRelease string 发布状态(上架:true,下架:false )
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34tewrg",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

setTvPlayHomePage

推送电视剧到首页位。

method post
url /console/longVideo/setTvPlayHomePage
param
名称 类型 是否必需 描述
consoleToken string token
tvId string 电视剧id
tags string 标签
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34tewrg",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

setTvPlayRecommend

推送电视剧到推荐位。

method post
url /console/longVideo/setTvPlayRecommend
param
名称 类型 是否必需 描述
token string token
tvId string 电视剧id
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34tewrg",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

setLongVideoHomePage

推送长视频到首页位。

method post
url /console/longVideo/setLongVideoHomePage
param
名称 类型 是否必需 描述
token string token
videoId string 长视频id
tags string 标签
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34tewrg",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

setLongVideoVip

推送长视频到vip。

method post
url /console/longVideo/setLongVideoVip
param
名称 类型 是否必需 描述
token string token
videoId string 长视频id
tags string 标签
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34tewrg",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

setLongVideoRecommend

推送长视频到推荐位。

method post
url /console/longVideo/setLongVideoRecommend
param
名称 类型 是否必需 描述
token string token
videoId string 长视频id
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34tewrg",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

updateLongVideoStatus

取消长视频推荐。

method post
url /console/longVideo/updateLongVideoStatus
param
名称 类型 是否必需 描述
consoleToken string token
videoId string 视频id
type string 1,推荐位 2,首页位 3,vip位
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34tewrg",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

updateTvPlayStatus

取消电视剧推荐。

method post
url /console/longVideo/updateTvPlayStatus
param
名称 类型 是否必需 描述
consoleToken string token
tvId string 电视剧id
type string 1,推荐位 2,首页位
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34tewrg",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

setLongVideoDot

设置长视频打点信息。

method post
url /console/longVideo/setLongVideoDot
param
名称 类型 是否必需 描述
consoleToken string token
videoId String 视频id
parms String 打点信息
return param

parms

名称 类型 描述
videoId string 视频id
time string 第几秒
content string 内容

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"sdf9afadf-adg34njk6u-sdv45",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

getDotListById

根据视频id获取打点信息。

method post
url /console/longVideo/setLongVideoDot
param
名称 类型 是否必需 描述
consoleToken string token
videoId string 视频id
return param
名称 类型 描述
dotList List<dotList> 打点信息列表

dotList

名称 类型 描述
videoId string 视频id
time string 第几秒
content string 内容

result:

  1. {
  2. "result": "true",
  3. "requestId": "5ff790bb-dfbf-4b5d-a3ed-fcc520e4ab29",
  4. "message": "查询长视频打点信息完成",
  5. "code": "200",
  6. "data": [
  7. {
  8. "videoId": "411d89fea52549cd9821c113c966e2cb",
  9. "time": "11",
  10. "content": "sdfasdfsf "
  11. },
  12. {
  13. "videoId": "411d89fea52549cd9821c113c966e2cb",
  14. "time": "123",
  15. "content": "adfhgfnhdgn"
  16. }
  17. ]
  18. }

createAudit

手动人工审核

method post
url /console/longVideo/createAudit
param
名称 类型 是否必需 描述
consoletoken string token
videoId String 视频id
status String 状态(Blocked(屏蔽),Normal(正常))
reason String 若审核状态为屏蔽时,需给出屏蔽的理由,最长支持128字节。
comment String 备注
return param
名称 类型 描述

result:

  1. {
  2. "result": "true",
  3. "requestId": "c312edd-1dc3-132r313rfef-qfevw42ghrnk",
  4. "message": "审核完成",
  5. "code": "200",
  6. "data": null
  7. }

createTag

新增标签。

method post
url /console/longVideo/createTag
param
名称 类型 是否必需 描述
consoleToken string token
tagName string 标签名称
type string 标签类型((1,长视频 2,电视剧3,vip视频))
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"adfgerhq35y-h3qy54jwyrh-tn19670",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

deleteTag

删除标签信息。

method post
url /console/longVideo/deleteTag
param
名称 类型 是否必需 描述
consoleToken string token
tagId string 标签id
return param

result:

  1. {
  2. "result":"true",
  3. "code":"200",
  4. "requestId":"adfgerhq35y-h3qy54jwyrh-tn19670",
  5. "message":null,
  6. "data":{}
  7. }
  8. }

getTagsListByType

获取标签列表。

method get
url /console/longVideo/getTagsListByType
param
名称 类型 是否必需 描述
consoleToken string token
type string 标签类型((1,长视频 2,电视剧3,vip视频))
return param
名称 类型 描述
tagList List<Tag> 标签信息列表

Tag

名称 类型 描述
id string id
tagId string 标签id
tagName string 标签名称
type string 标签类型((1,长视频 2,电视剧3,vip视频))

result:

  1. {
  2. "result": "true",
  3. "requestId": "73ca7051-e517-485c-a5c4-2472c9a4c886",
  4. "message": "获取标签完成",
  5. "code": "200",
  6. "data": [
  7. {
  8. "id": "1",
  9. "tagId": "1324",
  10. "tagName": "专题节目",
  11. "type": "1"
  12. }
  13. ]
  14. }

setTvPlayTag

设置电视剧标签

method post
url /console/longVideo/setTvPlayTag
param
名称 类型 是否必需 描述
consoleToken string token
tvId String 电视剧id
tags String 标签信息
return param
名称 类型 描述

result:

  1. {
  2. "result": "true",
  3. "requestId": "c312edd-1dc3-132r313rfef-qfevw42ghrnk",
  4. "message": "设置电视剧标签",
  5. "code": "200",
  6. "data": null
  7. }

setLongVideoTag

设置长视频标签

method post
url /console/longVideo/setLongVideoTag
param
名称 类型 是否必需 描述
consoleToken string token
videoId String 视频id
tags String 标签信息
return param
名称 类型 描述

result:

  1. {
  2. "result": "true",
  3. "requestId": "c312edd-1dc3-132r313rfef-qfevw42ghrnk",
  4. "message": "设置长视频标签完成",
  5. "code": "200",
  6. "data": null
  7. }