Download OpenAPI specification:Download
| mobileNumber required | string = 11 characters Default: "09123456789" Client mobile number |
| ip | string Client IP for limited access, send if accessWithMultiIp eq with true |
| fileId required | string File id |
| faultTolerance | number >= 6 Maximum number of fault tolerance. If this value is exceeded, the user will be banned |
| fixWatermark | boolean The possibility of fixed text across the screen |
| enableBeep | boolean Add additional security layer for protect sound |
| accessWithMultiIp | boolean Prevent to sharing links based client ip |
| securityProtection | boolean 360 degree security protection system |
| offlineMode | boolean Prevent to show video on offline mode |
| sendProtectionAlert | boolean Send warning SMS to high-risk users |
| enableActiveSession | boolean Prevent to sharing links based current active session |
| beepInterval | number >= 1 The duration of the delay in the execution of the beep |
| preventZoom | boolean Prevent zom-in OR zom-out |
| enablePlaylist | boolean Add playlist in player if exist |
| extraWatermark | string [ 1 .. 40 ] characters Display custom text like userId, email, ip, ..., Note: Make sure no spaces are included |
| beepVolume | number [ 0.1 .. 1 ] Beep volume |
| needInstallApplication | boolean Playing the video in playback mode from the installed software on end user system. (Don't use this if you want to play on browser) |
| expireTime | string Defines the expiration duration for a link. The format consists of a number followed by a single-character time unit that specifies the time period. Supported time units are:
Example: |
{- "mobileNumber": "09123456789",
- "ip": "string",
- "fileId": "string",
- "faultTolerance": 6,
- "fixWatermark": true,
- "enableBeep": true,
- "accessWithMultiIp": true,
- "securityProtection": true,
- "offlineMode": true,
- "sendProtectionAlert": true,
- "enableActiveSession": true,
- "beepInterval": 1,
- "preventZoom": true,
- "enablePlaylist": true,
- "extraWatermark": "string",
- "beepVolume": 0.1,
- "needInstallApplication": true,
- "expireTime": "string"
}{- "url": "string"
}| title required | string <= 50 characters |
| description | string <= 500 characters |
{- "title": "string",
- "description": "string"
}{- "code": 0,
- "message": "string"
}| bucketId required | string |
| title required | string <= 50 characters |
| description | string <= 500 characters |
{- "bucketId": "string",
- "title": "string",
- "description": "string"
}{- "code": 0,
- "message": "string"
}| sortBy | string Sort parameter in the format of |
| limit | integer <int32> >= 1 Limit the number of results returned per page. |
| currentPage | integer <int32> >= 1 Specify the current page of results, for pagination. |
{- "results": [
- {
- "_id": "string",
- "title": "string",
- "description": "string",
- "totalFiles": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "currentPage": 0,
- "limit": 0,
- "totalPages": 0,
- "totalResults": 0
}| bucketId required | string Bucket id |
{- "_id": "string",
- "title": "string",
- "description": "string",
- "totalFiles": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| fileId required | string File id |
| description | string <= 500 characters |
| title | string <= 50 characters |
| file | string <binary> |
{- "code": 0,
- "message": "string"
}| sortBy | string Sort parameter in the format of |
| limit | integer <int32> >= 1 Limit the number of results returned per page. |
| currentPage | integer <int32> >= 1 Specify the current page of results, for pagination. |
| bucketId required | string Bucket id |
| hlsStatus | string Enum: "done" "waiting" "failed" |
| listOfId | string Get list of file infos based on list of id, split each id with comma (,) |
{- "results": [
- {
- "_id": "string",
- "bucket": "string",
- "title": "string",
- "description": "string",
- "fileSize": "string",
- "realFileSize": 0,
- "duration": "string",
- "fileOwner": "string",
- "fileId": "string",
- "thumbnail": "string",
- "hlsStatus": {
- "title": "string",
- "value": "waiting"
}, - "builtTime": "string",
- "demo": {
- "shareLink": "string",
- "staticIframe": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "hlsBuiltFileSize": 0
}
], - "currentPage": 0,
- "limit": 0,
- "totalPages": 0,
- "totalResults": 0
}| sortBy | string Sort parameter in the format of |
| limit | integer <int32> >= 1 Limit the number of results returned per page. |
| currentPage | integer <int32> >= 1 Specify the current page of results, for pagination. |
| hlsStatus | string Enum: "done" "waiting" "failed" |
| listOfId | string Get list of file infos based on list of id, split each id with comma (,) |
{- "results": [
- {
- "_id": "string",
- "bucket": "string",
- "title": "string",
- "description": "string",
- "fileSize": "string",
- "realFileSize": 0,
- "duration": "string",
- "fileOwner": "string",
- "fileId": "string",
- "thumbnail": "string",
- "hlsStatus": {
- "title": "string",
- "value": "waiting"
}, - "builtTime": "string",
- "demo": {
- "shareLink": "string",
- "staticIframe": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "hlsBuiltFileSize": 0
}
], - "currentPage": 0,
- "limit": 0,
- "totalPages": 0,
- "totalResults": 0
}| fileId required | string File id |
| basedOn | string Default: "_id" Search for file based on column (default: _id) |
{- "_id": "string",
- "bucket": "string",
- "title": "string",
- "description": "string",
- "fileSize": "string",
- "realFileSize": 0,
- "duration": "string",
- "fileOwner": "string",
- "fileId": "string",
- "thumbnail": "string",
- "hlsStatus": {
- "title": "string",
- "value": "waiting"
}, - "builtTime": "string",
- "demo": {
- "shareLink": "string",
- "staticIframe": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "hlsBuiltFileSize": 0
}This path is only available for tus protocol and cannot upload file with postman or anything else
| bucket_id | string Bucket id (default: Default Folder) |
{- "code": 0,
- "message": "string"
}| allowedDNS required | Array of strings Allowed ips |
{- "allowedDNS": [
- "string"
]
}{- "code": 0,
- "message": "string"
}{- "fontSize": 0,
- "speed": 0,
- "fontColor": "string",
- "opacity": 0,
- "link": {
- "expireTime": "string",
- "accessWithMultiIp": true
}, - "displayTextOnScreen": true,
- "sendProtectionAlert": true,
- "needInstallApplication": true,
- "fixWatermark": true,
- "ipValidation": true,
- "enableBeep": true,
- "enablePlaylist": true,
- "enableActiveSession": true,
- "beepInterval": 0,
- "preventZoom": true,
- "beepVolume": 0,
- "faultTolerance": 0,
- "player": {
- "themeColor": "string",
- "offlineMode": true,
- "securityProtection": true
}
}| speed | number >= 1 The speed of moving text on the screen |
| fontColor | string Enum: "#ffff00" "#dda0dd" "#800000" "#4b0082" "#ffa500" "#27ae60" "#16a085" "#af7ac5" "#e74c3c" "#66a310" Text font color |
| fontSize | number >= 14 Text font size |
| opacity | number <float> [ 0.2 .. 1 ] The transparency of the text in the player, between 0 to 1 in float |
| displayTextOnScreen | boolean Prevent to show text on screen |
| needInstallApplication | boolean Prevent screen capture with third party application(trial version, do not use in your production) |
| sendProtectionAlert | boolean Send warning SMS to high-risk users |
| ipValidation | boolean if true you need to set your server ip to the white list |
| enableBeep | boolean Add additional security layer for protect sound |
| enableActiveSession | boolean Prevent to sharing links based current active session |
| beepInterval | number >= 1 The duration of the delay in the execution of the beep |
| preventZoom | boolean Prevent zom-in OR zom-out |
| beepVolume | number <float> [ 0.1 .. 1 ] Beep volume |
| faultTolerance | number <= 6 Maximum number of fault tolerance. If this value is exceeded, the user will be banned |
| fixWatermark | boolean The possibility of fixed text across the screen |
| enablePlaylist | boolean Add playlist in player if exist |
object | |
object |
{- "speed": 1,
- "fontColor": "#ffff00",
- "fontSize": 14,
- "opacity": 0.2,
- "displayTextOnScreen": true,
- "needInstallApplication": true,
- "sendProtectionAlert": true,
- "ipValidation": true,
- "enableBeep": true,
- "enableActiveSession": true,
- "beepInterval": 1,
- "preventZoom": true,
- "beepVolume": 0.1,
- "faultTolerance": 6,
- "fixWatermark": true,
- "enablePlaylist": true,
- "player": {
- "themeColor": "string",
- "offlineMode": true,
- "securityProtection": true,
- "customErrors": {
- "userBlocked": "string",
- "internalError": "string",
- "activeSession": "string",
- "storageExpiration": "string",
- "failedToProcessFile": "string"
}
}, - "link": {
- "accessWithMultiIp": true,
- "expireTime": "string"
}
}{- "code": 0,
- "message": "string"
}{- "totalFilesInStorage": 0,
- "userId": "string",
- "storage": {
- "percentUsed": {
- "capacity": 0
}, - "expire": "2019-08-24T14:15:22Z",
- "expirationTime": "string",
- "capacityUsed": 0,
- "capacity": 0,
- "currentPlan": {
- "value": "string",
- "title": "silver"
}, - "isPlanExpired": true,
- "isCapacityClosedToFull": true
}
}| mobileNumber required | string |
{- "mobileNumber": "string"
}{- "code": 0,
- "message": "string"
}| sortBy | string Sort parameter in the format of |
| limit | integer <int32> >= 1 Limit the number of results returned per page. |
| currentPage | integer <int32> >= 1 Specify the current page of results, for pagination. |
| timeSeries | number Enum: 7 30 90 Time series parameter based on day |
| search | string User mobile number, Note: To get information based on a list of phone numbers, use a comma between each phone number |
| actionType | string Default: "attacker,risky,normal" User action type (valid: attacker, risky, normal) |
| banned | boolean Get list of banned user based time series |
{- "results": [
- {
- "blockReasonCodes": [
- {
- "code": 0,
- "message": "string"
}
], - "mobileNumber": "string",
- "buckets": [
- "string"
], - "files": [
- "string"
], - "reports": {
- "allTime": {
- "status": "string",
- "data": [
- {
- "time": "string",
- "reasonCode": 0,
- "message": "string",
- "status": "string"
}
]
}, - "lastReasonCodes": [
- {
- "time": "string",
- "reasonCode": 0,
- "message": "string"
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "actionType": "normal",
- "isBanned": true,
- "actionTypeTitle": "string",
- "ip": {
- "ip": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "percentageWatched": "string",
- "realWatchTime": "string",
- "approximateWatchTime": "string",
- "lastVisitedLink": "string",
- "lastVisitedBucket": {
- "_id": "string",
- "title": "string",
- "description": "string",
- "totalFiles": 0
}, - "lastVisitedFile": {
- "_id": "string",
- "title": "string",
- "description": "string",
- "duration": "string",
- "thumbnail": "string"
}
}
], - "currentPage": 0,
- "limit": 0,
- "totalPages": 0,
- "totalResults": 0,
- "visitorCounts": 0,
- "blockedVisitorCounts": 0
}| fileId required | string |
{- "_id": "string",
- "title": "string",
- "description": "string",
- "fileSize": "string",
- "thumbnail": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| playlistId required | string |
| title | string |
Array of objects |
{- "playlistId": "string",
- "title": "string",
- "files": [
- {
- "_id": "string",
- "title": "string"
}
]
}{- "code": 0,
- "message": "string"
}| sortBy | string Sort parameter in the format of |
| limit | integer <int32> >= 1 Limit the number of results returned per page. |
| currentPage | integer <int32> >= 1 Specify the current page of results, for pagination. |
{- "results": [
- {
- "_id": "string",
- "title": "string"
}
], - "currentPage": 0,
- "limit": 0,
- "totalPages": 0,
- "totalResults": 0
}