Skip to content

视频相关接口

上传视频信息

请求URL

  • /api/v1/video/uploadVideoInfo

请求方式

  • POST

请求头

  • Authorization': token
  • "content-type": "application/json"

参数

参数名必选类型说明
vidint视频ID
titlestring视频标题
coverstring封面图url
descstring视频简介 默认:"什么都没有"
copyrightbool是否为原创视频
tagsstring视频标签,使用,分隔
partitionIdint视频分区

返回示例

json
{
  "code": 200,
  "data": null,
  "msg":"ok"
}

备注

需要先上传视频拿到视频ID

获取视频状态信息

请求URL

  • /api/v1/video/getVideoStatus?vid=视频ID

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "video": {
      "vid": 1,
      "title": "标题",
      "cover": "封面url",
      "desc": "视频简介",
      "copyright": true,
      "status": 0,
      "partitionId": 1,
      "tags": "",
      "duration": 10,
      "resources": [
        {
          "id": 1,
          "createdAt": "",
          "vid": 1,
          "title": "",
          "duration": 10,
          "status": 0
        }
      ]
    }
  },
  "msg": "ok"
}

返回参数说明

视频信息video
参数名类型说明
vidint视频ID
titlestring标题
coverstring封面URL
descstring视频简介
copyrightbool是否为原创视频
statusint视频审核状态
partitionIdint分区ID
tagsstring视频标签
durationfloat视频时长
resourcearray视频资源,多个代表多个分集
视频资源resource
参数名类型说明
idint分集ID
createdAtstring上传时间
vidint视频ID
titlestring标题
durationfloat视频时长
statusint审核状态

备注

获取上传视频列表

请求URL

  • /api/v1/video/getUploadVideo?page=页码&pageSize=内容数量

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "total": 1,
    "videos": [
      {
        "vid": 2,
        "title": "测试1",
        "cover": "",
        "desc": "",
        "status": 0,
        "copyright": true,
        "createdAt": "2021-07-16T08:49:54Z",
        "clicks": 10,
      },
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
totalint数量
videosobject视频信息数组
视频信息
参数名类型说明
vidint视频ID
titlestring标题
coverstring封面图url
descstring简介
statusint视频审核状态
copyrightbool是否为原创视频
clicksint视频点击量
createdAtstring上传时间

备注

编辑视频信息

请求URL

  • /api/v1/video/editVideoInfo

请求方式

  • PUT

请求头

  • Authorization': token
  • "content-type": "application/json",

参数

参数名必选类型说明
vidint视频ID
titlestring视频标题
coverstring封面图url
descstring视频简介
tagsstring视频标签,使用,分隔

返回示例

json
{
  "code": 200,
  "data": null,
  "msg":"ok"
}

备注

删除视频

请求URL

  • /api/v1/video/deleteVideo/视频ID

请求方式

  • DELETE

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": null,
  "msg": "ok"
}

备注

获取所有的视频列表

请求URL

  • /api/v1/video/getAllVideoList

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "videos": [
      {
        "vid": 1,
        "title": ""
      }
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
totalint数量
videosobject视频信息数组
视频信息
参数名类型说明
vidint视频ID
titlestring标题

备注

获取视频信息

请求URL

  • /api/v1/video/getVideoById?vid=视频ID

请求方式

  • GET

返回示例

json
{
  "code": 200,
  "data": {
    "video": {
      "vid": 1,
      "uid": 1,
      "title": "标题",
      "cover": "封面url",
      "desc": "视频简介",
      "createdAt": "",
      "copyright": true,
      "tags": "",
      "duration": 10,
      "clicks": 10,
      "partitionId": 1,
      "author": {
        "uid": 1,
        "name": "",
        "sign": "",
        "email": "",
        "phone": "",
        "avatar": "",
        "gender": 1,
        "spaceCover": "",
        "birthday": "",
        "createdAt": "",
      },
      "resources": [
        {
          "id": 1,
          "createdAt": "",
          "vid": 1,
          "title": "",
          "duration": 10,
          "status": 0
        }
      ]
    }
  },
  "msg": "ok"
}

返回参数说明

视频信息video
参数名类型说明
vidint视频ID
uidint作者ID
titlestring标题
coverstring封面URL
descstring视频简介
createdAtstring上传时间
copyrightbool是否为原创视频
tagsstring视频标签
durationfloat视频时长
clicksint视频点击量
partitionIdint分区ID
authorobject作者信息
resourcearray视频资源,多个代表多个分集
作者信息author
参数名类型说明
uidint用户ID
namestring用户名
signstring个性签名
emailstring邮箱
phonestring手机号
avatarstring头像
genderint用户性别,0:未知;1:男;2:女
spacecoverstring用户空间封面图
birthdaytime生日
createdAttime注册时间
视频资源resource
参数名类型说明
idint分集ID
createdAtstring上传时间
vidint视频ID
titlestring标题
durationfloat视频时长
statusint审核状态

备注

获取视频分辨率信息

请求URL

  • /api/v1/video/getResourceQuality?resourceId=资源ID

请求方式

  • GET

返回示例

json
{
  "code": 200,
  "data": {
    "quality": [
      "640x360_500k",
      "854x480_900k",
      "1080x720_2000k",
      "1920x1080_3000k",
    ]
  },
  "msg": "ok"
}

备注

获取视频文件

请求URL

  • /api/v1/video/getVideoFile?resourceId=资源ID&quality=资源分辨率信息

请求方式

  • GET

返回示例

text
#EXTM3U
#EXT-X-VERSION:3
#EXT-X-MEDIA-SEQUENCE:0
#EXT-X-ALLOW-CACHE:YES
#EXT-X-TARGETDURATION:15
#EXTINF:14.647967,
854x480_900k_300000.ts
...
#EXTINF:9.509500,
854x480_900k_300014.ts
#EXT-X-ENDLIST

备注

获取视频切片

请求URL

  • /api/v1/video/slice/文件?key=文件key

请求方式

  • GET

返回示例

如果存储为本地存储会返回文件

如果存储为OSS则会重定向到OSS上的文件

备注

该接口的请求参数为获取视频文件接口返回的信息

通过用户ID获取视频列表

请求URL

  • /api/v1/video/getVideoByUser?userId=用户ID&page=页码&pageSize=内容数量

请求方式

  • GET

返回示例

json
{
  "code": 200,
  "data": {
    "total": 1,
    "videos": [
      {
        "vid": 2,
        "title": "测试1",
        "cover": "",
        "desc": "",
        "status": 0,
        "copyright": true,
        "createdAt": "2021-07-16T08:49:54Z",
        "clicks": 10,
      },
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
totalint数量
videosobject视频信息数组
视频信息
参数名类型说明
vidint视频ID
titlestring标题
coverstring封面图url
descstring简介
statusint视频审核状态
copyrightbool是否为原创视频
clicksint视频点击量
createdAtstring上传时间

备注

获取热门视频

请求URL

  • /api/v1/video/getHotVideo?page=页码&pageSize=内容数量

请求方式

  • GET

返回示例

json
{
  "code": 200,
    "data": {
    "videos": [
      {
        "vid": 1,
        "uid": 1,
        "title": "标题",
        "cover": "封面url",
        "desc": "视频简介",
        "createdAt": "",
        "copyright": true,
        "tags": "",
        "duration": 10,
        "clicks": 10,
        "partitionId": 1,
        "author": {
          "uid": 1,
          "name": "",
          "sign": "",
          "email": "",
          "phone": "",
          "avatar": "",
          "gender": 1,
          "spaceCover": "",
          "birthday": "",
          "createdAt": "",
        },
        "resources": [
          {
            "id": 1,
            "createdAt": "",
            "vid": 1,
            "title": "",
            "duration": 10,
            "status": 0
          }
        ]
      },
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
videosobject视频信息数组
视频信息video
参数名类型说明
vidint视频ID
uidint作者ID
titlestring标题
coverstring封面URL
descstring视频简介
createdAtstring上传时间
copyrightbool是否为原创视频
tagsstring视频标签
durationfloat视频时长
clicksint视频点击量
partitionIdint分区ID
authorobject作者信息
resourcearray视频资源,多个代表多个分集
作者信息author
参数名类型说明
uidint用户ID
namestring用户名
signstring个性签名
emailstring邮箱
phonestring手机号
avatarstring头像
genderint用户性别,0:未知;1:男;2:女
spacecoverstring用户空间封面图
birthdaytime生日
createdAttime注册时间
视频资源resource
参数名类型说明
idint分集ID
createdAtstring上传时间
vidint视频ID
titlestring标题
durationfloat视频时长
statusint审核状态

备注

内容数量最大为30

随机获取指定分区的视频

请求URL

  • /api/v1/video/getVideoListByPartition?size=内容数量&partitionId=分区ID

请求方式

  • GET

返回示例

json
{
  "code": 200,
  "data": {
    "videos": [
      {
        "vid": 1,
        "uid": 1,
        "title": "标题",
        "cover": "封面url",
        "desc": "视频简介",
        "createdAt": "",
        "copyright": true,
        "tags": "",
        "duration": 10,
        "clicks": 10,
        "partitionId": 1,
        "author": {
          "uid": 1,
          "name": "",
          "sign": "",
          "email": "",
          "phone": "",
          "avatar": "",
          "gender": 1,
          "spaceCover": "",
          "birthday": "",
          "createdAt": "",
        },
        "resources": [
          {
            "id": 1,
            "createdAt": "",
            "vid": 1,
            "title": "",
            "duration": 10,
            "status": 0
          }
        ]
      },
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
videosobject视频信息数组
视频信息video
参数名类型说明
vidint视频ID
uidint作者ID
titlestring标题
coverstring封面URL
descstring视频简介
createdAtstring上传时间
copyrightbool是否为原创视频
tagsstring视频标签
durationfloat视频时长
clicksint视频点击量
partitionIdint分区ID
authorobject作者信息
resourcearray视频资源,多个代表多个分集
作者信息author
参数名类型说明
uidint用户ID
namestring用户名
signstring个性签名
emailstring邮箱
phonestring手机号
avatarstring头像
genderint用户性别,0:未知;1:男;2:女
spacecoverstring用户空间封面图
birthdaytime生日
createdAttime注册时间
视频资源resource
参数名类型说明
idint分集ID
createdAtstring上传时间
vidint视频ID
titlestring标题
durationfloat视频时长
statusint审核状态

备注

内容数量最大为30

获取相关推荐视频

请求URL

  • /api/v1/video/getRelatedVideoList?vid=视频ID

请求方式

  • GET

返回示例

json
{
  "code": 200,
    "data": {
    "videos": [
      {
        "vid": 1,
        "uid": 1,
        "title": "标题",
        "cover": "封面url",
        "desc": "视频简介",
        "createdAt": "",
        "copyright": true,
        "tags": "",
        "duration": 10,
        "clicks": 10,
        "partitionId": 1,
        "author": {
          "uid": 1,
          "name": "",
          "sign": "",
          "email": "",
          "phone": "",
          "avatar": "",
          "gender": 1,
          "spaceCover": "",
          "birthday": "",
          "createdAt": "",
        },
        "resources": [
          {
            "id": 1,
            "createdAt": "",
            "vid": 1,
            "title": "",
            "duration": 10,
            "status": 0
          }
        ]
      },
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
videosobject视频信息数组
视频信息video
参数名类型说明
vidint视频ID
uidint作者ID
titlestring标题
coverstring封面URL
descstring视频简介
createdAtstring上传时间
copyrightbool是否为原创视频
tagsstring视频标签
durationfloat视频时长
clicksint视频点击量
partitionIdint分区ID
authorobject作者信息
resourcearray视频资源,多个代表多个分集
作者信息author
参数名类型说明
uidint用户ID
namestring用户名
signstring个性签名
emailstring邮箱
phonestring手机号
avatarstring头像
genderint用户性别,0:未知;1:男;2:女
spacecoverstring用户空间封面图
birthdaytime生日
createdAttime注册时间
视频资源resource
参数名类型说明
idint分集ID
createdAtstring上传时间
vidint视频ID
titlestring标题
durationfloat视频时长
statusint审核状态

备注

搜索视频

请求URL

  • /api/v1/video/searchVideo

请求方式

  • POST

请求头

  • "content-type": "application/json"

请求参数

参数名必选类型说明
pageint页码
pageSizeint页面数量,最大30
keyWordsstring关键词

返回示例

json
{
  "code": 200,
    "data": {
    "videos": [
      {
        "vid": 1,
        "uid": 1,
        "title": "标题",
        "cover": "封面url",
        "desc": "视频简介",
        "createdAt": "",
        "copyright": true,
        "tags": "",
        "duration": 10,
        "clicks": 10,
        "partitionId": 1,
        "author": {
          "uid": 1,
          "name": "",
          "sign": "",
          "email": "",
          "phone": "",
          "avatar": "",
          "gender": 1,
          "spaceCover": "",
          "birthday": "",
          "createdAt": "",
        },
        "resources": [
          {
            "id": 1,
            "createdAt": "",
            "vid": 1,
            "title": "",
            "duration": 10,
            "status": 0
          }
        ]
      },
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
videosobject视频信息数组
视频信息video
参数名类型说明
vidint视频ID
uidint作者ID
titlestring标题
coverstring封面URL
descstring视频简介
createdAtstring上传时间
copyrightbool是否为原创视频
tagsstring视频标签
durationfloat视频时长
clicksint视频点击量
partitionIdint分区ID
authorobject作者信息
resourcearray视频资源,多个代表多个分集
作者信息author
参数名类型说明
uidint用户ID
namestring用户名
signstring个性签名
emailstring邮箱
phonestring手机号
avatarstring头像
genderint用户性别,0:未知;1:男;2:女
spacecoverstring用户空间封面图
birthdaytime生日
createdAttime注册时间
视频资源resource
参数名类型说明
idint分集ID
createdAtstring上传时间
vidint视频ID
titlestring标题
durationfloat视频时长
statusint审核状态

备注

内容数量最大为30

后台管理-获取审核列表

请求URL

  • /api/v1/video/getReviewList?page=页码&page_size=内容数量

请求方式

  • GET

请求头

  • Authorization': token
  • "content-type": "application/json"

请求参数

参数名必选类型说明
pageint页码
pageSizeint页面数量,最大100

返回示例

json
{
  "code": 200,
    "data": {
      "total": 1,
      "list": [
        {
          "vid": 1,
          "uid": 1,
          "title": "测试1",
          "cover": "",
          "desc": "",
          "createdAt": "2022-06-06T08:42:13.525Z",
          "copyright": true,
          "tags": "",
          "duration": 100,
          "partitionId": 1,
          "author": {
            "uid": 1,
            "name": "",
            "sign": "",
            "email": "",
            "phone": "",
            "avatar": "",
            "gender": 1,
            "spaceCover": "",
            "birthday": "",
            "createdAt": "",
          },
        },
      ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
totalint数量
listarray视频信息
视频信息
参数名类型说明
vidint视频ID
uidint用户ID
titlestring标题
coverstring封面URL
descstring视频简介
createdAttime发布时间
copyrightbool是否为原创视频
tagsstring视频标签
durationfloat视频时长
partitionIdint分区ID
authorobject作者信息
作者信息author
参数名类型说明
uidint用户ID
namestring用户名
signstring个性签名
emailstring邮箱
phonestring手机号
avatarstring头像
genderint用户性别,0:未知;1:男;2:女
spacecoverstring用户空间封面图
birthdaytime生日
createdAttime注册时间
备注

后台管理-获取待审核资源列表

请求URL

  • /api/v1/video/getReviewResourceList?vid=视频ID

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "resources": [
      {
        "id": 1,
        "createdAt": "",
        "vid": 1,
        "title": "",
        "duration": 10,
        "status": 0,
      }
    ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
idint分集ID
createdAttime上传时间
vidint视频ID
titlestring标题
durationfloat视频时长
statusint审核状态

备注

后台管理-获取视频列表

请求URL

  • /api/v1/video/getVideoListManage

请求方式

  • GET

请求头

  • Authorization': token
  • "content-type": "application/json"

请求参数

参数名必选类型说明
pageint页码
pageSizeint页面数量,最大100

返回示例

json
{
  "code": 200,
    "data": {
    "total": 1,
      "videos": [
        {
          "vid": 1,
          "title": "测试1",
          "cover": "",
          "desc": "",
          "created_at": "2022-06-06T08:42:13.525Z",
          "copyright": true,
          "author": {
            "uid": 1,
            "name": "user_1654250698886",
            "sign": "这个人很懒,什么都没有留下1",
            "avatar": "",
            "spacecover": "",
            "gender": 0,
          },
          "clicks": 86,
          "partition": 1
        },
      ]
  },
  "msg": "ok"
}

返回示例

json
{
  "code": 200,
    "data": {
      "total": 1,
      "list": [
        {
          "vid": 1,
          "uid": 1,
          "title": "测试1",
          "cover": "",
          "desc": "",
          "createdAt": "2022-06-06T08:42:13.525Z",
          "copyright": true,
          "tags": "",
          "clicks": 1,
          "duration": 100,
          "partitionId": 1,
          "author": {
            "uid": 1,
            "name": "",
            "sign": "",
            "email": "",
            "phone": "",
            "avatar": "",
            "gender": 1,
            "spaceCover": "",
            "birthday": "",
            "createdAt": "",
          },
        },
      ]
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
totalint数量
listarray视频信息
视频信息videos
参数名类型说明
vidint视频ID
uidint用户ID
titlestring标题
coverstring封面URL
descstring视频简介
createdAttime发布时间
copyrightbool是否为原创视频
tagsstring视频标签
clicksstring播放量
durationfloat视频时长
partitionIdint分区ID
authorobject作者信息
作者信息author
参数名类型说明
uidint用户ID
namestring用户名
signstring个性签名
emailstring邮箱
phonestring手机号
avatarstring头像
genderint用户性别,0:未知;1:男;2:女
spacecoverstring用户空间封面图
birthdaytime生日
createdAttime注册时间
备注

后台管理-删除视频

请求URL

  • /api/v1/video/deleteVideoManage/视频ID

请求方式

  • DELETE

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": null,
  "msg": "ok"
}

备注

后台管理-获取视频分辨率信息

请求URL

  • /api/v1/video/getResourceQualityManage?resourceId=资源ID

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "quality": [
      "640x360_500k",
      "854x480_900k",
      "1080x720_2000k",
      "1920x1080_3000k",
    ]
  },
  "msg": "ok"
}

备注

后台管理-获取视频文件

请求URL

  • /api/v1/video/getVideoFileManage?resourceId=资源ID&quality=资源分辨率信息

请求方式

  • GET

请求头

  • Authorization': token

返回示例

text
#EXTM3U
#EXT-X-VERSION:3
#EXT-X-MEDIA-SEQUENCE:0
#EXT-X-ALLOW-CACHE:YES
#EXT-X-TARGETDURATION:15
#EXTINF:14.647967,
854x480_900k_300000.ts
...
#EXTINF:9.509500,
854x480_900k_300014.ts
#EXT-X-ENDLIST

备注

根据 MIT 许可证发布