VOD Interface Documentation

Updated: 2022-05-23 17:54:01

Introduction

Title: VOD API Interface Documentation

Introduction: External API Interface Documentation for the VOD System

API Endpoint: /v2/api-docs

Upload Video API

Upload Video Interface

API Description: Video upload API (register video information and upload video via POST method)

API Endpoint: /vod/v1/video/upload/post

Request Method: post

consumes:["multipart/form-data"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
audioBitRate	Audio bitrate: Kbps	query	false	integer
audioChannelLayout	Audio channel layout: stereo	query	false	string
audioChannels	Number of audio channels: 2	query	false	integer
audioCodecName	Audio codec: aac	query	false	string
audioProfile	Audio profile: HE-AAC	query	false	string
audioSampleFmt	Audio sample format: fltp	query	false	string
audioSampleRate	Audio sample rate: 22050	query	false	integer
categoryId	Category ID	query	false	integer
coverBucketName	Bucket or group name for the cover image	query	false	string
coverFileName	Cover image file name	query	false	string
coverStorageSystem	Storage system used for the cover image	query	false	string
deptId	Department ID	query	false	integer
description	Video description	query	false	string
displayAspectRatio	Display aspect ratio: 16:9	query	false	string
duration	Playback duration: seconds	query	false	integer
extJson	Extended information, JSON format	query	false	string
file	Video file	formData	true	file
gmtCreate	Creation time	query	false	string
gmtModified	Last modification time	query	false	string
id	Primary key ID	query	false	integer
isAudio	Whether it is audio-only	query	false	boolean
isDeleted	Whether deleted: 0, 1	query	false	boolean
isEncrypted	Whether encryption is required	query	false	boolean
isScreen	Whether screen recording optimization is applied	query	false	boolean
isTranscoding	Whether transcoding is required	query	false	boolean
originalDefinition	Source resolution: 1280x720	query	false	string
originalHeight	Source video resolution: height	query	false	integer
originalWidth	Source video resolution: width	query	false	integer
sign	Signature verification parameter. Generation rule: Sort all other submitted parameters (excluding non-empty parameters) in alphabetical order by parameter name, then arrange them as "parameterparametervalueparametervalue", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase to obtain the sign value	query	true	string
sourceExtension	Source file extension	query	false	string
sourceFileName	Source file name	query	false	string
sourceFileSize	Source file size: Bytes	query	false	integer
sourceMd5sum	Source file MD5 checksum	query	false	string
status	Video status	query	false	string
tag1	Tag 1	query	false	string
tag2	Tag 2	query	false	string
tag3	Tag 3	query	false	string
timestamp	13-digit timestamp	query	true	string
title	Video title	query	false	string
transGroupId	Transcoding template group ID	query	false	integer
transGroupName	Transcoding template group name	query	false	string
uploadChannel	Upload channel	query	false	string
uploadClient	Upload client IP	query	false	string
uploadServer	Upload server	query	false	string
uploadTime	Upload time	query	false	string
userId	User ID	query	false	integer
vid	Video string ID	query	false	string
videoAvgFrameRate	Video average frame rate	query	false	string
videoBitRate	Video bitrate: Kbps	query	false	integer
videoCodecName	Video codec: h264	query	false	string
videoLevel	Video encoding level	query	false	integer
videoNbFrames	Total number of video frames	query	false	integer
videoProfile	Video encoding profile: high	query	false	string
videoRotate	Rotation angle	query	false	string

Response Data:

{
    "code": 0,
    "data": {
        "audioBitRate": 0,
        "audioChannelLayout": "",
        "audioChannels": 0,
        "audioCodecName": "",
        "audioProfile": "",
        "audioSampleFmt": "",
        "audioSampleRate": 0,
        "categoryId": 0,
        "coverBucketName": "",
        "coverFileName": "",
        "coverStorageSystem": "",
        "deptId": 0,
        "description": "",
        "displayAspectRatio": "",
        "duration": 0,
        "extJson": "",
        "gmtCreate": "",
        "gmtModified": "",
        "id": 0,
        "isAudio": true,
        "isDeleted": true,
        "isEncrypted": true,
        "isScreen": true,
        "isTranscoding": true,
        "originalDefinition": "",
        "originalHeight": 0,
        "originalWidth": 0,
        "sourceExtension": "",
        "sourceFileName": "",
        "sourceFileSize": 0,
        "sourceMd5sum": "",
        "status": "",
        "tag1": "",
        "tag2": "",
        "tag3": "",
        "title": "",
        "transGroupId": 0,
        "transGroupName": "",
        "uploadChannel": "",
        "uploadClient": "",
        "uploadServer": "",
        "uploadTime": "",
        "userId": 0,
        "vid": "",
        "videoAvgFrameRate": "",
        "videoBitRate": 0,
        "videoCodecName": "",
        "videoLevel": 0,
        "videoNbFrames": 0,
        "videoProfile": "",
        "videoRotate": ""
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	string	Video
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

Video

Parameter Name	Description	Type
audioBitRate	Audio bitrate: Kbps. Field: audio_bit_rate	int32
audioChannelLayout	Audio channel layout: stereo. Field: audio_channel_layout	string
audioChannels	Number of audio channels: 2. Field: audio_channels	int32
audioCodecName	Audio codec: aac. Field: audio_codec_name	string
audioProfile	Audio profile: HE-AAC. Field: audio_profile	string
audioSampleFmt	Audio sample format: fltp. Field: audio_sample_fmt	string
audioSampleRate	Audio sample rate: 22050. Field: audio_sample_rate	int32
categoryId	Category ID. Field: category_id	int64
coverBucketName	Bucket or group name for the cover image. Field: cover_bucket_name	string
coverFileName	Cover image file name. Field: cover_file_name	string
coverStorageSystem	Storage system used for the cover image. Field: cover_storage_system	string
deptId	Department ID. Field: dept_id	int64
description	Video description. Field: description	string
displayAspectRatio	Display aspect ratio: 16:9. Field: display_aspect_ratio	string
duration	Duration: seconds. Field: duration	int32
extJson	Extended information, JSON format. Field: ext_json	string
gmtCreate	Creation time. Field: gmt_create	date-time
gmtModified	Last modification time. Field: gmt_modified	date-time
id	Primary key ID. Field: id	int64
isAudio	Whether it is audio-only. Field: is_audio	boolean
isDeleted	Whether deleted: 0, 1. Field: is_deleted	boolean
isEncrypted	Whether encryption is required. Field: is_encrypted	boolean
isScreen	Whether screen recording optimization is applied. Field: is_screen	boolean
isTranscoding	Whether transcoding is required. Field: is_transcoding	boolean
originalDefinition	Source resolution: 1280x720. Field: original_definition	string
originalHeight	Source video height. Field: original_height	int32
originalWidth	Source video width. Field: original_width	int32
sourceExtension	Source file extension. Field: source_extension	string
sourceFileName	Source file name. Field: source_file_name	string
sourceFileSize	Source file size: Bytes. Field: source_file_size	int64
sourceMd5sum	Source file MD5 checksum. Field: source_md5sum	string
status	Video status. Field: status	string
tag1	Tag 1. Field: tag1	string
tag2	Tag 2. Field: tag2	string
tag3	Tag 3. Field: tag3	string
title	Video title. Field: title	string
transGroupId	Transcoding template group ID. Field: trans_group_id	int64
transGroupName	Transcoding template group name. Field: trans_group_name	string
uploadChannel	Upload channel. Field: upload_channel	string
uploadClient	Upload client IP. Field: upload_client	string
uploadServer	Upload server. Field: upload_server	string
uploadTime	Upload time. Field: upload_time	date-time
userId	User ID. Field: user_id	int64
vid	Video string ID. Field: vid	string
videoAvgFrameRate	Average video frame rate, e.g., "30000/1001". Field: video_avg_frame_rate	string
videoBitRate	Video bitrate: Kbps. Field: video_bit_rate	int32
videoCodecName	Video codec: h264. Field: video_codec_name	string
videoLevel	Video encoding level: 31. Field: video_level	int32
videoNbFrames	Total number of video frames. Field: video_nb_frames	int32
videoProfile	Video encoding profile: high. Field: video_profile	string
videoRotate	Rotation angle. Field: video_rotate	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«Video»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Add Sub-account API

API Description: Add Sub-Account

API Endpoint: /vod/v1/account/add

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
email	Sub-account email	query	true	string
name	Sub-account name	query	true	string
password	Sub-account password	query	true	string
roleId	Role ID	query	true	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", add the secretKey at the beginning and end, and finally perform MD5 encryption and convert to uppercase to obtain the sign value	query	true	string
status	Status (Y/N)	query	true	string
timestamp	13-digit timestamp	query	true	string
viewAllVideosEnabled	Permission to view all videos (Y/N)	query	true	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Delete Sub-account Interface

Interface Description: Delete Sub-account

API Endpoint: /vod/v1/account/delete

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
childUserId	Sub-account ID to be deleted	body	false	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Next, prepend and append the secretKey, and finally perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code	int32
data	Successfully returned data	object
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Get Sub-Account Information by Sub-Account ID Interface

API Description: Retrieve sub-account information by sub-account ID.

API Endpoint: /vod/v1/account/get

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
childUserId	Sub-account ID	query	true	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request (excluding non-empty parameters) in alphabetical order by the first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. This is the value of sign.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "childEmail": "",
        "childUserId": 0,
        "childUsername": "",
        "createdTime": "",
        "lastModified": "",
        "roleId": 0,
        "roleName": "",
        "status": "",
        "userId": 0,
        "viewAllVideosEnabled": ""
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Data returned on success	string	UserChildrenDTO
message	Error message	string
status	Request status: success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

UserChildrenDTO

Parameter Name	Description	Type
childEmail	Sub-account email	string
childUserId	Sub-account user ID	int64
childUsername	Sub-account name	string
createdTime	Creation time	date-time
lastModified	Last modified time	date-time
roleId	Role ID	int64
roleName	Role name	string
status	Account status (Y/N)	string
userId	Primary account user ID	int64
viewAllVideosEnabled	Show all videos (Y/N)	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«UserChildrenDTO»
401	Unauthorized
403	Forbidden
404	Not Found

Paginated API for Retrieving Sub-Account List

API Description: Retrieve a paginated list of sub-accounts.

API Endpoint: /vod/v1/account/list

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
page	Page number	query	false	integer
pageSize	Page size	query	false	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request (excluding non-empty parameters) in alphabetical order by the first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase to obtain the sign value	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "contents": [
            {
                "childEmail": "",
                "childUserId": 0,
                "childUsername": "",
                "createdTime": "",
                "lastModified": "",
                "roleId": 0,
                "roleName": "",
                "status": "",
                "userId": 0,
                "viewAllVideosEnabled": ""
            }
        ],
        "endRow": 0,
        "firstPage": true,
        "lastPage": true,
        "limit": 0,
        "nextPageNumber": 0,
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "prePageNumber": 0,
        "startRow": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	string	Paginator«UserChildrenDTO»
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

Paginator«UserChildrenDTO»

Parameter Name	Description	Type	Schema
contents	Content of the current page.	array	UserChildrenDTO
endRow	End row.	int32
firstPage	Whether it is the first page.	boolean
lastPage	Whether it is the last page.	boolean
limit	Database limit.	int32
nextPageNumber	Page number of the next page.	int32
offset	Database offset.	int32
pageNumber	Current page number.	int32
pageSize	Maximum records per page.	int32
prePageNumber	Page number of the previous page.	int32
startRow	Start row.	int32
totalItems	Total number of records.	int32
totalPages	Total number of pages.	int32

UserChildrenDTO

Parameter Name	Description	Type
childEmail	Sub-account email	string
childUserId	Sub-account user ID	int64
childUsername	Sub-account name	string
createdTime	Creation time	date-time
lastModified	Update time	date-time
roleId	Role ID	int64
roleName	Role name	string
status	Account status (Y/N)	string
userId	Primary account user ID	int64
viewAllVideosEnabled	Show all videos (Y/N)	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«Paginator«UserChildrenDTO»»
401	Unauthorized
403	Forbidden
404	Not Found

Get Role List API

Interface Description: Get the role list

API Endpoint: /vod/v1/account/role/list

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". After that, prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the value of sign.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": [
        {
            "id": 0,
            "name": ""
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Data returned on success.	array	Role object
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

Role Object

Parameter Name	Description	Type	Schema
id	Role ID	int64
name	Role Name	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«角色对象»»
401	Unauthorized
403	Forbidden
404	Not Found

Update Sub-Account Information Interface

API Description: Update sub-account information

API Endpoint: /vod/v1/account/update

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
childUserId	Sub-account user ID	body	true	integer
isChangePassword	Whether to change password	body	true	string
name	Sub-account name	body	true	string
password	Password	body	false	string
roleId	Role ID	body	false	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase to obtain the sign value.	query	true	string
status	Status (Y/N)	body	false	string
timestamp	13-digit timestamp	query	true	string
viewAllVideosEnabled	Whether to have permission to view all videos (Y/N)	body	false	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Subtitle Upload Interface

Delete Subtitles

API Description: Delete subtitle API

API Endpoint: /vod/v1/video/srt/delete

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
id	Subtitle ID	query	true	string
sign	Parameter for signature verification. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". After that, prepend and append the secretKey, and finally perform MD5 encryption and convert to uppercase to obtain the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string
videoId	Video ID	query	true	integer

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Modify Subtitle Name Interface

API Description: Modify subtitle name API

API Endpoint: /vod/v1/video/srt/edit

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
id	Subtitle ID	query	true	string
name	Subtitle Name	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameterparameterValueparameterparameterValue". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string
videoId	Video ID	query	true	integer

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Get Subtitle List Interface

API Description: Get subtitle list API

API Endpoint: /vod/v1/video/srt/list

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string
videoId	Video ID	query	true	integer

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
401	Unauthorized
403	Forbidden
404	Not Found

Subtitle Upload Interface

API Description: Subtitle Upload API

API Endpoint: /vod/v1/video/srt/upload

Request Method: post

consumes:["multipart/form-data"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
file	File	formData	true	file
name	Subtitle name	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameterparametervalueparameterparametervalue". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string
videoId	Video ID	query	true	integer

Response Data:

{
    "code": 0,
    "data": [
        {
            "id": "",
            "name": "",
            "url": ""
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	array	SrtDTO
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

SrtDTO

Parameter Name	Description	Type
id	Subtitle ID	string
name	Subtitle Name	string
url	Subtitle URL	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«SrtDTO»»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Advertising Management API

Delete Ad Interface

Interface Description: Delete Ad Interface

API Endpoint: /vod/v1/advert/delete

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
adid	Ad ID	query	true	string
appId	Application ID	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Get Ad Detail API

API Description: Get ad details endpoint

API Endpoint: /vod/v1/advert/detail

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
adid	Ad ID	query	true	string
appId	Application ID	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "addrurl": "",
        "adid": "",
        "cataids": "",
        "createdtime": "",
        "height": 0,
        "location": "",
        "matterurl": "",
        "poplocation": 0,
        "popuptime": "",
        "size": 0,
        "skipenabled": "",
        "skiptime": 0,
        "status": 0,
        "title": "",
        "width": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	string	AdvertDTO
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

AdvertDTO

Parameter Name	Description	Type
addrurl	Link URL: The target address the ad should redirect to	string
adid	Primary key ID	string
cataids	Video category IDs. Multiple IDs separated by commas	string
createdtime	Creation time	date-time
height	Native video height	int32
location	Ad placement: Position where the ad is displayed, 1: Pre-roll, 2: Pause, 3: Post-roll	string
matterurl	Ad material: The ad display material, can be uploaded or an external link, supports images	string
poplocation	Display position	int32
popuptime	Display time	string
size	Material size: Customizable ad display duration	int64
skipenabled	Whether to enable skipping pre-roll ads (Y/N)	string
skiptime	Time allowed to skip the ad, in seconds	int32
status	Status: Online 10, Pending 1, Offline 0, Deleted -1	int32
title	Ad name: The title of the ad	string
width	Native video width	int32

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«AdvertDTO»
401	Unauthorized
403	Forbidden
404	Not Found

Query Ad Interface

API Description: Query Ad Interface

API Endpoint: /vod/v1/advert/list

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
page	Page number (default is first page)	query	false	integer
pageSize	Number of items per page (default is displayed)	query	false	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. This yields the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string
title	Advertisement name (fuzzy search)	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "contents": [
            {
                "addrurl": "",
                "adid": "",
                "cataids": "",
                "createdtime": "",
                "height": 0,
                "location": "",
                "matterurl": "",
                "poplocation": 0,
                "popuptime": "",
                "size": 0,
                "skipenabled": "",
                "skiptime": 0,
                "status": 0,
                "title": "",
                "width": 0
            }
        ],
        "endRow": 0,
        "firstPage": true,
        "hasNextPage": true,
        "hasPreviousPage": true,
        "lastPage": true,
        "limit": 0,
        "nextPageNumber": 0,
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "previousPageNumber": 0,
        "startRow": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Data returned on success.	string	Page«AdvertDTO»
message	Error message.	string
status	Request status: success: "success", fail: "fail", error: "error".	string

Schema Attribute Description

Page«AdvertDTO»

Parameter Name	Description	Type	Schema
contents	Content of the current page.	array	AdvertDTO
endRow		int64
firstPage		boolean
hasNextPage		boolean
hasPreviousPage		boolean
lastPage		boolean
limit		int64
nextPageNumber		int32
offset		int64
pageNumber	Current page.	int32
pageSize	Maximum number of records per page.	int32
previousPageNumber		int32
startRow		int64
totalItems	Total number of records.	int64
totalPages		int32

AdvertDTO

Parameter Name	Description	Type
addrurl	Link URL: The target address the ad should redirect to	string
adid	Primary key ID	string
cataids	Video category IDs. Multiple IDs separated by commas	string
createdtime	Creation time	date-time
height	Native video height	int32
location	Ad placement: Position where the ad is displayed, 1: Pre-roll, 2: Pause, 3: Post-roll	string
matterurl	Ad material: Ad display material, can be uploaded or external link, supports images	string
poplocation	Display position	int32
popuptime	Display time	string
size	Material size: Customizable ad display duration	int64
skipenabled	Whether to enable skipping pre-roll ads (Y/N)	string
skiptime	Time allowed to skip the ad, in seconds	int32
status	Status: Online 10, Pending 1, Offline 0, Deleted -1	int32
title	Ad name: Title of the ad	string
width	Native video width	int32

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«Page«AdvertDTO»»
401	Unauthorized
403	Forbidden
404	Not Found

Add or Modify Ad Interface

API Description: Add or modify advertisement interface

API Endpoint: /vod/v1/advert/save

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
addrurl	Link address: the target URL the ad should redirect to	query	false	string
adid	Primary key ID	query	false	string
appId	Application ID	query	true	string
cataids	Video category IDs. Multiple IDs separated by commas	query	false	string
height	Native video height	query	false	integer
location	Ad placement: position where the ad is displayed, e.g., pre-roll, pause, post-roll	query	false	string
matterurl	Ad material: the creative displayed in the ad, can be uploaded or linked externally, supports images	query	false	string
sign	Signature verification parameter. Generation rule: sort all other parameters (excluding non-empty parameters) submitted in the request interface in lexicographical order by first letter, then arrange them in the format "parameterparametervalueparameterparametervalue", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase to obtain the sign value	query	true	string
size	Material size: custom size for ad display	query	false	integer
skipenabled	Whether to enable skipping the pre-roll ad	query	false	string
skiptime	Time allowed to skip the ad, in seconds	query	false	integer
status	Online: 10, Pending: 1, Offline: 0, Deleted: -1	query	false	integer
timestamp	13-digit timestamp	query	true	string
title	Ad name: the title of the ad	query	false	string
width	Native video width	query	false	integer

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code	int32
data	Success response data	object
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Add Subcategory Interface

API Description: Add Subcategory

API Endpoint: /vod/v1/category/create-child

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
name	New category name	query	true	string
parentId	Parent category ID	query	true	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. This yields the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "css": "",
        "gmtCreate": "",
        "gmtModified": "",
        "icon": "",
        "id": 0,
        "isDeleted": true,
        "name": "",
        "ordered": 0,
        "path": "",
        "playerId": 0,
        "playerName": "",
        "transGroupId": 0,
        "transGroupName": "",
        "userId": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	string	Category
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

Category

Parameter Name	Description	Type
css	CSS class name for display. Field: `css`	string
gmtCreate	Creation time. Field: `gmt_create`	date-time
gmtModified	Last modification time. Field: `gmt_modified`	date-time
icon	Category icon. Field: `icon`	string
id	Primary key ID. Field: `id`	int64
isDeleted	Whether deleted: 0 or 1. Field: `is_deleted`	boolean
name	Category name. Field: `name`	string
ordered	Sorting order within the same level, ascending. Field: `ordered`	int32
path	Category ID path. Field: `path`	string
playerId	Player ID. Field: `player_id`	int64
playerName	Player name. Field: `player_name`	string
transGroupId	Transcoding template group ID. Field: `trans_group_id`	int64
transGroupName	Transcoding template group name. Field: `trans_group_name`	string
userId	User ID. Field: `user_id`	int64

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«Category»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Delete Specified Category Interface

API Description: Delete the specified category

API Endpoint: /vod/v1/category/delete

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
categoryId	Category ID	query	true	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, and finally perform MD5 encryption and convert to uppercase to obtain the sign value	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Get Video Category Interface

API Description: Get video category API

API Endpoint: /vod/v1/category/list

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
cataId	Category ID to search for; if not submitted, retrieves all categories	query	false	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request (excluding non-empty parameters) alphabetically by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Prepend and append the secretKey, then perform MD5 encryption and convert to uppercase to obtain the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": [
        {
            "cataId": 0,
            "cataName": "",
            "children": {
                "childrenList": [
                    {}
                ],
                "subTotal": 0
            },
            "level": 0,
            "parentId": 0
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	array	CataNode
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

CataNode

Parameter Name	Type	Schema
cataId	int64
cataName	string
children	string	CataChildren
level	int32
parentId	int64

CataChildren

Parameter Name	Description	Type	Schema
childrenList		array	CataNode
subTotal		int32

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«CataNode»»
401	Unauthorized
403	Forbidden
404	Not Found

Modify Category Interface

API Description: Modify Category

API Endpoint: /vod/v1/category/update

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
categoryId	Category ID	query	true	integer
name	Modified category name	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. This yields the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Batch Delete Videos

API Description: Batch Delete Video API

API Endpoint: /vod/v1/video/delete

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. This yields the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string
videoIds	Video ID list (multiple video IDs separated by English commas)	query	false	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Get Video Information by Video VID

API Description: Retrieve video information based on the video vid.

API Endpoint: /vod/v1/video/get-videos-info

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
filters	Information to retrieve. If not submitted, all information is retrieved. Values: basicInfo (basic information), metaData (source video information), transcodeInfo (transcoding information), snapshotInfo (screenshot information)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string
vids	Video IDs to query. Multiple IDs (separated by commas)	query	false	string

Response Data:

{
    "code": 0,
    "data": [
        {
            "basicInfo": {
                "cateId": 0,
                "cateName": "",
                "coverUrl": "",
                "createdTime": 0,
                "description": "",
                "duration": 0,
                "size": 0,
                "status": "",
                "statusText": "",
                "tags": "",
                "title": "",
                "updateTime": 0,
                "uploader": "",
                "vid": ""
            },
            "metaData": {
                "bitrate": 0,
                "codec": "",
                "duration": 0,
                "format": "",
                "fps": "",
                "height": 0,
                "size": 0,
                "width": 0
            },
            "snapshotInfo": [],
            "transcodeInfo": [
                {
                    "bitrate": 0,
                    "definition": "",
                    "definitionText": "",
                    "duration": 0,
                    "encrypt": true,
                    "encryptType": "",
                    "format": "",
                    "height": 0,
                    "playUrl": "",
                    "size": 0,
                    "status": "",
                    "width": 0
                }
            ],
            "vid": ""
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	array	VideoDetailInfoModel
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

VideoDetailInfoModel

Parameter Name	Description	Type	Schema
basicInfo	Video information	string	VideoBasicInfo
metaData	Video metadata	string	VideoMetaData
snapshotInfo	List of video snapshots	array
transcodeInfo	List of video transcoding information	array	VideoTranscodeInfo
vid	Video VID	string

VideoBasicInfo

Parameter Name	Description	Type
cateId	Category ID	int64
cateName	Category Name	string
coverUrl	Cover Image URL	string
createdTime	Creation Time (13-digit timestamp)	int64
description		string
duration	Video Duration (in seconds)	float
size	Source File Size (in Bytes)	int64
status	Video Status. Possible values: CREATED (Created), UPLOADING (Uploading), UPLOAD_FAIL (Upload Failed), UPLOAD_SUCCESS (Upload Successful), TRANSCODING (Transcoding), TRANSCODE_FAIL (Transcoding Failed), CHECKING (Reviewing), BLOCKED (Blocked), NORMAL (Normal)	string
statusText	Chinese Description of Video Status	string
tags	Video Tags (multiple tags separated by commas ",")	string
title	Video Title	string
updateTime	Modification Time (13-digit timestamp)	int64
uploader	Uploader Account	string
vid	Video ID	string

VideoMetaData

Parameter	Description	Type
bitrate	Video bitrate, in bps	int32
codec	Encoding format, e.g., h264, h265	string
duration	Video duration, in seconds	float
format	Video format, e.g., mp4, flv	string
fps	Video frame rate, format: 25/1	string
height	Video resolution height, in px	int32
size	Source file size, in Bytes	int64
width	Video resolution width, in px	int32

VideoTranscodeInfo

Parameter Name	Description	Type
bitrate	Video bitrate, in bps	int32
definition	Video definition, values: SOURCE (original file), LD (smooth), SD (standard), HD (high definition), FHD (full high definition), OD (original), 4K (4K), SQ (standard audio quality), HQ (high audio quality)	string
definitionText	Chinese description of video definition	string
duration	Video duration, in seconds	int64
encrypt	Whether encrypted	boolean
encryptType	Encryption type	string
format	Video format	string
height	Video resolution height, in px	int32
playUrl	Video stream playback URL	string
size	Source file size	int64
status	Video stream status, values: normal (normal), unavailable (unavailable)	string
width	Video resolution width, in px	int32

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«VideoDetailInfoModel»»
401	Unauthorized
403	Forbidden
404	Not Found

Search Video API

API Description: Search Video API
Search for videos based on conditions and retrieve a paginated list containing basic video information.

API Endpoint: /vod/v1/video/search-videos

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
categoryIdList	Category IDs of the video, multiple IDs separated by commas	query	false	integer
endTime	End time. Format: yyyy-MM-dd	query	false	string
includingDeleted	Whether to include deleted videos	query	false	boolean
keyword	Search keyword	query	false	string
order	Sorting condition, value: create_asc	query	false	string
page	Pagination: current page number	query	false	integer
pageSize	Pagination: maximum records per page, default is 25	query	false	integer
sign	Signature verification parameter. Generation rule: sort all other submitted parameters (excluding non-empty parameters) alphabetically by first letter, then arrange them as "parameter name parameter value parameter name parameter value", prepend and append secretKey, then perform MD5 encryption and convert to uppercase to get the sign value	query	true	string
startTime	Start time. Format: yyyy-MM-dd	query	false	string
status	Video status. Refer to values:	query	false	string
timestamp	13-digit timestamp	query	true	string
uploadServer	Uploader email account	query	false	string
vid	Video VID	query	false	string

Response Data:

{
    "code": 0,
    "data": {
        "contents": [
            {
                "cateId": 0,
                "cateName": "",
                "coverUrl": "",
                "createdTime": 0,
                "description": "",
                "duration": 0,
                "size": 0,
                "status": "",
                "statusText": "",
                "tags": "",
                "title": "",
                "updateTime": 0,
                "uploader": "",
                "vid": ""
            }
        ],
        "endRow": 0,
        "firstPage": true,
        "hasNextPage": true,
        "hasPreviousPage": true,
        "lastPage": true,
        "limit": 0,
        "nextPageNumber": 0,
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "previousPageNumber": 0,
        "startRow": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Data returned on success.	string	Page«VideoBasicInfo»
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

Page«VideoBasicInfo»

Parameter Name	Description	Type	Schema
contents	Content of the current page.	array	VideoBasicInfo
endRow		int64
firstPage		boolean
hasNextPage		boolean
hasPreviousPage		boolean
lastPage		boolean
limit		int64
nextPageNumber		int32
offset		int64
pageNumber	Current page.	int32
pageSize	Maximum number of records displayed per page.	int32
previousPageNumber		int32
startRow		int64
totalItems	Total number of records.	int64
totalPages		int32

VideoBasicInfo

Parameter Name	Description	Type
cateId	Category ID	int64
cateName	Category name	string
coverUrl	Cover image URL	string
createdTime	Creation time (13-digit timestamp)	int64
description		string
duration	Video duration in seconds	float
size	Source file size in Bytes	int64
status	Video status. Possible values: CREATED (created), UPLOADING (uploading), UPLOAD_FAIL (upload failed), UPLOAD_SUCCESS (upload succeeded), TRANSCODING (transcoding), TRANSCODE_FAIL (transcoding failed), CHECKING (under review), BLOCKED (blocked), NORMAL (normal)	string
statusText	Chinese description of the video status	string
tags	Video tags, multiple tags separated by commas ","	string
title	Video title	string
updateTime	Modification time (13-digit timestamp)	int64
uploader	Uploader account	string
vid	Video VID	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«Page«VideoBasicInfo»»
401	Unauthorized
403	Forbidden
404	Not Found

Update Basic Video Information

API Description: Video Basic Information Update Interface

API Endpoint: /vod/v1/video/update

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
categoryId	categoryId	query	false	integer
description	description	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", add the secretKey at the beginning and end, and finally perform MD5 encryption and convert to uppercase to obtain the sign value	query	true	string
tag1	tag1	query	false	string
tag2	tag2	query	false	string
tag3	tag3	query	false	string
timestamp	13-digit timestamp	query	true	string
title	title	query	false	string
vid	Video ID	query	true	string

Response Data:

{
    "code": 0,
    "data": true,
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code	int32
data	Successfully returned data	boolean
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Upload Video Cover Image

Interface Description: Upload video cover image

API Endpoint: /vod/v1/video/upload/cover-image

Request Method: post

consumes:["multipart/form-data"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
file	File	formData	false	file
isDefault	Set as default image (Y: Yes)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in lexicographical order by first letter, then arrange them in the format "parameterparametervalueparametervalue", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. This value is the sign.	query	true	string
timestamp	13-digit timestamp	query	true	string
videoId	Video ID	query	false	integer

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Get Domain Statistics Interface

API Description: Retrieve domain statistics.

Endpoint: /vod/v1/statistic/domain

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, and finally perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": [
        {
            "createdTime": "",
            "currentDay": "",
            "currentMonth": "",
            "currentWeek": "",
            "domain": "",
            "lastModified": "",
            "mobileFlowSize": 0,
            "mobilePlayDuration": 0,
            "mobileUniqueViewer": 0,
            "mobileVideoView": 0,
            "pcFlowSize": 0,
            "pcPlayDuration": 0,
            "pcUniqueViewer": 0,
            "pcVideoView": 0,
            "userId": ""
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	array	DomainDailyStats
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

DomainDailyStats

Parameter Name	Description	Type
createdTime	Creation time	date-time
currentDay	Current day	string
currentMonth	Current week	string
currentWeek	Current week	string
domain	Domain name	string
lastModified	Last modified time	date-time
mobileFlowSize	Mobile traffic	int64
mobilePlayDuration	Mobile watch duration	int64
mobileUniqueViewer	Mobile unique viewers	int32
mobileVideoView	Mobile video views	int32
pcFlowSize	PC traffic	int64
pcPlayDuration	PC watch duration	int64
pcUniqueViewer	PC unique viewers	int32
pcVideoView	PC video views	int32
userId	User ID	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«DomainDailyStats»»
401	Unauthorized
403	Forbidden
404	Not Found

Export Domain Statistics API

API Description: Export domain statistics API.

API Endpoint: /vod/v1/statistic/domain/export

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

Response Parameter Description:

None

Response Status Code Description:

Status Code	Description	Schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Query Playback Duration Statistics API

API Description: Query playback duration statistics API.

API Endpoint: /vod/v1/statistic/playduration

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string
vid	Video ID	query	false	string

Response Data:

{
    "code": 0,
    "data": [
        {
            "currentDay": "",
            "mobilePerAveragePlayDuration": 0,
            "mobilePlayDuration": 0,
            "mobileVideoAveragePlayDuration": 0,
            "pcPerAveragePlayDuration": 0,
            "pcPlayDuration": 0,
            "pcVideoAveragePlayDuration": 0
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	array	PlayDurationStatsModel
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

PlayDurationStatsModel

Parameter Name	Description	Type
currentDay	Current day	string
mobilePerAveragePlayDuration	Average play duration per user on mobile	int64
mobilePlayDuration	Play duration on mobile	int64
mobileVideoAveragePlayDuration	Average video play duration on mobile	int64
pcPerAveragePlayDuration	Average play duration per user on PC	int64
pcPlayDuration	Play duration on PC	int64
pcVideoAveragePlayDuration	Average video play duration on PC	int64

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«PlayDurationStatsModel»»
401	Unauthorized
403	Forbidden
404	Not Found

Export Playback Duration Statistics Interface

API Description: Export playback duration statistics API.

API Endpoint: /vod/v1/statistic/playduration/export

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string
vid	Video ID	query	false	string

Response Data:

Response Parameter Description:

None

Response Status Code Description:

Status Code	Description	Schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Playlist Interface

API Description: Play count list API.

API Endpoint: /vod/v1/statistic/visitor

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string
vid	Video ID	query	false	string

Response Data:

{
    "code": 0,
    "data": [
        {
            "createdTime": "",
            "currentDay": "",
            "currentMonth": "",
            "currentWeek": "",
            "lastModified": "",
            "mobileFlowSize": 0,
            "mobilePlayDuration": 0,
            "mobileUniqueViewer": 0,
            "mobileVideoView": 0,
            "pcFlowSize": 0,
            "pcPlayDuration": 0,
            "pcUniqueViewer": 0,
            "pcVideoView": 0,
            "percent10": 0,
            "percent100": 0,
            "percent20": 0,
            "percent30": 0,
            "percent40": 0,
            "percent50": 0,
            "percent60": 0,
            "percent70": 0,
            "percent80": 0,
            "percent90": 0,
            "userId": ""
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	array	UserDailyStats
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

UserDailyStats

Parameter Name	Description	Type
createdTime	Creation time	date-time
currentDay	Current day	string
currentMonth	Current month	string
currentWeek	Current week	string
lastModified	Last modified time	date-time
mobileFlowSize	Mobile traffic	int64
mobilePlayDuration	Mobile play duration	int64
mobileUniqueViewer	Mobile unique viewers	int32
mobileVideoView	Mobile video views	int32
pcFlowSize	PC traffic	int64
pcPlayDuration	PC play duration	int64
pcUniqueViewer	PC unique viewers	int32
pcVideoView	PC video views	int32
percent10	Percentage watched at 10%	int32
percent100	Percentage watched at 100%	int32
percent20	Percentage watched at 20%	int32
percent30	Percentage watched at 30%	int32
percent40	Percentage watched at 40%	int32
percent50	Percentage watched at 50%	int32
percent60	Percentage watched at 60%	int32
percent70	Percentage watched at 70%	int32
percent80	Percentage watched at 80%	int32
percent90	Percentage watched at 90%	int32
userId	User ID	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«UserDailyStats»»
401	Unauthorized
403	Forbidden
404	Not Found

Export Play Count API

API Description: Export playback volume API.

API Endpoint: /vod/v1/statistic/visitor/export

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string
vid	Video ID	query	false	string

Response Data:

Response Parameter Description:

None

Response Status Code Description:

Status Code	Description	Schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Play Count Ranking API

API Description: Play count ranking interface (top 100).

API Endpoint: /vod/v1/statistic/visitor/rank/top

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "totalVideoView": 0,
        "videoViewModels": [
            {
                "duration": 0,
                "imageUrl": "",
                "title": "",
                "videoId": "",
                "videoView": 0
            }
        ]
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	string	VideoViewTopModel
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

VideoViewTopModel

Parameter Name	Description	Type	Schema
totalVideoView	Total views	int32
videoViewModels	Playlist ranking	array	VideoViewModelBean

VideoViewModelBean

Parameter Name	Description	Type
duration	Duration	int32
imageUrl	Thumbnail	string
title	Title	string
videoId	Video ID	string
videoView	View count	int32

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«VideoViewTopModel»
401	Unauthorized
403	Forbidden
404	Not Found

Export Summary Play Count Ranking Interface

API Description: Export the aggregated playback volume ranking interface (top 100).

API Endpoint: /vod/v1/statistic/visitor/rank/top/export

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them as "parameter name parameter value parameter name parameter value", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

Response Parameter Description:

None

Response Status Code Description:

Status Code	Description	Schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Data Aggregation Interface

API Description: Data aggregation API.

API Endpoint: /vod/v1/statistic/overview

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string
vid	Video ID	query	false	string

Response Data:

{
    "code": 0,
    "data": {
        "mobileFlowSize": 0,
        "mobilePlayDuration": 0,
        "mobileUniqueViewer": 0,
        "mobileVideoView": 0,
        "pcFlowSize": 0,
        "pcPlayDuration": 0,
        "pcUniqueViewer": 0,
        "pcVideoView": 0,
        "userId": ""
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	string	StatsSummary
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

StatsSummary

Parameter Name	Description	Type
mobileFlowSize	Mobile traffic	int64
mobilePlayDuration	Mobile play minutes	int64
mobileUniqueViewer	Mobile unique viewers	int32
mobileVideoView	Mobile video views	int32
pcFlowSize	PC traffic	int64
pcPlayDuration	PC play minutes	int64
pcUniqueViewer	PC unique viewers	int32
pcVideoView	PC video views	int32
userId	User ID	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«StatsSummary»
401	Unauthorized
403	Forbidden
404	Not Found

Overview Data Summary Interface

API Description: Overview data summary API.

API Endpoint: /vod/v1/statistic/overview/summary

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. This is the value of sign.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "totalPlayDuration": 0,
        "totalSpace": 0,
        "totalVideo": 0,
        "totalVideoView": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	string	StatsTotalSummary
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

StatsTotalSummary

Parameter Name	Description	Type
totalPlayDuration	Total play duration	int64
totalSpace	Space size (unit: byte)	int64
totalVideo	Total number of videos	int32
totalVideoView	Total number of views	int32

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«StatsTotalSummary»
401	Unauthorized
403	Forbidden
404	Not Found

Get Terminal Device Statistics API

API Description: Terminal device statistics API.

API Endpoint: /vod/v1/statistic/device

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "end": "",
        "start": "",
        "stats": {
            "createdTime": "",
            "currentDay": "",
            "currentMonth": "",
            "currentWeek": "",
            "lastModified": "",
            "mobileFlowSize": 0,
            "mobilePlayDuration": 0,
            "mobileUniqueViewer": 0,
            "mobileVideoView": 0,
            "pcFlowSize": 0,
            "pcPlayDuration": 0,
            "pcUniqueViewer": 0,
            "pcVideoView": 0,
            "percent10": 0,
            "percent100": 0,
            "percent20": 0,
            "percent30": 0,
            "percent40": 0,
            "percent50": 0,
            "percent60": 0,
            "percent70": 0,
            "percent80": 0,
            "percent90": 0,
            "userId": ""
        },
        "totalVideoView": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	string	StatsSummaryModel«UserDailyStats»
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

StatsSummaryModel«UserDailyStats»

Parameter Name	Description	Type	Schema
end	End time	string
start	Start time	string
stats	Playlist ranking	string	UserDailyStats
totalVideoView	Total video views	int32

UserDailyStats

Parameter Name	Description	Type
createdTime	Creation time	date-time
currentDay	Current day	string
currentMonth	Current month	string
currentWeek	Current week	string
lastModified	Last modified time	date-time
mobileFlowSize	Mobile traffic	int64
mobilePlayDuration	Mobile play duration	int64
mobileUniqueViewer	Mobile unique viewers	int32
mobileVideoView	Mobile video views	int32
pcFlowSize	PC traffic	int64
pcPlayDuration	PC play duration	int64
pcUniqueViewer	PC unique viewers	int32
pcVideoView	PC video views	int32
percent10	Percentage watched at 10%	int32
percent100	Percentage watched at 100%	int32
percent20	Percentage watched at 20%	int32
percent30	Percentage watched at 30%	int32
percent40	Percentage watched at 40%	int32
percent50	Percentage watched at 50%	int32
percent60	Percentage watched at 60%	int32
percent70	Percentage watched at 70%	int32
percent80	Percentage watched at 80%	int32
percent90	Percentage watched at 90%	int32
userId	User ID	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«StatsSummaryModel«UserDailyStats»»
401	Unauthorized
403	Forbidden
404	Not Found

Browser Statistics API

API Description: Browser statistics API.

API Endpoint: /vod/v1/statistic/device/browser

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "end": "",
        "start": "",
        "stats": [
            {
                "browser": "",
                "createdTime": "",
                "currentDay": "",
                "currentMonth": "",
                "currentWeek": "",
                "lastModified": "",
                "mobileFlowSize": 0,
                "mobilePlayDuration": 0,
                "mobileUniqueViewer": 0,
                "mobileVideoView": 0,
                "pcFlowSize": 0,
                "pcPlayDuration": 0,
                "pcUniqueViewer": 0,
                "pcVideoView": 0,
                "userId": ""
            }
        ],
        "totalVideoView": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	string	StatsSummaryModel«List«BrowserDailyStats»»
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

StatsSummaryModel«List«BrowserDailyStats»»

Parameter Name	Description	Type	Schema
end	End time	string
start	Start time	string
stats	Playlist ranking	array	BrowserDailyStats
totalVideoView	Total video views	int32

BrowserDailyStats

Parameter Name	Description	Type
browser	Browser	string
createdTime	Creation Time	date-time
currentDay	Current Day	string
currentMonth	Current Month	string
currentWeek	Current Week	string
lastModified	Last Modified Time	date-time
mobileFlowSize	Mobile Traffic	int64
mobilePlayDuration	Mobile Play Duration	int64
mobileUniqueViewer	Mobile Unique Viewers	int32
mobileVideoView	Mobile Video Views	int32
pcFlowSize	PC Traffic	int64
pcPlayDuration	PC Play Duration	int64
pcUniqueViewer	PC Unique Viewers	int32
pcVideoView	PC Video Views	int32
userId	User ID	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«StatsSummaryModel«List«BrowserDailyStats»»»
401	Unauthorized
403	Forbidden
404	Not Found

Export Browser Statistics Interface

Interface Description: Export browser statistics interface.

API Endpoint: /vod/v1/statistic/device/browser/export

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

Response Parameter Description:

None

Response Status Code Description:

Status Code	Description	Schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Export Terminal Device Statistics Interface

Interface Description: Export terminal device statistics interface.

API Endpoint: /vod/v1/statistic/device/export

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameterparametervalueparametervalue", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

Response Parameter Description:

None

Response Status Code Description:

Status Code	Description	Schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Operating System Statistics

Interface Description: Operating system statistics data.

API Endpoint: /vod/v1/statistic/device/os

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "end": "",
        "start": "",
        "stats": [
            {
                "createdTime": "",
                "currentDay": "",
                "currentMonth": "",
                "currentWeek": "",
                "lastModified": "",
                "mobileFlowSize": 0,
                "mobilePlayDuration": 0,
                "mobileUniqueViewer": 0,
                "mobileVideoView": 0,
                "operatingSystem": "",
                "pcFlowSize": 0,
                "pcPlayDuration": 0,
                "pcUniqueViewer": 0,
                "pcVideoView": 0,
                "userId": ""
            }
        ],
        "totalVideoView": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	string	StatsSummaryModel«List«OsDailyStats»»
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

StatsSummaryModel«List«OsDailyStats»»

Parameter Name	Description	Type	Schema
end	End time	string
start	Start time	string
stats	Playlist ranking	array	OsDailyStats
totalVideoView	Total views	int32

OsDailyStats

Parameter Name	Description	Type
createdTime	Creation time	date-time
currentDay	Current day	string
currentMonth	Current month	string
currentWeek	Current week	string
lastModified	Last modified time	date-time
mobileFlowSize	Mobile traffic	int64
mobilePlayDuration	Mobile play duration	int64
mobileUniqueViewer	Mobile unique viewers	int32
mobileVideoView	Mobile video views	int32
operatingSystem	Operating system	string
pcFlowSize	PC traffic	int64
pcPlayDuration	PC play duration	int64
pcUniqueViewer	PC unique viewers	int32
pcVideoView	PC video views	int32
userId	User ID	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«StatsSummaryModel«List«OsDailyStats»»»
401	Unauthorized
403	Forbidden
404	Not Found

Export Operating System Statistics Interface

API Description: Export operating system statistics API.

API Endpoint: /vod/v1/statistic/device/os/export

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, and finally perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

Response Parameter Description:

None

Response Status Code Description:

Status Code	Description	Schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Query Regional Distribution Statistics API

API Description: Query the geographical distribution statistics API.

API Endpoint: /vod/v1/statistic/geo

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": [
        {
            "createdTime": "",
            "currentDay": "",
            "currentMonth": "",
            "currentWeek": "",
            "lastModified": "",
            "mobileFlowSize": 0,
            "mobilePlayDuration": 0,
            "mobileUniqueViewer": 0,
            "mobileVideoView": 0,
            "pcFlowSize": 0,
            "pcPlayDuration": 0,
            "pcUniqueViewer": 0,
            "pcVideoView": 0,
            "province": "",
            "userId": ""
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	array	ProvinceDailyStats
message	Error message.	string
status	Request status: success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

ProvinceDailyStats

Parameter Name	Description	Type
createdTime	Creation time	date-time
currentDay	Current day	string
currentMonth	Current week	string
currentWeek	Current week	string
lastModified	Last modified time	date-time
mobileFlowSize	Mobile traffic size	int64
mobilePlayDuration	Mobile play duration	int64
mobileUniqueViewer	Mobile unique viewers	int32
mobileVideoView	Mobile video views	int32
pcFlowSize	PC traffic size	int64
pcPlayDuration	PC play duration	int64
pcUniqueViewer	PC unique viewers	int32
pcVideoView	PC video views	int32
province	Province	string
userId	User ID	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«ProvinceDailyStats»»
401	Unauthorized
403	Forbidden
404	Not Found

Export Regional Distribution Statistics Interface

API Description: Export regional distribution statistics API.

API Endpoint: /vod/v1/statistic/geo/export

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
end	Query end date (time format: yyyy-MM-dd)	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
start	Query start date (time format: yyyy-MM-dd)	query	false	string
timestamp	13-digit timestamp	query	true	string

Response Data:

Response Parameter Description:

None

Response Status Code Description:

Status Code	Description	Schema
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Video Security

Get Playback Domain Settings Information Interface

API Description: Retrieve playback domain configuration information

API Endpoint: /vod/v1/play-safe/info

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. This yields the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "blackList": "",
        "securitySetting": "",
        "userId": "",
        "whiteList": ""
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	string	PlayDomainDTO
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

PlayDomainDTO

Parameter Name	Description	Type
blackList	Blacklist, multiple entries can be added separated by commas	string
securitySetting	Playback restriction setting options: none (no restrictions), white (whitelist), black (blacklist)	string
userId	User ID	string
whiteList	Whitelist, multiple entries can be added separated by commas	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«PlayDomainDTO»
401	Unauthorized
403	Forbidden
404	Not Found

Add or Modify Playback Domain Restriction API

API Description: Interface for adding or modifying playback domain restrictions

API Endpoint: /vod/v1/play-safe/save

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	in	Required	Type
appId	Application ID	query	true	string
blackList	Blacklist, multiple entries can be added separated by commas	query	false	string
securitySetting	Playback restriction setting options: `none` (no restrictions), `white` (whitelist), `black` (blacklist)	query	true	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in lexicographical order by first letter, then arrange them as "parameterparametervalueparametervalue". Then prepend and append the secretKey, perform MD5 encryption, and convert to uppercase. The result is the `sign` value.	query	true	string
timestamp	13-digit timestamp	query	true	string
whiteList	Whitelist, multiple entries can be added separated by commas	query	false	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code	int32
data	Successfully returned data	object
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Add Watermark Settings Interface

API Description: Add Watermark Settings

API Endpoint: /vod/v1/transcoding/create

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
bucketName	Storage bucket or group name for the image watermark file	query	false	string
content	Content of the text watermark	query	false	string
fileName	File name of the watermark material	query	false	string
fontAlpha	Transparency: 0-1	query	false	number
fontColor	Color of the text watermark	query	false	string
fontName	Font of the text watermark	query	false	string
fontSize	Font size of the text watermark: in pixels	query	false	integer
gmtCreate	Creation time	query	false	string
gmtModified	Last modification time	query	false	string
id	Primary key ID	query	false	integer
imageDxUnit	Unit for horizontal offset of the image watermark: pixel or percentage	query	false	string
imageDxValue	Horizontal offset value of the image watermark	query	false	integer
imageDyUnit	Unit for vertical offset of the image watermark: pixel or percentage	query	false	string
imageDyValue	Vertical offset value of the image watermark	query	false	integer
imageHeightUnit	Unit for height of the image watermark: pixel or percentage	query	false	string
imageHeightValue	Height value of the image watermark	query	false	integer
imagePosition	Position of the image watermark: top-left, bottom-left, bottom-right, top-right	query	false	string
imageWidthUnit	Unit for width of the image watermark: pixel or percentage	query	false	string
imageWidthValue	Width value of the image watermark	query	false	integer
isDefault	Whether it is the default watermark	query	false	boolean
isDeleted	Whether it has been deleted	query	false	boolean
name	Watermark name	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, perform MD5 encryption, and convert to uppercase to obtain the sign value	query	true	string
storageSystem	Storage system for the image watermark file: FastDFS, AliyunOSS, Local	query	false	string
textDx	Horizontal offset: in pixels	query	false	integer
textDy	Vertical offset: in pixels	query	false	integer
timestamp	13-digit timestamp	query	true	string
type	Watermark type: image	query	false	string

Response Data:

{
    "code": 0,
    "data": {
        "bucketName": "",
        "content": "",
        "fileName": "",
        "fontAlpha": 0,
        "fontColor": "",
        "fontName": "",
        "fontSize": 0,
        "gmtCreate": "",
        "gmtModified": "",
        "id": 0,
        "imageDxUnit": "",
        "imageDxValue": 0,
        "imageDyUnit": "",
        "imageDyValue": 0,
        "imageHeightUnit": "",
        "imageHeightValue": 0,
        "imagePosition": "",
        "imageWidthUnit": "",
        "imageWidthValue": 0,
        "isDefault": true,
        "isDeleted": true,
        "name": "",
        "storageSystem": "",
        "textDx": 0,
        "textDy": 0,
        "type": ""
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	string	TranscodingWatermark
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

TranscodingWatermark

Parameter Name	Description	Type
bucketName	The bucket or group name where the image watermark file is stored. Field: bucket_name	string
content	The content of the text watermark. Field: content	string
fileName	The file name of the watermark material. Field: file_name	string
fontAlpha	Transparency: 0-1. Field: font_alpha	number
fontColor	The color of the text watermark. Field: font_color	string
fontName	The font of the text watermark. Field: font_name	string
fontSize	The font size of the text watermark in pixels. Field: font_size	int32
gmtCreate	Creation time. Field: gmt_create	date-time
gmtModified	Last modification time. Field: gmt_modified	date-time
id	Primary key ID. Field: id	int64
imageDxUnit	The unit for the horizontal offset of the image watermark: pixel or percentage. Field: image_dx_unit	string
imageDxValue	The horizontal offset value of the image watermark. Field: image_dx_value	int32
imageDyUnit	The unit for the vertical offset of the image watermark: pixel or percentage. Field: image_dy_unit	string
imageDyValue	The vertical offset value of the image watermark. Field: image_dy_value	int32
imageHeightUnit	The unit for the height of the image watermark: pixel or percentage. Field: image_height_unit	string
imageHeightValue	The height value of the image watermark. Field: image_height_value	int32
imagePosition	The position of the image watermark: top-left, bottom-left, bottom-right, top-right. Field: image_position	string
imageWidthUnit	The unit for the width of the image watermark: pixel or percentage. Field: image_width_unit	string
imageWidthValue	The width value of the image watermark. Field: image_width_value	int32
isDefault	Whether it is the default watermark. Field: is_default	boolean
isDeleted	Whether it has been deleted. Field: is_deleted	boolean
name	The name of the watermark. Field: name	string
storageSystem	The storage system for the image watermark file: FastDFS, AliyunOSS, Local. Field: storage_system	string
textDx	Horizontal offset in pixels. Field: text_dx	int32
textDy	Vertical offset in pixels. Field: text_dy	int32
type	Watermark type: image or text. Field: type	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«TranscodingWatermark»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Delete Watermark Settings API

API Description: Delete watermark settings

API Endpoint: /vod/v1/transcoding/delete

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
id	ID of the watermark setting to delete	query	true	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted to the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase. This value is the sign.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code	int32
data	Successfully returned data	object
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Get Watermark Settings by ID Interface

API Description: Get watermark settings by ID

API Endpoint: /vod/v1/transcoding/get

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
id	Get watermark setting ID	query	true	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted with the request (excluding non-empty parameters) in alphabetical order by parameter name, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, perform MD5 encryption, and convert to uppercase to obtain the sign value	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "bucketName": "",
        "content": "",
        "fileName": "",
        "fontAlpha": 0,
        "fontColor": "",
        "fontName": "",
        "fontSize": 0,
        "gmtCreate": "",
        "gmtModified": "",
        "id": 0,
        "imageDxUnit": "",
        "imageDxValue": 0,
        "imageDyUnit": "",
        "imageDyValue": 0,
        "imageHeightUnit": "",
        "imageHeightValue": 0,
        "imagePosition": "",
        "imageWidthUnit": "",
        "imageWidthValue": 0,
        "isDefault": true,
        "isDeleted": true,
        "name": "",
        "storageSystem": "",
        "textDx": 0,
        "textDy": 0,
        "type": ""
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	string	TranscodingWatermark
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

TranscodingWatermark

Parameter Name	Description	Type
bucketName	Bucket or group name where the image watermark file is stored. Field: bucket_name	string
content	Content of the text watermark. Field: content	string
fileName	File name of the watermark material. Field: file_name	string
fontAlpha	Transparency: 0-1. Field: font_alpha	number
fontColor	Color of the text watermark. Field: font_color	string
fontName	Font of the text watermark. Field: font_name	string
fontSize	Font size of the text watermark in pixels. Field: font_size	int32
gmtCreate	Creation time. Field: gmt_create	date-time
gmtModified	Last modification time. Field: gmt_modified	date-time
id	Primary key ID. Field: id	int64
imageDxUnit	Unit for horizontal offset of the image watermark: pixel or percentage. Field: image_dx_unit	string
imageDxValue	Horizontal offset value of the image watermark. Field: image_dx_value	int32
imageDyUnit	Unit for vertical offset of the image watermark: pixel or percentage. Field: image_dy_unit	string
imageDyValue	Vertical offset value of the image watermark. Field: image_dy_value	int32
imageHeightUnit	Unit for height of the image watermark: pixel or percentage. Field: image_height_unit	string
imageHeightValue	Height value of the image watermark. Field: image_height_value	int32
imagePosition	Position of the image watermark: top-left, bottom-left, bottom-right, top-right. Field: image_position	string
imageWidthUnit	Unit for width of the image watermark: pixel or percentage. Field: image_width_unit	string
imageWidthValue	Width value of the image watermark. Field: image_width_value	int32
isDefault	Whether it is the default watermark. Field: is_default	boolean
isDeleted	Whether it has been deleted. Field: is_deleted	boolean
name	Watermark name. Field: name	string
storageSystem	Storage system for the image watermark file: FastDFS, AliyunOSS, Local. Field: storage_system	string
textDx	Horizontal offset in pixels. Field: text_dx	int32
textDy	Vertical offset in pixels. Field: text_dy	int32
type	Watermark type: image or text. Field: type	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«TranscodingWatermark»
401	Unauthorized
403	Forbidden
404	Not Found

Get Watermark Settings List Interface

API Description: Retrieve the list of watermark settings

API Endpoint: /vod/v1/transcoding/list

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
page	Page number	query	false	integer
pageSize	Page size	query	false	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Add the secretKey at the beginning and end, then perform MD5 encryption and convert to uppercase to obtain the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": [
        {
            "bucketName": "",
            "content": "",
            "fileName": "",
            "fontAlpha": 0,
            "fontColor": "",
            "fontName": "",
            "fontSize": 0,
            "gmtCreate": "",
            "gmtModified": "",
            "id": 0,
            "imageDxUnit": "",
            "imageDxValue": 0,
            "imageDyUnit": "",
            "imageDyValue": 0,
            "imageHeightUnit": "",
            "imageHeightValue": 0,
            "imagePosition": "",
            "imagePositionDesc": "",
            "imageUrl": "",
            "imageWidthUnit": "",
            "imageWidthValue": 0,
            "isDefault": true,
            "isDeleted": true,
            "name": "",
            "storageSystem": "",
            "textDx": 0,
            "textDy": 0,
            "type": ""
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code	int32
data	Successfully returned data	array	TranscodingWatermarkDTO
message	Error message	string
status	Request status, success: "success", failure: "fail", error: "error"	string

Schema Attribute Description

TranscodingWatermarkDTO

Parameter Name	Description	Type
bucketName	Bucket or group name where the image watermark file is stored. Field: `bucket_name`	string
content	Content of the text watermark. Field: `content`	string
fileName	File name of the watermark material. Field: `file_name`	string
fontAlpha	Transparency: 0-1. Field: `font_alpha`	number
fontColor	Color of the text watermark. Field: `font_color`	string
fontName	Font of the text watermark. Field: `font_name`	string
fontSize	Font size of the text watermark in pixels. Field: `font_size`	int32
gmtCreate	Creation time. Field: `gmt_create`	date-time
gmtModified	Last modification time. Field: `gmt_modified`	date-time
id	Primary key ID. Field: `id`	int64
imageDxUnit	Unit for horizontal offset of the image watermark: pixel or percentage. Field: `image_dx_unit`	string
imageDxValue	Horizontal offset value of the image watermark. Field: `image_dx_value`	int32
imageDyUnit	Unit for vertical offset of the image watermark: pixel or percentage. Field: `image_dy_unit`	string
imageDyValue	Vertical offset value of the image watermark. Field: `image_dy_value`	int32
imageHeightUnit	Unit for the height of the image watermark: pixel or percentage. Field: `image_height_unit`	string
imageHeightValue	Height value of the image watermark. Field: `image_height_value`	int32
imagePosition	Position of the image watermark: top-left, bottom-left, bottom-right, top-right. Field: `image_position`	string
imagePositionDesc	Chinese description of the watermark position.	string
imageUrl	Access URL of the watermark image.	string
imageWidthUnit	Unit for the width of the image watermark: pixel or percentage. Field: `image_width_unit`	string
imageWidthValue	Width value of the image watermark. Field: `image_width_value`	int32
isDefault	Whether it is the default watermark. Field: `is_default`	boolean
isDeleted	Whether it has been deleted. Field: `is_deleted`	boolean
name	Watermark name. Field: `name`	string
storageSystem	Storage system for the image watermark file: FastDFS, AliyunOSS, Local. Field: `storage_system`	string
textDx	Horizontal offset in pixels. Field: `text_dx`	int32
textDy	Vertical offset in pixels. Field: `text_dy`	int32
type	Watermark type: image or text. Field: `type`	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«List«TranscodingWatermarkDTO»»
401	Unauthorized
403	Forbidden
404	Not Found

Paginated API for Retrieving Watermark Settings List

API Description: Retrieve the watermark settings list with pagination.

API Endpoint: /vod/v1/transcoding/list-by-page

Request Method: get

consumes:``

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
page	Page number	query	false	integer
pageSize	Page size	query	false	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request (excluding non-empty parameters) in alphabetical order by the first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", prepend and append the secretKey, then perform MD5 encryption and convert to uppercase to obtain the sign value	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {
        "contents": [
            {
                "bucketName": "",
                "content": "",
                "fileName": "",
                "fontAlpha": 0,
                "fontColor": "",
                "fontName": "",
                "fontSize": 0,
                "gmtCreate": "",
                "gmtModified": "",
                "id": 0,
                "imageDxUnit": "",
                "imageDxValue": 0,
                "imageDyUnit": "",
                "imageDyValue": 0,
                "imageHeightUnit": "",
                "imageHeightValue": 0,
                "imagePosition": "",
                "imageWidthUnit": "",
                "imageWidthValue": 0,
                "isDefault": true,
                "isDeleted": true,
                "name": "",
                "storageSystem": "",
                "textDx": 0,
                "textDy": 0,
                "type": ""
            }
        ],
        "endRow": 0,
        "firstPage": true,
        "hasNextPage": true,
        "hasPreviousPage": true,
        "lastPage": true,
        "limit": 0,
        "nextPageNumber": 0,
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "previousPageNumber": 0,
        "startRow": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type	Schema
code	HTTP response status code.	int32
data	Successfully returned data.	string	Page«TranscodingWatermark»
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Schema Attribute Description

Page«TranscodingWatermark»

Parameter Name	Description	Type	Schema
contents	Content of the current page.	array	TranscodingWatermark
endRow		int64
firstPage		boolean
hasNextPage		boolean
hasPreviousPage		boolean
lastPage		boolean
limit		int64
nextPageNumber		int32
offset		int64
pageNumber	Current page.	int32
pageSize	Maximum number of records displayed per page.	int32
previousPageNumber		int32
startRow		int64
totalItems	Total number of records.	int64
totalPages		int32

TranscodingWatermark

Parameter Name	Description	Type
bucketName	Bucket or group name where the image watermark file is stored. Field: `bucket_name`	string
content	Content of the text watermark. Field: `content`	string
fileName	File name of the watermark material. Field: `file_name`	string
fontAlpha	Transparency: 0-1. Field: `font_alpha`	number
fontColor	Color of the text watermark. Field: `font_color`	string
fontName	Font of the text watermark. Field: `font_name`	string
fontSize	Font size of the text watermark in pixels. Field: `font_size`	int32
gmtCreate	Creation time. Field: `gmt_create`	date-time
gmtModified	Last modification time. Field: `gmt_modified`	date-time
id	Primary key ID. Field: `id`	int64
imageDxUnit	Unit for horizontal offset of the image watermark: pixel or percentage. Field: `image_dx_unit`	string
imageDxValue	Horizontal offset value of the image watermark. Field: `image_dx_value`	int32
imageDyUnit	Unit for vertical offset of the image watermark: pixel or percentage. Field: `image_dy_unit`	string
imageDyValue	Vertical offset value of the image watermark. Field: `image_dy_value`	int32
imageHeightUnit	Unit for height of the image watermark: pixel or percentage. Field: `image_height_unit`	string
imageHeightValue	Height value of the image watermark. Field: `image_height_value`	int32
imagePosition	Position of the image watermark: top-left, bottom-left, bottom-right, top-right. Field: `image_position`	string
imageWidthUnit	Unit for width of the image watermark: pixel or percentage. Field: `image_width_unit`	string
imageWidthValue	Width value of the image watermark. Field: `image_width_value`	int32
isDefault	Whether it is the default watermark. Field: `is_default`	boolean
isDeleted	Whether it has been deleted. Field: `is_deleted`	boolean
name	Watermark name. Field: `name`	string
storageSystem	Storage system for the image watermark file: FastDFS, AliyunOSS, Local. Field: `storage_system`	string
textDx	Horizontal offset in pixels. Field: `text_dx`	int32
textDy	Vertical offset in pixels. Field: `text_dy`	int32
type	Watermark type: image or text. Field: `type`	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2«Page«TranscodingWatermark»»
401	Unauthorized
403	Forbidden
404	Not Found

Set as Default Watermark Interface

API Description: Set the watermark as the default watermark

API Endpoint: /vod/v1/transcoding/set-default

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	In	Required	Type
appId	Application ID	query	true	string
id	ID of the watermark setting to set as default	query	true	integer
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request (excluding non-empty parameters) in lexicographical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value". Prepend and append the secretKey, then perform MD5 encryption and convert to uppercase. The result is the sign value.	query	true	string
timestamp	13-digit timestamp	query	true	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Modify Watermark Settings Interface

API Description: Modify Watermark Settings

API Endpoint: /vod/v1/transcoding/update

Request Method: post

consumes:["application/json"]

produces:["application/json;charset=UTF-8"]

Request Parameters:

Parameter Name	Description	in	Required	Type
appId	Application ID	query	true	string
bucketName	The storage space or group name where the image watermark file is located	query	false	string
content	Content of the text watermark	query	false	string
fileName	File name of the watermark material	query	false	string
fontAlpha	Transparency: 0-1	query	false	number
fontColor	Color of the text watermark	query	false	string
fontName	Font of the text watermark	query	false	string
fontSize	Font size of the text watermark: pixels	query	false	integer
gmtCreate	Creation time	query	false	string
gmtModified	Last modification time	query	false	string
id	Primary key ID	query	false	integer
imageDxUnit	Unit of horizontal offset for image watermark: pixel, percentage	query	false	string
imageDxValue	Horizontal offset value for image watermark	query	false	integer
imageDyUnit	Unit of vertical offset for image watermark: pixel, percentage	query	false	string
imageDyValue	Vertical offset value for image watermark	query	false	integer
imageHeightUnit	Unit of height for image watermark: pixel, percentage	query	false	string
imageHeightValue	Height value for image watermark	query	false	integer
imagePosition	Position of image watermark: top-left, bottom-left, bottom-right, top-right	query	false	string
imageWidthUnit	Unit of width for image watermark: pixel, percentage	query	false	string
imageWidthValue	Width value for image watermark	query	false	integer
isDefault	Whether it is the default watermark	query	false	boolean
isDeleted	Whether it has been deleted	query	false	boolean
name	Watermark name	query	false	string
sign	Signature verification parameter. Generation rule: Sort all other parameters submitted in the request interface (excluding non-empty parameters) in alphabetical order by their first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", add the secretKey at the beginning and end, perform MD5 encryption, and convert to uppercase to get the sign value	query	true	string
storageSystem	Storage system where the image watermark file is located: FastDFS, AliyunOSS, Local	query	false	string
textDx	Horizontal offset: pixels	query	false	integer
textDy	Vertical offset: pixels	query	false	integer
timestamp	13-digit timestamp	query	true	string
type	Watermark type: image	query	false	string

Response Data:

{
    "code": 0,
    "data": {},
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name	Description	Type
code	HTTP response status code.	int32
data	Successfully returned data.	object
message	Error message.	string
status	Request status, success: "success", failure: "fail", error: "error".	string

Response Status Code Description:

Status Code	Description	Schema
200	OK	WrappedResponseV2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

POLYV Help Center

VOD Interface Documentation

Introduction

Upload Video API

Upload Video Interface

Sub-account Management Related APIs

Add Sub-account API

Delete Sub-account Interface

Get Sub-Account Information by Sub-Account ID Interface

Paginated API for Retrieving Sub-Account List

Get Role List API

Update Sub-Account Information Interface

Subtitle Upload Interface

Delete Subtitles

Modify Subtitle Name Interface

Get Subtitle List Interface

Subtitle Upload Interface

Advertising Management API

Delete Ad Interface

Get Ad Detail API

Query Ad Interface

Add or Modify Ad Interface

Provide APIs Related to Category Management

Add Subcategory Interface

Delete Specified Category Interface

Get Video Category Interface

Modify Category Interface

Provide Video Management Related Interfaces

Batch Delete Videos

Get Video Information by Video VID

Search Video API

Update Basic Video Information

Upload Video Cover Image

Playback Domain Statistics Related APIs

Get Domain Statistics Interface

Export Domain Statistics API

APIs Related to Playback Duration Statistics

Query Playback Duration Statistics API

Export Playback Duration Statistics Interface

Play Count Statistics Related APIs

Playlist Interface

Export Play Count API

Play Count Ranking API

Export Summary Play Count Ranking Interface

Interfaces Related to Overall Data Overview

Data Aggregation Interface

Overview Data Summary Interface

Terminal Device Statistics Related Interfaces

Get Terminal Device Statistics API

Browser Statistics API

Export Browser Statistics Interface

Export Terminal Device Statistics Interface

Operating System Statistics

Export Operating System Statistics Interface

Audience Geographic Location Statistics Related APIs

Query Regional Distribution Statistics API

Export Regional Distribution Statistics Interface

Video Security

Get Playback Domain Settings Information Interface

Add or Modify Playback Domain Restriction API

Video Watermark Management Related APIs

Add Watermark Settings Interface

Delete Watermark Settings API

Get Watermark Settings by ID Interface

Get Watermark Settings List Interface

Paginated API for Retrieving Watermark Settings List

Set as Default Watermark Interface

Modify Watermark Settings Interface