Polyv Help Center

Help Center

test-download

Updated: 2022-05-24 09:27:17

Introduction

Title: VOD API Interface Documentation

Introduction: External API Interface Documentation for the VOD System

Contact:

API Endpoint: /v2/api-docs

Upload Video API

Upload Video Interface

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

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 Schema
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 parameters submitted to the request interface (excluding non-empty parameters) in alphabetical order by their 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
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 used query false integer
transGroupName Transcoding template group name used 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 Data returned on success. string Video
message Error message. string
status Request status: success: "success", failure: "fail", error: "error". string

Schema Attribute Description: Video

Parameter Name Description Type Schema
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 Playback 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 resolution: height

Field: original_height

int32
originalWidth Source video resolution: 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 used

Field: trans_group_id

int64
transGroupName Transcoding template group name used

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, "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

Upload Video Interface

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

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

Request Method: options

consumes:["multipart/form-data"]

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

Request Parameters:

Parameter Name Description In Required Type Schema
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 cover image query false string
coverFileName Cover image file name query false string
coverStorageSystem Storage system for 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 info, JSON format query false string
file Video file formData true file
gmtCreate Creation time query false string
gmtModified Last modified time query false string
id Primary key ID query false integer
isAudio Is audio-only query false boolean
isDeleted Is deleted: 0, 1 query false boolean
isEncrypted Requires encryption query false boolean
isScreen Screen recording optimization query false boolean
isTranscoding Requires transcoding query false boolean
originalDefinition Source resolution: 1280x720 query false string
originalHeight Source video height query false integer
originalWidth Source video width query false integer
sign Signature parameter. Generation rule: sort all other submitted parameters (excluding non-empty parameters) alphabetically by first letter, then arrange as "parameterparametervalueparametervalue", prepend and append secretKey, then MD5 encrypt and convert to uppercase to get 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 Average video 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 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 Schema
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 Playback 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 optimized

Field: is_screen

boolean
isTranscoding Whether transcoding is required

Field: is_transcoding

boolean
originalDefinition Source resolution: 1280x720

Field: original_definition

string
originalHeight Source video resolution: height

Field: original_height

int32
originalWidth Source video resolution: 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 used

Field: trans_group_id

int64
transGroupName Transcoding template group name used

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, "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»
204 No Content
401 Unauthorized
403 Forbidden

Sub-account Management Related APIs

Add Sub-account

Interface Description:

API Endpoint: /vod/v1/account/add

Request Method: post

consumes:["application/json"]

produces:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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, then perform MD5 encryption and convert to uppercase. This yields 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 Schema
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 Description:

API Endpoint: /vod/v1/account/delete

Request Method: post

consumes:["application/json"]

produces:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 Schema
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

API Description:

API Endpoint: /vod/v1/account/get

Request Method: get

consumes:``

produces:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
appId Application ID query true string
childUserId Sub-account ID query true integer
sign Parameter for signature verification. Generation rule: Sort all other parameters submitted in 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, 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": {
        "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 Successfully returned data string UserChildrenDTO
message Error message string
status Request status, success: "success", failure: "fail", error: "error" string

Schema Attribute Description: UserChildrenDTO

Parameter Name Description Type Schema
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«UserChildrenDTO»
401 Unauthorized
403 Forbidden
404 Not Found

Paginate to Retrieve Sub-Account List

API Description:

API Endpoint: /vod/v1/account/list

Request Method: get

consumes:``

produces:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 parameter name, 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 number of records displayed 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 Schema
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

Interface Description:

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

Request Method: get

consumes:``

produces:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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": [
        {
            "id": 0,
            "name": ""
        }
    ],
    "message": "",
    "status": ""
}

Response Parameter Description:

Parameter Name Description Type Schema
code HTTP response status code. int32
data Successfully returned data. 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

API Description:

API Endpoint: /vod/v1/account/update

Request Method: post

consumes:["application/json"]

produces:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 Schema
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 Schema
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 Schema
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

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 Schema
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 "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 Schema
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 Schema
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 result is the value of sign. 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 Schema
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 Schema
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 Schema
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 Schema
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 Schema
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 Schema
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 Schema
addrurl Link address: target URL for the ad redirect 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: display material for the ad, can be uploaded or external link, supports images string
poplocation Display position int32
popuptime Display duration 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 online 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«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 Schema
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 is the value of sign. 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 Successfully returned data. string Page«AdvertDTO»
message Error message. string
status Request status, success: "success", failure: "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 Schema
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«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 Schema
addrurl Link address: target URL for ad redirection 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: display material for the ad, can be uploaded or external link, 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 "parameterparametervalueparametervalue", 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 pre-roll ads query false string
skiptime Time allowed to skip the ad, in seconds query false integer
status Status: online 10, pending online 1, offline 0, deleted -1 query false integer
timestamp 13-digit timestamp query true string
title Ad name: 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 Schema
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

Provide APIs Related to Category Management

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 Schema
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 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. 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 Schema
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, 1

Field: is_deleted

boolean
name Category name

Field: name

string
ordered Sibling order, 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 Owner 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

deleteCategory

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 Schema
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". 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 Schema
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

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 Schema
appId Application ID query true string
cataId The category ID to search for; if not submitted, all categories are retrieved 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

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 Description 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 Name API

API Description: Modify Category Name

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 Schema
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 Schema
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

Provide Video Management Related Interfaces

Get Video Information by Video VID

API Description: Interface for retrieving video information based on 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 Schema
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: snapshot information

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", 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
timestamp 13-digit timestamp query true string
vids Video IDs to query; multiple IDs (separated by English 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 Schema
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 Under Review 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 VID string

VideoMetaData

Parameter Description Type Schema
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 Schema
bitrate Video bitrate, in bps int32
definition Video definition, values:

SOURCE Original file LD Smooth SD Standard HD High Definition FHD Ultra HD 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; 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 Interface

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

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 Schema
appId Application ID query true string
categoryIdList Video category IDs, 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 number of records per page, default is 25 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 "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
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 Successfully returned data 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 Schema
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 (Transcode Failed) CHECKING (Under Review) 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 VID string

Response Status Code Description:

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

Playback Domain Statistics Related APIs

Get Domain Statistics Interface

Interface Description: Get domain statistics interface.

API Endpoint: /vod/v1/statistic/domain

Request Method: get

consumes:``

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

Request Parameters:

Parameter Name Description In Required Type Schema
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": [
        {
            "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 Schema
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 Schema
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 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

APIs Related to Playback Duration Statistics

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 Schema
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 Schema
currentDay Current day string
mobilePerAveragePlayDuration Average watch duration per user on mobile int64
mobilePlayDuration Play duration on mobile int64
mobileVideoAveragePlayDuration Average watch duration per video on mobile int64
pcPerAveragePlayDuration Average watch duration per user on PC int64
pcPlayDuration Play duration on PC int64
pcVideoAveragePlayDuration Average watch duration per video 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 API

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 Schema
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 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:


Response Parameter Description:

None

Response Status Code Description:

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

Play Count Statistics Related APIs

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 Schema
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 Schema
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 Schema
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:


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 Schema
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 Success response 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 Schema
duration Duration int32
imageUrl Cover image 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 Aggregate Play Count Ranking API

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 Schema
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 lexicographic 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

Interfaces Related to Overall Data Overview

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 Schema
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, 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 Schema
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 interface.

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 Schema
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": {
        "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 Schema
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

Terminal Device Statistics Related Interfaces

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 Schema
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, 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 Schema
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 Schema
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 first letter, then arrange them in the format "parameter name parameter value parameter name parameter value", then prepend and append the secretKey, and finally perform MD5 encryption and convert to uppercase, which gives 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 Schema
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

API Description: Export browser statistics API.

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 Schema
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:


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

API Description: Export terminal device statistics API.

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 Schema
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

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 Schema
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, 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": {
        "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 video views int32

OsDailyStats

Parameter Name Description Type Schema
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

Interface Description: Export operating system statistics interface.

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 Schema
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

APIs Related to Audience Geographic Location Statistics

Query Regional Distribution Statistics API

API Description: Query the geographical distribution statistics interface.

API Endpoint: /vod/v1/statistic/geo

Request Method: get

consumes:``

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

Request Parameters:

Parameter Name Description In Required Type Schema
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, 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 Schema
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 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
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 interface.

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 Schema
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 Schema
appId Application ID query true string
sign Signature verification parameter. Generation rule: Sort all other parameters submitted with 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 Schema
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: Add or modify playback domain restriction interface

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 Schema
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 Parameter for signature verification. 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 as "parameter name parameter value parameter name parameter value". 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 Schema
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

Video Watermark Management Related Interfaces

Add Watermark Settings Interface

API Description: Add Watermark Settings

API Endpoint: /vod/v1/transcoding/create

Request Method: post

consumes:["application/json"]

produces:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 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 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 Schema
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: 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 of horizontal offset for image watermark: pixel, percentage

Field: image_dx_unit

string
imageDxValue Horizontal offset value for image watermark

Field: image_dx_value

int32
imageDyUnit Unit of vertical offset for image watermark: pixel, percentage

Field: image_dy_unit

string
imageDyValue Vertical offset value for image watermark

Field: image_dy_value

int32
imageHeightUnit Unit of height for image watermark: pixel, percentage

Field: image_height_unit

string
imageHeightValue Height value for image watermark

Field: image_height_value

int32
imagePosition Position of image watermark: top-left, bottom-left, bottom-right, top-right

Field: image_position

string
imageWidthUnit Unit of width for image watermark: pixel, percentage

Field: image_width_unit

string
imageWidthValue Width value for 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: pixels

Field: text_dx

int32
textDy Vertical offset: pixels

Field: text_dy

int32
type Watermark type: image, 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:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 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

Response Data:

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

Response Parameter Description:

Parameter Name Description Type Schema
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:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 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
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 Schema
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:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 interface (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 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 Schema
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 of horizontal offset for the image watermark: pixel or percentage

Field: image_dx_unit

string
imageDxValue The horizontal offset value for the image watermark

Field: image_dx_value

int32
imageDyUnit The unit of vertical offset for the image watermark: pixel or percentage

Field: image_dy_unit

string
imageDyValue The vertical offset value for the image watermark

Field: image_dy_value

int32
imageHeightUnit The unit of height for the image watermark: pixel or percentage

Field: image_height_unit

string
imageHeightValue The height value for 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
imagePositionDesc Chinese description of the watermark position string
imageUrl The access URL of the watermark image string
imageWidthUnit The unit of width for the image watermark: pixel or percentage

Field: image_width_unit

string
imageWidthValue The width value for 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«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:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 with 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": {
        "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 Schema
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: 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, 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, 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, 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, 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: pixels

Field: text_dx

int32
textDy Vertical offset: pixels

Field: text_dy

int32
type Watermark type: image, 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

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

Request Method: post

consumes:["application/json"]

produces:["*/*"]

Request Parameters:

Parameter Name Description In Required Type Schema
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 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, 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 Schema
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:["*/*"]

Request Parameters:

Parameter Name Description in Required Type Schema
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: 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 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 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: 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 Schema
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
联系客服,在线咨询