URLs to view Live and Archive from cameras

The method and parameters

POST /api/v1/cameras/video

If the archive link contains the move_to field, it indicates that the requested archive time precedes the actual start of the available archive. To prevent playback errors, the system automatically shifts the requested time to the value specified in move_to.

The expired_at field specifies the exact time until which the link remains valid. After this timestamp, the token becomes invalid.

Additionally, you can include the user's integration token in the request. If the user has access to the specified camera, a valid archive link will be generated.

JSON

{
    "cameras": [
        {
            "uuid": "uuid",
            "stream_type": "high",
            "archive_ranges": true,
            "date": "2000-01-01T00:00:00Z"
        }
    ],
    "source": "hls",
    "ttl": "100"
}

array cameras required – an array of UUIDs of cameras for which you are retrieving links. Each camera object has the following properties:

uuid – the UUID of the camera for which the link is to be generated. This field is required.
stream_type – a type of the video stream. If omitted or set to camera, the link will be generated for this camera. If the stream type is specified, the link will be generated for that particular stream type.
archive_ranges – this flag is used to include information about the available archive time ranges.
date – this field is used to generate the archive link and specifies the start date of the archive.

string source required – a protocol type.

hls – HTTP Live Streaming (the default value)
rtsp – Real Time Streaming Protocol

int ttl – a link lifetime in seconds.

200 OK

A successful response with all parameters

JSON

[
{
"url": "http://127.0.0.1/test",
"url_type": "camera"
"expired_at": "2000-01-01T00:00:00.000000Z",
"archive_ranges": [
{
"from": "2000-01-01T00:00:00.000000Z",
"to": "2000-01-01T02:00:00.000000Z"
}
],
"move_to": "2000-01-01T00:00:00.000000Z"
}
]

401 Unauthorized

When an authorization token is passed but is invalid

cURL

Bash

curl -k --request POST \
	--url 'https://your-domain/api/v1/cameras/video' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "cameras": [],
    "source": "string",
    "ttl": 0
}'

PHP

$data = array (
  'cameras' => 
  array (
  ),
  'source' => 'string',
  'ttl' => 0,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/cameras/video', false, $context);