Send a request to a camera for video and/or snapshots for a selected date-time window. After the request is sent, it will be processed and the request will be sent to the camera to retrieve the requested media.

Allowed duration can be from 5 seconds to 1 hour between start_ts and end_ts. Requested event will upload a video of the requested duration along with a snapshot which is taken from the "center" of the request.

For durations > 5 minutes, the request will be broken up into as many 5-minute duration events as it can, then the remaining will be made into its own event.

After a custom video request is submitted, the server will send the request to retrieve the media from the camera at the nearest opportunity. This event will be added to the event list for the company and can be retrieved using the returned event_id in the response.

User Role Permissions

The following table shows which user roles are allowed to send requests using this API endpoint.

User Role	Allowed
Partner
Partner View
Custom Partner	Requires permissions to be enabled
Fleet Manager
Group Manager
User
Custom User	Requires permissions to be enabled

Considerations

Here are some things to consider when implementing the custom video request API endpoint for your application.

Video Availability

Wake-up / Sleep mode

Foreshortened Event Video

Data Usage

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Request Exists

application/json

Body

Example

{
    "meta": {
        "code": 200
    },
    "response": {
        "request_id": 1908766,
        "warning": "request exists"
    },
    "result": "OK"
}

🟢201Created

🟠400Bad Request

🟠401Login Required

🟠404404 (device doesn't exist)

Request custom video from device

User Role Permissions#

Considerations#

Request

Request Code Samples

Responses

User Role Permissions

Considerations