媒体库

优质

小牛编辑

137浏览

2023-12-01

获取媒体库视频总量【控制台】

基本信息

Path： /videos/api/get_videos_size

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注
errcode	number	非必须
data	object	非必须
├─ size	number	非必须	视频总量，单位 B

修改视频名称【控制台】

基本信息

Path： /videos/api/modify_video_name

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
video_id	number	必须		视频ID
name	string	必须		名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	必须

删除视频【控制台】

基本信息

Path： /videos/api/delete_video

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
video_id	number	必须		视频ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	必须

获取视频列表【控制台】

基本信息

Path： /videos/api/get_videos_list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否		页码，默认为1
size	否		页面大小，默认为15

返回数据

名称	类型	是否必须	备注	其他信息
errcode	number	非必须
total_num	number	非必须	视频总数
total_page	number	非必须	视频总页数
page_num	number	非必须	当前页码
page_size	number	非必须	页面大小
result	object []	非必须	视频列表	item 类型: object
├─ id	number	必须	视频ID
├─ name	string	必须	视频名称
├─ url	string	必须	视频文件地址
├─ size	number	必须	视频大小
├─ thumburl	string	必须	预览图
├─ duration	number	必须	视频时长
├─ status	number	必须	视频转码状态
├─ create_at	string	必须	创建时间
├─ sourcefrom	string	必须	视频来源
├─ hubuser_id	number	必须	上传用户ID
├─ act_id	number	必须	直播频道ID
├─ playset	object []	必须	拉流/下载地址列表	item 类型: object
├─ videoid	number	必须	视频ID
├─ resolution	string	必须	分辨率
├─ url	string	必须	拉流/下载地址

添加视频打点【控制台】

基本信息

Path： /videos/api/add_video_kfd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
video_id	number	必须	视频ID
offset	number	必须	打点下标，单位秒
content	string	必须	打点内容

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	必须

更改视频打点【控制台】

基本信息

Path： /videos/api/modify_video_kfd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
video_id	number	必须	视频ID
id	number	必须	打点ID
offset	number	必须	打点下标，单位秒
content	string	必须	打点内容

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	必须

删除视频打点【控制台】

基本信息

Path： /videos/api/delete_video_kfd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
video_id	number	必须		视频ID
id	number	必须		打点ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	必须

添加文档打点【控制台】

基本信息

Path： /videos/api/add_video_doc_kfd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
video_id	number	必须	视频ID
offset	number	必须	打点下标，单位秒
title	string	必须	打点备注
content	string	必须	打点内容(图片url)

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	必须
id	number	必须		打点ID

更改文档打点【控制台】

基本信息

Path： /videos/api/update_video_doc_kfd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
video_id	number	必须	视频ID
id	number	必须	打点ID
offset	number	必须	打点下标，单位秒
title	string	必须	打点备注
content	string	必须	打点内容(图片url)

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	非必须

删除文档打点【控制台】

基本信息

Path： /videos/api/delete_video_doc_kfd

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
video_id	number	非必须	视频ID
id_list	number []	非必须	打点ID列表	item 类型: number
├─		非必须	打点ID

返回数据

名称	类型	是否必须	备注	其他信息
errcode	number	非必须
error_id_list	number []	非必须	删除失败的打点ID列表	item 类型: number
├─		非必须	打点ID

获取直播录制配置【控制台】

基本信息

Path： /videos/api/get_transcribe

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
actid	是		频道Hash ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	非必须
transcribe	boolean	非必须		是否录制该频道直播

更改直播录制配置【控制台】

基本信息

Path： /videos/api/update_transcribe

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
actid	string	非必须		频道Hash ID
transcribe	boolean	非必须		是否录制该频道直播

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	必须

视频上传步骤一(获取上传地址)【控制台】

基本信息

Path： /activity/api/temp_upload_addrss

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	备注
errcode	number	非必须
msg	string	非必须
address	string	非必须	视频上传地址

视频上传步骤二(上传文件)【控制台】

基本信息

Path： /{address}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

路径参数

参数名称	示例	备注
address		步骤一获取的视频上传地址

Body

参数名称	参数类型	是否必须	示例	备注
file	file	是		视频文件
file_name	text	否		视频文件名，默认用 file 的文件名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	string	非必须		文件存储ID
url	string	非必须		文件存储URL

视频上传步骤三(同步视频ID到媒体库)【控制台】

基本信息

Path： /videos/api/upload_videos

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
storage_id	string	必须		步骤二获取的文件存储ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errcode	number	非必须

获取视频信息【观看页】

基本信息

Path： /videos/api/get_video_info

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是		视频ID

返回数据

名称	类型	是否必须	备注	其他信息
errcode	number	非必须
result	object	非必须
├─ id	number	非必须	视频ID
├─ name	string	非必须	视频名称
├─ url	string	非必须	视频文件地址
├─ size	number	非必须	视频文件大小
├─ thumburl	string	非必须	预览图
├─ duration	number	非必须	视频时长
├─ create_at	string	非必须	视频创建时间
├─ sourcefrom	string	非必须	视频来源
├─ hubuser_id	number	非必须	用户ID
├─ act_id	number	非必须	视频ID
├─ playset	object []	非必须	视频下载/拉流地址列表	item 类型: object
├─ videoid	number	必须	视频ID
├─ resolution	string	必须	分辨率
├─ url	string	必须	下载/拉流地址
├─ key_frame_desc	object []	非必须	视频打点列表	item 类型: object
├─ id	number	非必须	打点ID
├─ offset	number	非必须	打点下标，单位秒
├─ content	string	非必须	打点内容
├─ play_back_messages	object []	必须	文档打点列表	item 类型: object
├─ id	number	必须	文档打点ID
├─ offset	number	必须	打点下标，单位秒
├─ title	string	必须	打点备注
├─ content	string	必须	打点内容
├─ import_doc_kfd	number	非必须	是否导入直播时的文档