Get album file list
1. API Description
This API is used to get the album file list, including recorded videos and screenshots.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/album/get-album-files-list
- V2.5.0 and below: POST [ip]/mwapi/get-album-files-list
Administrator Rights | Logged-in |
---|---|
No | Yes |
2. Input Parameters
Name | Required | Type | Description |
---|---|---|---|
type | Yes | Int | Resource type 0: All the files 1: Screenshot 2: Recorded video |
3. Output Parameters
Name | Type | Description |
---|---|---|
result | Int | Status code |
message | String | Status description |
info | InfoData | Info objects |
InfoData
Name | Type | Description |
---|---|---|
items | Array of MediaData | Array of media data |
pageIndex | Int | Page index |
totalCount | Int | Total counts of media data |
MediaData
Name | Type | Description |
---|---|---|
id | Int | The file ID |
type | Int | The file type 1: Screenshot 2: Recorded video |
name | String | The resource name |
md5 | String | The MD5 value of the file |
filePath | String | The relative path of the file, accessible via http://device IP/relative path . |
thumbPath | String | The relative path of the thumbnail, accessible via http://device IP/relative path . |
createTime | Int | The file creation time, represented as a timestamp relative to 1970-01-01. |
duration | Int | The duration of the file. Only valid for videos, in ms. |
size | Int | The file size, in Byte. |
4. Example
Getting the screenshot list.
Input Example
{
"type":1
}
Output Example
{
"info": {
"items": [
{
"createTime": 1640055676,
"duration": 0,
"filePath": "album/2a83adf5-3e0d-4ad0-9af5-81d8fc0fea18.jpeg",
"id": 2,
"md5": "md5",
"name": "2021.12.21 11:01AM",
"size": 502784,
"thumbPath": "album/2a83adf5-3e0d-4ad0-9af5-81d8fc0fea18.thumb.jpeg",
"type": 1
},
{
"createTime": 1640055673,
"duration": 1849,
"filePath": "album/16241d75-12ea-4344-bf7f-bf683e9b850e.mp4",
"id": 1,
"md5": "md5",
"name": "2021.12.21 11:01AM",
"size": 1487872,
"thumbPath": "album/16241d75-12ea-4344-bf7f-bf683e9b850e.thumb.jpeg",
"type": 2
}
],
"pageIndex": 0,
"totalCount": 2
},
"message": "success",
"result": 0
}
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Status | Definition | Description |
---|---|---|
7 | MW_STATUS_INVALID_ARG | Missing required parameters |