RoscoLive API v1.0(v2.35.0)
  1. Device
RoscoLive API v1.0(v2.35.0)
  • Event
    • Request custom video from device
      PUT
  • Company
    • create a company
      PUT
    • get a company by ID
      GET
    • update a company by ID
      POST
    • update company
      POST
    • get a company
      GET
    • get companies
      GET
    • get own partner company
      GET
  • Device
    • Geotab
      • Pair cameras to GO devices by CSV file
    • Play in-cab audible alert sound for device
      POST
    • Get a device
      GET
  • External Service
    • Get an external service account
      GET
    • Pair RL device with external device
      PUT
    • Get RL device data via external device unique serial number
      GET
  • Fleet Configuration
    • Create new profile in a company
      POST
    • Update a company profile
      POST
    • Get a company profile
      GET
    • Get profiles of a company
      GET
    • get profile history
      GET
  1. Device

Play in-cab audible alert sound for device

POST
https://fleet.roscolive.com/api/v1.0/devices/{device_id}/playaudible
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.
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://fleet.roscolive.com/api/v1.0/devices//playaudible' \
--form 'audible_type="chime"' \
--form 'expires="20250310171530"'
Response Response Example
202 - Success
{
    "meta": {
        "code": 202
    },
    "response": "play-audible request sent to device.",
    "result": "OK"
}

Request

Path Params

Body Params multipart/form-data

Responses

🟢202Success
application/json
Body

🟠400Device is offline/unavailable
🟠401Login Required
🟠404Record not found
🟠404Resource Not Found
🔴500Internal Server Error
Modified at 2025-04-30 18:07:30
Previous
Pair cameras to GO devices by CSV file
Next
Get a device
Built with