Generate virtual event

Generate a virtual event, where media (a video or an image) is uploaded to the cloud.

Important: For best results, always use the quality, durationSeconds, and cameraId parameters.

Request
Security:
bearerAuth
path Parameters
imei
required
string (IMEI)

The IMEI of the device. The IMEI number can be found on a sticker on the device itself or on the back of the device box.

Example: 357660101000198
Request Body schema: application/json
time
required
string <date-time> (Time)

The time, in ISO 8601 format.

mediaType
string
Default: "video"

The type of media uploaded.

Enum: "video" "snapshot"
durationSeconds
number [ 1 .. 86400 ]

The length of the video, in seconds. Only applies to the video mediaType. For video, include this parameter for best results.

quality
string

The quality of of the video. Include this parameter for best results.

Enum: "standard" "high"
cameraId
number

The ID of the in-cab or road-facing lens, or any paired auxiliary camera. Include this parameter for best results.

1 - road-facing lens, 2 - in-cab lens, 50+ - auxiliary cameras.

metadata
string

The metadata of the event.

visualAlert
boolean

Whether a visual alert is shown on the device screen when an event occurs.

This will be available from device version 3.11.

audioAlert
boolean

Whether an audio alert is played when an event occurs.

This will be available from device version 3.11.

Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

417

Expectation failed error

500

Internal server error

post/devices/{imei}/virtual-event
Request samples
application/json
{
  • "time": "2020-01-01T14:48:00.000Z",
  • "mediaType": "video",
  • "durationSeconds": 1,
  • "quality": "standard",
  • "cameraId": 1,
  • "metadata": "string",
  • "visualAlert": true,
  • "audioAlert": true
}
Response samples
    2 more
    417
    500
application/json
{
  • "data": {
    },
  • "requestId": "df5fg-45fgfdsg-45fg-45454"
}