按分类获取视频信息
更新时间:2020-1-6
1. v2版本
接口描述
该接口用于获取分类下视频信息,在v1基础上返回数据增加了视频文件大小信息、视频占用总空间、原始文件占用空间、上传人、上传时间。
请求地址
https://spark.bokecc.com/api/videos/category/v2
请求方式
GET
请求参数
以下请求参数需要进行THQS权限认证, 权限认证方式请参考THQS认证方式。
名称 |
类型 |
必填 |
描述 |
userid |
String |
是 |
用户ID。 |
categoryid |
String |
是 |
视频分类ID。 |
sort |
String |
否 |
1、格式:排序字段:排序方式 2、排序字段:CREATION_DATE或FILE_SIZE 3、排序方式:ASC或DESC 注:格式中的“:”为英文半角 Example:sort=CREATION_DATE:DESC |
subuserid |
String |
否 |
子账号id,如果为空则查询分类下全部视频。 |
num_per_page |
Integer |
否 |
分页参数,每页显示数量,默认为100。取值范围:大于0的整数。 |
page |
Integer |
否 |
分页参数,页码,默认为1。取值范围:大于0的整数。 |
请求示例
https://spark.bokecc.com/api/videos/category/v2?subuserid=xxx&page=1&sort=CREATION_DATE%3ADESC&time=1671174879576&userid=CC443A6686737xxx&categoryid=DC7D95457F0984xxx&hash=F4E2D10DD7E2C6E2DF44F28AB3EA66D1&num_per_page=100
返回数据
名称 |
类型 |
说明 |
videos |
Object |
视频信息。 |
videos说明
名称 |
类型 |
说明 |
total |
Integer |
返回视频总数。 |
video |
Array |
视频信息。 |
video说明
名称 |
类型 |
说明 |
id |
String |
视频ID。 |
title |
String |
视频标题。 |
desp |
String |
视频描述。 |
tags |
String |
视频标签。 |
duration |
Integer |
视频时长,单位:秒。 |
category |
String |
视频分类ID。 |
image |
String |
视频截图地址。 |
imageindex |
Integer |
视频截图序号。 |
image-alternate |
Array |
视频截图排列信息。 |
definition |
Array |
视频文件大小信息。 |
totalsize |
Long |
视频占用总空间,包含原始文件大小。 |
originalsize |
Long |
原始文件占用空间。 |
uploaduser |
String |
上传人(主账号/子账号的邮箱)。 |
uploadtime |
String |
上传时间。 |
image-alternate说明
名称 |
类型 |
说明 |
index |
Integer |
视频截图排列序号。 |
url |
String |
视频截图地址。 |
definition说明
名称 |
类型 |
说明 |
definitionlevel |
Integer |
视频清晰度值。 |
definitiondesc |
String |
视频清晰度描述。 |
terminaltype |
Integer |
终端类型(0:PC端,10:移动端)。 |
filesize |
Long |
视频文件大小。 |
width |
Integer |
该清晰度视频的宽。 |
height |
Integer |
该清晰度视频的高。 |
返回示例
{
"videos": {
"total": "7",
"video": [
{
"id": "01234567",
"title": " 视频标题",
"desp": "视频描述",
"tags": "标签1 标签2",
"duration": 264,
"category": "12345",
"image": "http:// xxx-0.jpg",
"imageindex": 0,
"image-alternate": [
{
"index": "0",
"url": "http:// xxx-0/0.jpg"
}
],
"definition": [
{
"definitionlevel": 2,
"definitiondesc": "高清",
"terminaltype": 0,
"filesize": 6587147
}
],
"totalsize": 8518383,
"originalsize": 3275892,
"updateuser": "主账号",
"updatetime": "2018-03-01 13:00:00"
}
]
}
}
2. v1版本
接口描述
该接口用于获取分类下视频信息。
请求地址
https://spark.bokecc.com/api/videos/category
请求方式
GET
请求参数
以下请求参数需要进行THQS权限认证, 权限认证方式请参考THQS认证方式。
名称 |
类型 |
必填 |
描述 |
categoryid |
String |
是 |
视频分类的ID。 |
userid |
String |
是 |
用户ID。 |
num_per_page |
Integer |
否 |
分页参数,每页显示数量,默认为100。取值范围:大于0的整数。 |
page |
Integer |
否 |
分页参数,页码,默认为1。取值范围:大于0的整数。 |
format |
String |
否 |
返回格式,xml或json,默认xml。 |
请求示例
https://spark.bokecc.com/api/videos/category?format=json&page=1&time=1671175150974&userid=CC443A6686737xxx&categoryid=DC7D95457F098xxx&hash=818DA913C36E2D37620FA87B446DBF49&num_per_page=100
返回数据
名称 |
类型 |
说明 |
videos |
Object |
视频信息。 |
videos说明
名称 |
类型 |
说明 |
total |
Integer |
返回视频数量。 |
video |
Array |
视频信息。 |
video说明
名称 |
类型 |
说明 |
id |
String |
视频ID。 |
title |
String |
视频标题。 |
desp |
String |
视频描述。 |
tags |
String |
视频标签。 |
duration |
Integer |
视频时长,单位:秒。 |
category |
String |
视频分类ID。 |
image |
String |
视频截图地址。 |
imageindex |
Integer |
视频截图序号。 |
image-alternate |
Array |
视频截图排列信息。 |
image-alternate说明
名称 |
类型 |
说明 |
index |
Integer |
视频截图排列序号。 |
url |
String |
视频截图地址。 |
XML返回示例
<? xmlversion="1.0"encoding="UTF-8"?>
<videos>
<total>7</total>
<video>
<id>01234567</id>
<title>视频标题</title>
<desp>视频描述</desp>
<tags>标签1 标签2</tags>
<duration>264</duration>
<category>12345</category>
<image>http:// xxx.jpg</image>
<imageindex>0</imageindex>
<image-alternate>
<index>0</index>
<url>http:// xxx-0/0.jpg</url>
</image-alternate>
</video>
</videos>
JSON返回示例
{
"videos": {
"total": "7",
"video": [
{
"id": "01234567",
"title": " 视频标题",
"desp": "视频描述",
"tags": " 标签1标签2",
"duration": 264,
"category": "12345",
"image": "http:// xxx-0.jpg",
"imageindex": 0,
"image-alternate": [
{
"index": "0",
"url": "http:// xxx-0/0.jpg"
}
]
}
]
}
}