Devices
Tools for managing devices (players) registered to the Revel Digital account. Each device represents a physical display player (Android, Chrome OS, Windows, Linux, or BrightSign) that renders scheduled content.
list_devices
List devices registered to the account. Returns device objects with id, name, registration key, device type, group assignment, online status, and current schedule.
| Parameter | Type | Required | Description |
|---|---|---|---|
group_id |
string or string[] | No | Filter by device group ID(s) |
group_name |
string or string[] | No | Filter by device group name(s) |
device_type_id |
string | No | Filter by device type ID |
is_online |
boolean | No | Filter by online status |
include_snap |
boolean | No | Include latest screenshot data (default: false) |
org_id |
string | No | Filter by organization ID (multi-org accounts) |
take |
number | No | Results per page |
page |
number | No | Page number (1-based) |
get_device
Get detailed information about a single device by its registration key. Returns the device’s name, type, group assignment, current schedule, online status, last check-in time, IP address, and firmware version.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The device registration key |
create_device
Register a new device in Revel Digital. Typically devices self-register via the player application, but this allows pre-provisioning a device entry.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string | No | Display name for the device |
device_type_id |
string | No | Device type ID (Android, ChromeOS, Windows, etc.) |
group_id |
string | No | Device group ID to assign to |
activation_code |
string | No | Activation code for pairing with a physical player |
update_device
Update a device’s properties such as name, group assignment, or scheduled content. Only include fields you want to change.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The device registration key |
name |
string | No | New display name |
group_id |
string | No | Device group ID to move to |
schedule_id |
string | No | Schedule ID to assign |
tags |
string | No | Comma-separated tags |
delete_device
Permanently delete a device registration from the account. This action cannot be undone. The physical player will need to re-register if it connects again.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The device registration key |
send_device_command
Send a remote command to a specific device. Commands are processed asynchronously and execute on the device’s next check-in.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The device registration key |
command |
string | Yes | One of: reboot, screenshot, restart-player, clear-cache |
Supported commands:
| Command | Description |
|---|---|
reboot |
Restart the operating system |
screenshot |
Capture the current display |
restart-player |
Restart the player application only |
clear-cache |
Clear local media cache, forcing re-download |
bulk_send_device_commands
Send commands to multiple devices simultaneously. Useful for fleet-wide operations.
| Parameter | Type | Required | Description |
|---|---|---|---|
commands |
array | Yes | Array of { id, command } objects |
get_device_snapshot
Retrieve the latest screenshot for a device showing what is currently displayed.
| Parameter | Type | Required | Description |
|---|---|---|---|
registrationKey |
string | Yes | The device registration key |
base64 |
boolean | No | Return as base64 string instead of binary (default: false) |