Professional Displays Knowledge Center

Businesses that develop systems using the Cloud API are deemed to agree to the END USER LICENSE AGREEMENT.
API docs by Redocly

RMS Cloud API (2.1.0)

Download OpenAPI specification:Download

Device

Get all device information

Authorizations:
(ApiKeyAuthAccessKeyAuth)

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Get device information

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "deviceId": "string",
  • "deviceName": "string",
  • "modelName": "string",
  • "serial": "string",
  • "braviaId": "string",
  • "softwareVersion": "string",
  • "osVersion": "string",
  • "displayResolution": {
    },
  • "networkInterfaces": [
    ],
  • "redda": {
    }
}

Deactivate the device.

If the target device is associated with an Access Key, it is disassociated and deactivated.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_API_KEY"
}

Get installed apks list.

  • The attributes available via this API are specific to APKs, as defined by Android.
    • For details on each attribute, please refer to the Android Developer documentation.
  • To determine if an APK or Activity can be launched:
    • APK is launchable when:
      1. Its enabledState is COMPONENT_ENABLED_STATE_ENABLED or COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED
      2. Its enabledState is COMPONENT_ENABLED_STATE_DEFAULT and enabled is true
    • Activity is launchable when the parent APK is launchable AND:
      1. Its exported is true AND its enabledState is COMPONENT_ENABLED_STATE_ENABLED or COMPONENT_ENABLED_STATE_DISABLED_UNTIL_USED
      2. Its exported is true AND its enabledState is COMPONENT_ENABLED_STATE_DEFAULT and enabled is true
  • APKs in the "Hide" state are not included in the list returned by this API.
Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "apks": [
    ]
}

Get external inputs status.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "signals": [
    ]
}

Get mute state.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "mute": "ON"
}

Get device online status.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "online": true
}

Get Pro mode settings

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "mode": "NORMAL"
}

Get Screen On/Off state.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "screen": "ON"
}

Get screen rotation.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "rotation": 0
}

Take a screenshot.

An Accept header is required in the request header, and "image/jpeg" shall be set as first media type. e.g.) Accept: image/jpeg'

Note:If TV software version is 6.7612 or higher, specifying “video” will capture the video plane for HDMI. Please refer to the design guidelines in details.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

query Parameters
plane
string

Added in: v1.1.0

  • plane option indicates the plane target for screen capture.
  • plane option accepts "video" or be omitted.
  • Specify "video" if you want to capture a video played via HDMI.

Added in: v1.3.0

  • If you do not set the plane query, video and UI plane are mixed.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT"
}

Get selected external input.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "port": "HDMI1"
}

Get volume.

Returns the current volume.

Note:

  • For devices with 5-digit software versions (e.g., 6.8000):
    • Returns the current audio output volume.
  • For devices with 10-digit software versions (e.g., 114.101.260.1):
    • Returns the volume of the built-in speakers (SPEAKER).
    • To get volumes for all audio outputs, use /devices/{deviceId}/volumes.
Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "volume": 100
}

Get volumes for all audio outputs.

Returns volume information for all audio outputs.

Note:

  • This API is only available for devices with 10-digit software versions (e.g., 114.101.260.1).
  • Devices with 5-digit software versions (e.g., 6.8000) do not support this API.
    • Use /devices/{deviceId}/volume instead.
Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "volumes": [
    ]
}

Get storages status.

Added in: v1.1.0

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "storages": {
    }
}

Device request

Update the RMS Agent (Display Control Agent) software.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_API_KEY"
}

Launch APK

Added in: v1.1.0

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
packageName
required
string

package name.

activityName
string

activity name. required if "data" option is specified.

data
string

data (URI).

Responses

Request samples

Content type
application/json
{
  • "packageName": "string",
  • "activityName": "string",
  • "data": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "packageName and/or activityName are invalid."
}

Install APK

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
assetId
required
string

Asset ID

grantPermissions
string
Enum: "AUTO" "OFF"

Added in: v1.4.0

  • grantPermissions option indicates the permission for the installing apk.
  • grantPermissions option accepts "AUTO", "OFF", or omitted.
  • Specify "AUTO" if you want to give grant permission to your application.

Responses

Request samples

Content type
application/json
{
  • "assetId": "string",
  • "grantPermissions": "AUTO"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Asset ID not found."
}

Uninstall APK

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
packageName
required
string

package name.

Responses

Request samples

Content type
application/json
{
  • "packageName": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Request body is invalid."
}

Set external storage permission to the apk.

Note:This API can't set the external storage permission for the pre-installed packages.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
action
required
string
Enum: "GRANT_PERMISSION" "DENY_PERMISSION" "DEFAULT_PERMISSION"

action (GRANT_PERMISSION/DENY_PERMISSION/DEFAULT_PERMISSION)

packageName
required
string

package name.

permission
required
string

permission

  • android.permission.READ_EXTERNAL_STORAGE - Read permission
  • android.permission.WRITE_EXTERNAL_STORAGE - Write permission

Responses

Request samples

Content type
application/json
{
  • "action": "GRANT_PERMISSION",
  • "packageName": "string",
  • "permission": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "packageName and/or permission are invalid."
}

Set mute (On / Off)

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
mute
required
string
Enum: "ON" "OFF"

ON / OFF

Responses

Request samples

Content type
application/json
{
  • "mute": "ON"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Invalid mute value."
}

Set pro mode (NORMAL / PRO_SETTINGS / PRO)

Added in: v1.1.0

Note:

  • For devices with 5-digit software versions (e.g., 6.8000):
    • All modes (NORMAL, PRO_SETTINGS, PRO) are supported.
  • For devices with 10-digit software versions (e.g., 114.101.260.1):
    • Setting mode to PRO_SETTINGS is not supported and returns INVALID_ARGUMENT.
Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
mode
required
string
Enum: "NORMAL" "PRO_SETTINGS" "PRO"

(NORMAL / PRO_SETTINGS / PRO) mode

Responses

Request samples

Content type
application/json
{
  • "mode": "NORMAL"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Invalid mode value."
}

Reboot device

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_API_KEY"
}

Get all request information.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

Get request information.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

requestId
required
string

ID given for each request.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "status": {
    },
  • "result": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

Set Screen On/Off

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
screen
required
string
Enum: "ON" "OFF"

Screen state (ON / OFF)

Responses

Request samples

Content type
application/json
{
  • "screen": "ON"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Invalid screen value."
}

Set screen rotate.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
rotation
required
number

Screen rotation (0, 90)

Responses

Request samples

Content type
application/json
{
  • "rotation": 0
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Invalid rotation value."
}

Change the external input selection.

Note:

  • For devices with 5-digit software versions (e.g., 6.8000):
    • All inputs (HDMI1, HDMI2, HDMI3, HDMI4, AV) are supported.
  • For devices with 10-digit software versions (e.g., 114.101.260.1):
    • Setting input to AV is not supported and returns INVALID_ARGUMENT.
Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
port
required
string
Enum: "HDMI1" "HDMI2" "HDMI3" "HDMI4" "AV"

external input name (HDMI1 / HDMI2 / HDMI3 / HDMI4 / AV)

Responses

Request samples

Content type
application/json
{
  • "port": "HDMI1"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Invalid port value."
}

Export the device settings.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "exportSettingIds": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT"
}

Import settings to the device.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
required
object (Settings)

Responses

Request samples

Content type
application/json
{
  • "importSettings": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT"
}

Update the device system software.

The RMS Agent (Display Control Agent) will be updated to the latest version automatically at the system software update. Available system software versions can be obtained by using the GET /system-softwares.

Note:

  • For devices with 5-digit software versions (e.g., 6.8000):
    • Set the version field in the request body to a 5-digit version (e.g., 6.8112).
  • For devices with 10-digit software versions (e.g., 114.101.260.1):
    • Set the version field in the request body to a 10-digit version (e.g., 114.101.340.1).
Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
version
required
string

software version (e.g. 6.7612).

Responses

Request samples

Content type
application/json
{
  • "version": "6.7612"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Version of device software not found."
}

Set audio volume.

Added in: v1.1.0

Sets the audio volume.

Note:

  • For devices with 5-digit software versions (e.g., 6.8000):
    • Sets the current audio output volume.
  • For devices with 10-digit software versions (e.g., 114.101.260.1):
    • Sets the volume of the built-in speakers (SPEAKER).
    • To set volumes for multiple audio outputs, use /devices/{deviceId}/volumes/requests.
Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
volume
required
integer [ 0 .. 100 ]

volume (0 - 100)

Responses

Request samples

Content type
application/json
{
  • "volume": 50
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Invalid volume value."
}

Set audio volumes for multiple outputs.

Added in: v2.0.0

Sets audio volumes for multiple outputs.

Note:

  • This API is only available for devices with 10-digit software versions (e.g., 114.101.260.1 or later).
  • For devices with 5-digit software versions, use /devices/{deviceId}/volume/requests instead.
Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
required
Array of objects (VolumeInfo) non-empty

Volume settings for audio outputs.

  • At least one target must be specified.

Responses

Request samples

Content type
application/json
Example
{
  • "volumes": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Invalid volume value."
}

Device action

Send remote control code.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
deviceId
required
string

Device ID.

Request Body schema: application/json
required
code
required
string
Enum: "KEY_LEFT" "KEY_UP" "KEY_RIGHT" "KEY_DOWN" "KEY_ENTER" "KEY_BACK_SPACE" "KEY_BLUE" "KEY_RED" "KEY_GREEN" "KEY_YELLOW" "KEY_0" "KEY_1" "KEY_2" "KEY_3" "KEY_4" "KEY_5" "KEY_6" "KEY_7" "KEY_8" "KEY_9" "KEY_PLAY" "KEY_PAUSE" "KEY_STOP" "KEY_TRACK_NEXT" "KEY_TRACK_PREV" "KEY_FAST_FWD" "KEY_REWIND" "KEY_SUBTITLE" "KEY_INFO" "KEY_HOME" "KEY_CH_UP" "KEY_CH_DOWN" "KEY_AUDIO_CHANGE" "KEY_TV_INPUT_HDMI_1" "KEY_TV_INPUT_HDMI_2" "KEY_TV_INPUT_HDMI_3" "KEY_TV_INPUT_HDMI_4" "KEY_HELP" "KEY_SYNC_MENU" "KEY_POWER" "KEY_INPUT_CHANGE" "KEY_MUTE" "KEY_VOLUME_UP" "KEY_VOLUME_DOWN" "KEY_DOT" "KEY_OPTIONS"

Remote control code.

  • KEY_LEFT - Left
  • KEY_UP - Up
  • KEY_RIGHT - Right
  • KEY_DOWN - Down
  • KEY_ENTER - Enter (Confirm)
  • KEY_BACK_SPACE - Return
  • KEY_BLUE - Blue
  • KEY_RED - Red
  • KEY_GREEN - Green
  • KEY_YELLOW - Yellow
  • KEY_0 - 0
  • KEY_1 - 1
  • KEY_2 - 2
  • KEY_3 - 3
  • KEY_4 - 4
  • KEY_5 - 5
  • KEY_6 - 6
  • KEY_7 - 7
  • KEY_8 - 8
  • KEY_9 - 9
  • KEY_PLAY - Play
  • KEY_PAUSE - Pause
  • KEY_STOP - Stop
  • KEY_TRACK_NEXT - Next
  • KEY_TRACK_PREV - Prev
  • KEY_FAST_FWD - FF (Fast-Forward)
  • KEY_REWIND - FR (Fast-Rewind)
  • KEY_SUBTITLE - Subtitle
  • KEY_INFO - Information
  • KEY_HOME - Home
  • KEY_CH_UP - CH+
  • KEY_CH_DOWN - CH-
  • KEY_AUDIO_CHANGE - Audio
  • KEY_TV_INPUT_HDMI_1 - HDMI 1
  • KEY_TV_INPUT_HDMI_2 - HDMI 2
  • KEY_TV_INPUT_HDMI_3 - HDMI 3
  • KEY_TV_INPUT_HDMI_4 - HDMI 4
  • KEY_HELP - Help
  • KEY_SYNC_MENU - SYNC
  • KEY_POWER - Power
  • KEY_INPUT_CHANGE - External input change
  • KEY_MUTE - Audio mute
  • KEY_VOLUME_UP - Audio volume+
  • KEY_VOLUME_DOWN - Audio volume-
  • KEY_DOT - Dot
  • KEY_OPTIONS - Options

Responses

Request samples

Content type
application/json
{
  • "code": "KEY_LEFT"
}

Response samples

Content type
application/json
{
  • "code": "COMPLETED"
}

Device event

Get the device event associated with the token.

Authorizations:
(ApiKeyAuthDeviceEventToken)

Responses

Response samples

Content type
application/json
{
  • "deviceEvents": [
    ]
}

Asset

Get asset list.

Authorizations:
(ApiKeyAuthAccessKeyAuth)

Responses

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "assets": [
    ]
}

Create an asset.

There is a limit to the total size that can be uploaded.

Authorizations:
(ApiKeyAuthAccessKeyAuth)

Responses

Response samples

Content type
application/json
{
  • "assetId": "string",
  • "uploadUrl": "string"
}

Delete uploaded asset.

Authorizations:
(ApiKeyAuthAccessKeyAuth)
path Parameters
assetId
required
string

Asset ID.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_API_KEY"
}

Access Key

Create access key.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "accessKey": "string"
}

Get device list with the access-key.

Authorizations:
ApiKeyAuth
path Parameters
accessKey
required
string

Access Key.

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Delete Access Key.

If there are some assets associated with the accessKey, they are deleted, too.

Authorizations:
ApiKeyAuth
path Parameters
accessKey
required
string

Access Key.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_API_KEY"
}

Associate the device with the access key.

Authorizations:
ApiKeyAuth
path Parameters
accessKey
required
string

Access Key.

Request Body schema: application/json
required
deviceId
required
string

Device ID.

Responses

Request samples

Content type
application/json
{
  • "deviceId": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_ARGUMENT",
  • "errorMessage": "Invalid deviceId value."
}

Unlink the device from the access key.

Authorizations:
ApiKeyAuth
path Parameters
accessKey
required
string

Access Key.

deviceId
required
string

Device ID.

Responses

Response samples

Content type
application/json
{
  • "errorCode": "INVALID_API_KEY"
}

System software

Get supported system software versions.

Added in: v1.5.0

Authorizations:
ApiKeyAuth
query Parameters
modelName
required
string

Model Name (e.g. FW-85BZ40L).

Responses

Response samples

Content type
application/json
{
  • "systemSoftwares": [
    ]
}