Skip to main content

Send an STB Command

Sends a command to an STB device. The device must be online and connected (status Online or Standby) to successfully receive the command. Commands are sent immediately to the receiving STB and are not queued or retained for offline devices. Commands are identified by a string and the expected parameters are defined uniquely for each supported command.

Authorizations: STB Administration

Requests

Power On/Off
POST /apis/devices/stbs/:id/commands
{ "command":"standby-off" }
POST /apis/devices/stbs/:id/commands
{ "command":"standby-on" }

Parameters:

FieldTypeDescription
commandStringCommand to send: standby-off or standby-on.
Reboot
POST /apis/devices/stbs/:id/commands
{ "command":"reboot" }


Parameters:

FieldTypeDescription
commandStringCommand to send: reboot.
Mute/Unmute
POST /apis/devices/stbs/:id/commands
{ "command":"mute" }
POST /apis/devices/stbs/:id/commands
{ "command":"unmute" }

Parameters:

FieldTypeDescription
commandStringCommand to send: mute or unmute.
Set Volume
POST /apis/devices/stbs/:id/commands
{ "command":"set-volume", "parameters": { "volume": .75 } }

Parameters:

FieldTypeDescription
commandStringCommandto send: set-volume.
volumeFloatVolume level to set. Range: 0.00-1.00
Set Channel
POST /apis/devices/stbs/:id/commands
{ "command":"set-channel", "parameters": { "id":"ae7dcb56-9a62-402d-99e8-e053c4af0ff5", "name":null, "type":"source" } }

Parameters:

FieldTypeDescription
commandStringCommand to send: set-channel.
idStringID of the resource to watch.
nameString

Name of the resource to watch.

Note

Content is not checked, recommend setting to null.

typeStringType of resource: source, session, or asset.
Show Message
POST /apis/devices/stbs/:id/commands
{ "command": "show-text-message", "parameters": { "data": [ { "message": "This is an important message", "duration": 300000, "color": "#ffffff", "blink": false } ], "useFades": true, "repeat": -1, "showMode": "static", "location": { "position": "bottom", "offset": 0 }, "backgroundColor": "#ff0000" } }

Parameters:

FieldTypeDescription
commandStringCommand to send: set-text-message.
repeatNumberRepeat count. Set to -1 to disable.
showModeStringDisplay mode: static or scroll.
backgroundColorStringColor RGB value in hex, e.g., #aabbcc.
useFadesBooleanSet to true.
positionStringAnchor position: bottom-left, bottom-right, top-left, top-right, left, right.
offsetNumberVertical pixel offset from anchor position.
messageStringText content of message.
durationNumberMessage duration in ms.
colorStringColor RGB value in hex, e.g., #aabbcc.
blinkBooleanBlink/pulse the text message.
Enable/Disable DWS

These commands enable and disable the STB's diagnostic web server.

POST /apis/devices/stbs/:id/commands
{ "command":"enable-dws" }
POST /apis/devices/stbs/:id/commands
{ "command":"disable-dws" }

Parameters:

FieldTypeDescription
commandStringCommand to send: enable-dws or disable-dws.

Response

Success

{
  "data": {
    "type":"Send Commands to Device",
    "status":"ok",
    "message":"Successfully sent command to device"
  }
}

Error

Code

Payload

Description

404
{"code": "040000", "name":"NotFound",
"message":"Device stream not found", "httpStatusCode":404}

Device offline.

404
{"code": "040000", "name":"NotFound",
"message":"Device not found", "httpStatusCode":404}

Unknown device ID.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.