Send Command
Send command to a specific device
Available Commands: Launch App, Play/Pause Video, Launch Web Url, Disable/Enable Kiosk, Restart, Power Off, Set Volume, Set Brightness, Uninstall App, Sync, Enable/Disable Tutorial ModeAuthorizations
API key based authentication where <encoded-value> is the Base64 encoding of API_KEY_ID
:API_KEY_SECRET
- Username: The API Key ID.
- Password: The API Key Secret.
Path Parameters
The ID of the organization. Locate the orgId under Organization Settings > API Keys.
The ID (serial number) of the device.
Body
Launch an application on the device.
LAUNCH_APP
"LAUNCH_APP"
Launch an application on the device.
LAUNCH_APP
"LAUNCH_APP"
Play or pause video on the device.
PLAY_VIDEO
, PAUSE_VIDEO
"PLAY_VIDEO"
Launch a specific webxr link on the device. Requires the data field to be populated (see below)
LAUNCH_WEB_URL
"LAUNCH_WEB_URL"
Override the device experience set on the Configuration.
DISABLE_KIOSK
- Disable Kiosk Mode / ManageXR Home Screen on the device. Grants users full access to the default system menus. Sets kioskModeOverride
flag on device to true
.
ENABLE_KIOSK
- Re-Enable Kiosk Mode / ManageXR Home Screen on the device. Sets kioskModeOverride
flag on device to false
.
Note, if the Configuration applied to a device uses Default Device Menus, the kioskModeOverride flag is a no-op.
DISABLE_KIOSK
, ENABLE_KIOSK
"DISABLE_KIOSK"
Reboot the device.
RESTART
"RESTART"
Remotely turn off device. Supported on Pico Neo 3s PUI 5+ and Pico 4 Ultra Enterprise devices.
POWER_OFF
"POWER_OFF"
Set volume on device. Supply a level between 0 and 100.
SET_VOLUME
"SET_VOLUME"
Set display brightness on device. Supply a level between 0 and 100.
SET_BRIGHTNESS
"SET_BRIGHTNESS"
Uninstall an application on the device.
Cannot uninstall system apps. If you uninstall an app that is still on a devices's configuration, it will automatically re-download the next time the device syncs.
UNINSTALL_APP
"UNINSTALL_APP"
Force device to check in with ManageXR. Online devices sync every 15 minutes or immediately when configuration changes are made.
SYNC
"SYNC"
When Tutorial Mode in enabled, the device launches into its tutorial app on boot. Set the tutorial app in Configuration > Device Settings.
ENABLE_TUTORIAL_MODE
, DISABLE_TUTORIAL_MODE
"ENABLE_TUTORIAL_MODE"
Response
Success