文档

长视频控制台接口说明

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

返回值结构说明

所有请求均返回此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:

{ 
     "result":"true",
     "code":"200",
     "requestId":"3099ee2b-aa30-4c38-b28e-12dc1e1b****",
     "message":null,
     "data":{}
    }

}

createTvPlay

新增电视剧。

method

post

url

/console/longVideo/createTvPlay

param

名称

类型

是否必需

描述

consoleToken

string

token。

title

string

电视剧标题。

tvName

string

电视剧名称。

file

MultipartFile

二进制文件流。

description

string

电视剧描述。

tags

string

电视剧标签。多个用半角逗号分隔。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"36f336d6-e3c2-4031-8f13-3d6fc38f****",
     "message":null,
     "data":{}
    }

}

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:

{ 
     "result":"true",
     "code":"200",
     "requestId":"90c08fe0-1dc9-4fdf-8c68-4b3ae5a1****",
     "message":null,
     "data":{}
    }

}

updateLongVideoInfo

编辑长视频基本信息 。

method

post

url

/console/longVideo/updateLongVideoInfo

param

名称

类型

是否必需

描述

consoleToken

string

token。

videoId

string

长视频ID。

title

string

长视频标题。

description

string

长视频描述。

tags

string

长视频标签。多个用半角逗号分隔。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"ba62239e-76cf-4a63-9823-907c0ee3****",
     "message":"编辑长视频基本信息完成",
     "data":{}
    }

}

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:

{
  "result": "true",
  "requestId": "afga23534t-geggtw4-hw4htnytj-45y****",
  "message": "查询长视频列表完成",
  "code": "200",
  "data": {
    "total": 7,
    "videoList": [
      {
        "id": "802",
                "tvId": "579028",
                "tvName": "社会CHINA",
                "title": "社会CHINA第8集.长视频v1.0.阿里视频云解决方案",
                "description": "",
                "coverUrl": "http://example.aliyundoc.com/d90ab79a49814425b338fc1c6f0eb19d/snapshots/normal/2AF06037-16C26293FE1-1103-1445-334-26386****.jpg",
                "creationTime": "2019-07-25 06:45:33.0",
                "firstFrameUrl": "http://example.aliyundoc.com/d90ab79a49814425b338fc1c6f0eb19d/snapshots/normal/2AF06037-16C26293FE1-1103-1445-334-263860****.jpg",
                "size": 16960798,
                "cateId": 0,
                "cateName": "",
                "tags": "社会CHINA",
                "isRecommend": "false",
                "isHomePage": "false",
                "videoId": "d90ab79a49814425b338fc1c6f0****",
                "duration": 138,
                "transcodeStatus": "success",
                "snapshotStatus": "success",
                "censorStatus": "success",
                "snapshotList": [
                    "http://example.aliyundoc.com/d90ab79a49814425b338fc1c6f0eb19d/snapshots/normal/444AE83D-16C26294085-1103-1445-334-263860****.jpg",
                    "http://example.aliyundoc.com/d90ab79a49814425b338fc1c6f0eb19d/snapshots/normal/444AE83D-16C26294085-1103-1445-334-263860****.jpg"
                ],
                "dotList": [],
                "sort": "8",
                "isVip": "false"
      }
    ]
  }
}

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:

{
  "result": "true",
  "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56****",
  "message": "查询电视剧列表完成",
  "code": "200",
  "data": {
    "total": 7,
    "videoList": [
      {
        "id": "25",
         "tvId": "15",
        "longVideoId": "23rfewc23",
        "title": "test video",
        "description": "test33", 
        "coverUrl": "https://example.aliyundoc.com/image01.png",
        "creationTime": "2019-01-09 22:11:29.0", 
        "firstFrameUrl": "", 
        "cateId": 12,
        "sort": "2",
        "cateName": "12",
        "tags": "测试",
        "shareUrl": ""

      }
    ]
  }
}

setLongVideoSort

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

method

post

url

/console/longVideo/setLongVideoSort

param

名称

类型

是否必需

描述

consoleToken

string

token。

videoId

string

长视频ID。

tvId

string

电视剧ID。

tvName

string

电视剧名称。

sort

string

长视频集数。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"12jjhkjf23-23423jhrhuhfi9o2-2****",
     "message":null,
     "data":{}
    }

}

relieveLongVideoSort

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

method

post

url

/console/longVideo/relieveLongVideoSort

param

名称

类型

是否必需

描述

consoleToken

string

token。

videoId

string

长视频ID。

tvId

string

电视剧ID。

sort

string

长视频集数。

return param

result:

{
    "result": "true",
    "requestId": "510aaa4f-0788-4d0e-bfce-44c4ff85****",
    "message": "解除长视频与电视剧关联完成",
    "code": "200",
    "data": null
}

deleteTvPlay

删除电视剧。

method

post

url

/console/longVideo/deleteTvPlay

param

名称

类型

是否必需

描述

consoleToken

string

token。

tvId

string

电视剧ID。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"aj12318-aafd-47ef-bd234h98f89-21****",
     "message":null,
     "data":{}
    }

}

deleteLongVideo

删除长视频。

method

post

url

/console/longVideo/deleteLongVideo

param

名称

类型

是否必需

描述

consoleToken

string

token。

videoId

string

长视频ID。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"23r2fjjvwf-24gt2veggv-243yj****",
     "message":null,
     "data":{}
    }

}

updateTvPlayReleaseStatus

上下架电视剧。

method

post

url

/console/longVideo/updateTvPlayReleaseStatus

param

名称

类型

是否必需

描述

consoleToken

string

token。

tvId

string

电视剧ID。

isRelease

string

发布状态(上架:true,下架:false )。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34t****",
     "message":null,
     "data":{}
    }

}

setTvPlayHomePage

推送电视剧到首页位。

method

post

url

/console/longVideo/setTvPlayHomePage

param

名称

类型

是否必需

描述

consoleToken

string

token

tvId

string

电视剧ID。

tags

string

标签。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34t****",
     "message":null,
     "data":{}
    }

}

setTvPlayRecommend

推送电视剧到推荐位。

method

post

url

/console/longVideo/setTvPlayRecommend

param

名称

类型

是否必需

描述

token

string

token。

tvId

string

电视剧ID。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34t****",
     "message":null,
     "data":{}
    }

}

setLongVideoHomePage

推送长视频到首页位。

method

post

url

/console/longVideo/setLongVideoHomePage

param

名称

类型

是否必需

描述

token

string

token。

videoId

string

长视频ID。

tags

string

标签。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34t****",
     "message":null,
     "data":{}
    }

}

setLongVideoVip

推送长视频到vip。

method

post

url

/console/longVideo/setLongVideoVip

param

名称

类型

是否必需

描述

token

string

token。

videoId

string

长视频ID。

tags

string

标签。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34t****",
     "message":null,
     "data":{}
    }

}

setLongVideoRecommend

推送长视频到推荐位。

method

post

url

/console/longVideo/setLongVideoRecommend

param

名称

类型

是否必需

描述

token

string

token

videoId

string

长视频ID。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34****",
     "message":null,
     "data":{}
    }

}

updateLongVideoStatus

取消长视频推荐。

method

post

url

/console/longVideo/updateLongVideoStatus

param

名称

类型

是否必需

描述

consoleToken

string

token。

videoId

string

视频ID。

type

string

  • 1:推荐位

  • 2:首页位

  • 3:vip位

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34t****",
     "message":null,
     "data":{}
    }

}

updateTvPlayStatus

取消电视剧推荐。

method

post

url

/console/longVideo/updateTvPlayStatus

param

名称

类型

是否必需

描述

consoleToken

string

token。

tvId

string

电视剧ID。

type

string

  • 1:推荐位

  • 2:首页位

  • 3:vip位

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"hawiugeb,6remtd-sw75iejyrnsryj-w56ijrg34t****",
     "message":null,
     "data":{}
    }

}

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:

{ 
     "result":"true",
     "code":"200",
     "requestId":"sdf9afadf-adg34njk6u-s****",
     "message":null,
     "data":{}
    }

}

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:

{
    "result": "true",
    "requestId": "5ff790bb-dfbf-4b5d-a3ed-fcc520e48****",
    "message": "查询长视频打点信息完成",
    "code": "200",
    "data": [
        { 
            "videoId": "411d89fea52549cd9821c113c966****",
            "time": "11",
            "content": "sdfasdfsf "
        },
        { 
            "videoId": "411d89fea52549cd9821c113c966****",
            "time": "123",
            "content": "adfhgfnhdgn"
        }
    ]
}

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:

{
  "result": "true",
  "requestId": "c312edd-1dc3-132r313rfef-qfevw42g****",
  "message": "审核完成",
  "code": "200",
  "data": null
}

createTag

新增标签。

method

post

url

/console/longVideo/createTag

param

名称

类型

是否必需

描述

consoleToken

string

token

tagName

string

标签名称。

type

string

标签类型。

  • 1:长视频

  • 2:电视剧

  • 3:vip视频

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"adfgerhq35y-h3qy54jwyrh-tn1****",
     "message":null,
     "data":{}
    }

}

deleteTag

删除标签信息。

method

post

url

/console/longVideo/deleteTag

param

名称

类型

是否必需

描述

consoleToken

string

token。

tagId

string

标签ID。

return param

result:

{ 
     "result":"true",
     "code":"200",
     "requestId":"adfgerhq35y-h3qy54jwyrh-tn1****",
     "message":null,
     "data":{}
    }

}

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:

{
    "result": "true",
    "requestId": "73ca7051-e517-485c-a5c4-2472c9a4****",
    "message": "获取标签完成",
    "code": "200",
    "data": [
        {
            "id": "1",
            "tagId": "1324",
            "tagName": "专题节目",
            "type": "1"
        }
    ]
}

setTvPlayTag

设置电视剧标签。

method

post

url

/console/longVideo/setTvPlayTag

param

名称

类型

是否必需

描述

consoleToken

string

token。

tvId

String

电视剧ID。

tags

String

标签信息。

return param

名称

类型

描述

result:

{
  "result": "true",
  "requestId": "c312edd-1dc3-132r313rfef-qfevw42g****",
  "message": "设置电视剧标签",
  "code": "200",
  "data": null
}

setLongVideoTag

设置长视频标签。

method

post

url

/console/longVideo/setLongVideoTag

param

名称

类型

是否必需

描述

consoleToken

string

token。

videoId

String

视频ID。

tags

String

标签信息。

return param

名称

类型

描述

result:

{
  "result": "true",
  "requestId": "c312edd-1dc3-132r313rfef-qfevw42g****",
  "message": "设置长视频标签完成",
  "code": "200",
  "data": null
}
  • 本页导读 (1)
文档反馈