A utility endpoint that will push a command to the camera to play an audible in-cab alert sound immediately upon receipt of the request.

Due to the asynchronous nature of this API, there is an expected network delay between submiting the request and the server sending the request to the camera. To help with this, a future date-time value can be passed into the expires parameter to set an expiration for the prompt so that if the request is received after this time, it will be ignored. This will prevent any potential confusion of the driver by playing an alert too long after the initial trigger event.

User Role Permissions

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

Role	Permission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Path Params

device_id

integer

required

Body Params multipart/form-data

audible_type

enum<string>

required

Type of audible alert to play from camera. Options include sounds and vocalizations.

Allowed values:

chimebeep_twobeep_fourdistractionobstructiontailgatingharsh_drivingheadwayhspeedno_sb

Example:

chime

expires

string <date-time>

required

Camera will not play audible if request received after this datetime (UTC)

Example:

20250310171530

Match pattern:

YYYYMMDDhhmmss

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by response

response

string

required

Contains response data

result

string

required

"OK" if successful, else "Failed" if error

Example

{
    "meta": {
        "code": 202
    },
    "response": "play-audible request sent to device.",
    "result": "OK"
}

🟠400Device is offline/unavailable

🟠401Login Required

🟠404Record not found

🟠404Resource Not Found

🔴500Internal Server Error

Play in-cab audible alert sound for device

User Role Permissions#

Request

Request samples

Responses

User Role Permissions