App Server console API reference - - Alibaba Cloud Documentation Center

This topic describes how to call the API operations for the ApsaraVideo for Short Video console and the data that is returned.

Data structure of return values

All requests return data in JSON format. This topic describes only the data within the data structure.

Return parameter	Type	Description
requestId	string	The ID of the request that is generated on the server-side.
code	string	The code of the request that is generated on the server-side.
message	string	The server-side message. This is often used to describe the cause of an error.
data	object	The business data struct returned from the server-side. The data structure varies based on the business.

Console API operations

getVideos: Queries a list of videos based on specified conditions.

GET URL: /console/vod/getVideos

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
pageIndex	int	No	The page number. Pages start from 1.
pageSize	int	No	The number of entries per page.
videoId	string	No	The video ID.
userId	string	No	The user ID.
title	string	No	The title.
startTime	string	No	The start time.
endTime	string	No	The end time.
userName	string	No	The username.
censorStatus	string	No	The review status.

Return parameters

Name	Type	Description
total	string	The total number of videos.
videoList	List<Video>	The list of video information in the personal center.

Example response

{
  "result": "true",
  "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  "message": "",
  "code": "200",
  "data": {
    "total": 7,
    "videoList": [
      {
        "id": "25",
        "videoId": "23rfewc23",
        "title": "test video",
        "description": "test33",
        "duration": 12,
        "coverUrl": "https://example.aliyundoc.com/image9sfsa0-dfcoverurl****.png",
        "creationTime": "2019-01-09 22:11:29.0",
        "status": "",
        "firstFrameUrl": "",
        "size": 56,
        "cateId": 12,
        "cateName": "12",
        "tags": "test",
        "shareUrl": "",
        "user": {
          "userId": "2434793223202",
          "userName": "Anne",
          "avatarUrl": "https://example.aliyundoc.com/dd38cab5-2951-43a0-b9ed-ad0eebf8****"
        },
        "transcodeStatus": "",
        "snapshotStatus": "",
        "censorStatus": "onCensor",
        "narrowTranscodeStatus": "",
        "SnapshotList": { "http://sample/covers/990f3820db2948b5b4a13d65d9a449****.jpg"
              , "http://sample/covers/sprite/990f3820db2948b5b4a13d65d9a449****.jpg"
            },
        "fileUrlList": { "http://example.aliyundoc.com/ABEBDE15CC479FD4D****/52a53151eba5226f8e2da3b55bc5****.mp4"
              , "http://example.aliyundoc.com/ABEBDE15CC479FD4D****/52a53151eba5226f8e2da3b55bc5****.mp4"
            }
      }
    ]
  }
}

submitTranscode: Initiates a non-Narrowband HD transcoding task.

GET URL: /console/vod/submitTranscode

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
mediaId	String	Yes	The video ID.

Example response

{
  "result": "true",
  "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  "message": "The standard transcoding job was submitted.",
  "code": "200",
  "data": null
}

createAudit: Submits a manual review job.

GET URL: /console/vod/createAudit

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
mediaId	String	Yes	The video ID.
status	String	Yes	The status. Valid values: Blocked Normal
reason	String	No	The reason for blocking the video. This parameter is required if you set Status to Blocked. The reason can be up to 128 bytes in length.
comment	String	No	Notes

Example response

{
  "result": "true",
  "requestId": "c312edd-1dc3-132r313rfef-qfevw42ghrnk",
  "message": "The review is complete.",
  "code": "200",
  "data": null
}

submitTabTranscode: Submits a Narrowband HD transcoding job.

GET /console/vod/submitTabTranscode

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
mediaId	String	Yes	The video ID.

Example response

{
  "result": "true",
  "requestId": "dsgb455-e85f-443f9-a50a-12323rfg34t34g",
  "message": "The Narrowband HD transcoding job is submitted.",
  "code": "200",
  "data": null
}

getVideoById: Queries the details of a video by its ID.

GET URL: /console/vod/getVideoById

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
videoId	string	Yes	The video ID.

Return parameters

Name	Type	Description
title	string	The video title.
videoId	string	The video ID.
description	string	The video description.
duration	string	The video duration in seconds.
coverUrl	string	The URL of the video thumbnail.
status	string	The video status.
firstFrameUrl	string	The URL of the first frame.
size	string	The size of the source video file in bytes.
tags	string	The video tags. Separate multiple tags with commas (,).
cateId	string	The video category.
cateName	string	The name of the video category.
creationTime	string	The creation time.
transcodeStatus	string	The transcoding status.
snapshotStatus	string	The snapshot status.
censorStatus	string	The review status.
narrowTranscodeStatus	string	The status of the Narrowband HD transcoding.
SnapshotList	list	The list of snapshots.
fileUrilList	list	The list of video URLs.
user	User	The user.

Example response

{
  "result": "true",
  "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  "message": "",
  "code": "200",
  "data": {
        "id": "25",
        "videoId": "23rfewc23",
        "title": "test video",
        "description": "test33",
        "duration": 12,
        "coverUrl": "https://example.aliyundoc.com./image9sfsa0-dfcoverurl****.png",
        "creationTime": "2019-01-09 22:11:29.0",
        "status": "",
        "firstFrameUrl": "",
        "size": 56,
        "cateId": 12,
        "cateName": "12",
        "tags": "test",
        "shareUrl": "",
        "user": {
          "userId": "2434793223202",
          "userName": "Anne",
          "avatarUrl": "https://example.aliyundoc.com/dd38cab5-2951-43a0-b9ed-ad0eebf8****"
        },
        "transcodeStatus": "",
        "snapshotStatus": "",
        "censorStatus": "onCensor",
        "narrowTranscodeStatus": "",
        "SnapshotList": { "http://sample/covers/990f3820db2948b5b4a13d65d9a4****-2.jpg"
              , "http://sample/covers/sprite/990f3820db2948b5b4a13d65d9a4****-1.jpg"
            },
        "fileUrilList": { "http:///example.aliyundoc.com/ABEBDE15CC479FD4D****/52a53151eba5226f8e2da3b55bc5****.mp4"
              , "http:///example.aliyundoc.com/ABEBDE15CC479FD4D****/52a53151eba5226f8e2da3b55bc5****.mp4"
            }
  }
}

getRecommendVideos: Queries a list of recommended videos based on specified conditions.

GET URL: /console/vod/getRecommendVideos

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
pageIndex	int	No	The page number. Pages start from 1.
pageSize	int	No	The number of entries per page.
videoId	string	No	The video ID.
userId	string	No	The user ID.
title	string	No	The title.
startTime	string	No	The start time.
endTime	string	No	The end time.
userName	string	No	The username.
censorStatus	string	No	The review status.

Return parameters

Name	Type	Description
total	string	The total number of videos.
videoList	List<Video>	The list of video information in the personal center.

Example response

{
  "result": "true",
  "requestId": "c3bcb60d-e85f-4e19-a50a-16bedb56165f",
  "message": "",
  "code": "200",
  "data": {
    "total": 7,
    "videoList": [
      {
        "id": "25",
        "videoId": "23rfewc23",
        "title": "test video",
        "description": "test33",
        "duration": 12,
        "coverUrl": "https:///example.aliyundoc.com/image9sfsa0-dfcoverurl****.png",
        "creationTime": "2019-01-09 22:11:29.0",
        "status": "",
        "firstFrameUrl": "",
        "size": 56,
        "cateId": 12,
        "cateName": "12",
        "tags": "test",
        "shareUrl": "",
        "user": {
          "userId": "2434793223202",
          "userName": "Anne",
          "avatarUrl": "https:///example.aliyundoc.com/dd38cab5-2951-43a0-b9ed-ad0eebf8****"
        },
        "transcodeStatus": "",
        "snapshotStatus": "",
        "censorStatus": "onCensor",
        "narrowTranscodeStatus": ""
      }
    ]
  }
}

recommendVideo: Recommends a video and adds it to the recommendation list.

POST URL: /console/vod/recommendVideo

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
title	string	No	The video title.
videoId	string	No	The video ID.
userId	string	No	The user ID.
description	string	No	The video description.
duration	String	No	The video duration in seconds.
coverUrl	string	No	The URL of the video thumbnail.
size	String	No	The size of the source video file in bytes.
tags	string	No	The video tags. Separate multiple tags with commas (,).
cateId	String	No	The video category.
cateName	string	No	The name of the video category.
firstFrameUrl	string	No	The first frame.
transcodeStatus	String	No	Transcoding status (Non-Narrowband HD)
snapshotStatus	string	No	The snapshot status.
censorStatus	String	No	The review status.
isNarrow	String	No	Specifies whether to perform Narrowband HD transcoding.
isCache	String	No	Specifies whether to prefetch the video.

Example response

{
  "result": "true",
  "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  "message": "The video is added to the recommendation list.",
  "code": "200",
  "data":null
}

pushObjectCache: Prefetches content to the cache.

POST URL: /console/vod/pushObjectCache

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
objectPath	string	No	The URL of the object. Example: example.com/image/1.png. Separate multiple URLs with a line feed (\n or \r\n).

Example response

{
  "result": "true",
  "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  "message": "The prefetch is complete.",
  "code": "200",
  "data":null
}

getRecommendVideoById: Queries the details of a recommended video by video ID.

GET URL: /console/vod/getRecommendVideoById

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
videoId	string	Yes	The video ID.

Return parameters

Name	Type	Description
title	string	The video title.
videoId	string	The video ID.
description	string	The video description.
duration	string	The video duration in seconds.
coverUrl	string	The URL of the video thumbnail.
status	string	The video status.
firstFrameUrl	string	The URL of the first frame.
size	string	The size of the source video file in bytes.
tags	string	The video tags. Separate multiple tags with commas (,).
cateId	string	The video category.
cateName	string	The name of the video category.
creationTime	string	The creation time.
transcodeStatus	string	The transcoding status.
snapshotStatus	string	The snapshot status.
censorStatus	string	The review status.
narrowTranscodeStatus	string	The status of the Narrowband HD transcoding.
SnapshotList	list	The list of snapshots.
fileUrilList	list	The list of video URLs.
user	User	The user.

Example response

{
  "result": "true",
  "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  "message": "The video details are retrieved based on the video ID.",
  "code": "200",
  "data": {
        "id": "25",
        "videoId": "23rfewc23",
        "title": "test video",
        "description": "test33",
        "duration": 12,
        "coverUrl": "https:///example.aliyundoc.com/image9sfsa0-dfcoverurl.png",
        "creationTime": "2019-01-09 22:11:29.0",
        "status": "",
        "firstFrameUrl": "",
        "size": 56,
        "cateId": 12,
        "cateName": "12",
        "tags": "test",
        "shareUrl": "",
        "user": {
          "userId": "2434793223202",
          "userName": "Anne",
          "avatarUrl": "https:///example.aliyundoc.com/dd38cab5-2951-43a0-b9ed-ad0eebf8****"
        },
        "transcodeStatus": "success",
        "snapshotStatus": "success",
        "censorStatus": "onCensor",
        "narrowTranscodeStatus": "onCensor"
  }
}

deleteVideoById: Deletes a video.

POST URL: /console/vod/deleteVideoById

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
videoId	string	Yes	The video ID.
userId	string	Yes	The user ID.

Example response

{
  "result": "true",
  "requestId": "f9a8sdf09iaf3-2f23r23-0965iyhk4",
  "message": "The deletion is complete.",
  "code": "200",
  "data":null
}

deleteRecommendById: Removes a video from the recommendation list.

POST URL: /console/vod/deleteRecommendById

Parameters

Name	Type	Required	Description
consoletoken	string	Yes	The token for authenticating access to the ApsaraVideo for Short Video system. You can replace this with your own authentication method.
videoId	string	Yes	The video ID.

Example response

{
  "result": "true",
  "requestId": "f8163b40-6192-4edc-97ec-52c6cd96e996",
  "message": "The recommendation is canceled.",
  "code": "200",
  "data":null
}

POST URL: /console/user/login

Parameters

Name	Type	Required	Description
userName	string	Yes	The username.
password	string	Yes	The password.

Example response

{
    "result": "true",
    "requestId": "c30f63ed-3f66-45e9-9df0-a15e7d3a7e6a",
    "message": "Logon is successful.",
    "code": "200",
    "data": {
        "consoleToken": "12351232334123456781548765480698"
    }
}

signOut: Logs out of the console.
POST URL: /console/user/signOut
Parameters
Name
Type
Required
Description
userName
string
Yes
The username.
password
string
Yes
The password.
Example response
```
{
    "result": "true",
    "requestId": "d4b6405b-86fb-45e7-826c-68b69926147b",
    "message": "Logoff is complete.",
    "code": "200",
    "data": null
}
```