Home > Develop > Device Control by Cloud Solution > API Specs for Management > Device action

Send remote control code.

Estimated reading time: 6 minutes

Note:

The support information on this page may differ by region in terms of availability and timing.
*Japan : Support is scheduled for soon. API Specs for Provisioning is not supported. API Specs for Management is planned to be supported.
*China : Not supported

API

POST /devices/{deviceId}/remote-control

Syntax

https://api.apps.rdm.sony.net/rms/v1/devices/{deviceId}/remote-control

Authentication Level

ApiKeyAuth and AccessKeyAuth

Request Body schema

Request Body schema application/json Explanation
code 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
    		•

    Response

    Response Schema application/json Explanation
    code   Value: "COMPLETED"
    Remote control result.
    Response Schema application/json Explanation
    errorCode API_KEY_NOT_FOUND API Key is not found.
    ACCESS_KEY_NOT_FOUND Access Key is not found.
    ASSET_NOT_FOUND Asset is not found.
    ASSET_TOTAL_SIZE_ERROR The total size of the uploaded assets has exceeded the limit.
    INVALID_API_KEY The API Key is invalid.
    INVALID_ACCESS_KEY The Access Key is invalid.
    INVALID_ARGUMENT Invalid argument. Need to check the request parameters.
    INVALID_CSR Invalid argument. CSR is invalid.
    INVALID_TOKEN Token is invalid.
    INTERNAL_SERVER_ERROR Internal server error.
    SERVICE_UNAVAILABLE Service unavailable.
    REQUEST_NOT_FOUND Request is not found.
    RESOURCE_BUSY Resource is busy.
    RESOURCE_NOT_FOUND Resource is not found(except DEVICE_NOT_FOUND).
    DEVICE_NOT_FOUND The device is not found.
    DEVICE_NOT_SUPPORT The device is not support the api.
    DEVICE_NOT_READY The device is not ready.
    DEVICE_NOT_ONLINE The device is not online.
    DEVICE_NETWORK_ERROR A network error is occurred on the device.
    DEVICE_BUSY The device is busy. Please wait for a while and retry.
    DEVICE_PRECONDITION_FAILED Precondition is not met to execute the request on the device.
    DEVICE_STORAGE_NOT_ENOUGH Insufficient storage space on the device.
    DEVICE_FATAL_ERROR Fatal error. Reboot the device and contact support if there is no improvement.
    errorMessage Error message
    Response Schema application/json Explanation
    errorCode API_KEY_NOT_FOUND API Key is not found.
    ACCESS_KEY_NOT_FOUND Access Key is not found.
    ASSET_NOT_FOUND Asset is not found.
    ASSET_TOTAL_SIZE_ERROR The total size of the uploaded assets has exceeded the limit.
    INVALID_API_KEY The API Key is invalid.
    INVALID_ACCESS_KEY The Access Key is invalid.
    INVALID_ARGUMENT Invalid argument. Need to check the request parameters.
    INVALID_CSR Invalid argument. CSR is invalid.
    INVALID_TOKEN Token is invalid.
    INTERNAL_SERVER_ERROR Internal server error.
    SERVICE_UNAVAILABLE Service unavailable.
    REQUEST_NOT_FOUND Request is not found.
    RESOURCE_BUSY Resource is busy.
    RESOURCE_NOT_FOUND Resource is not found(except DEVICE_NOT_FOUND).
    DEVICE_NOT_FOUND The device is not found.
    DEVICE_NOT_SUPPORT The device is not support the api.
    DEVICE_NOT_READY The device is not ready.
    DEVICE_NOT_ONLINE The device is not online.
    DEVICE_NETWORK_ERROR A network error is occurred on the device.
    DEVICE_BUSY The device is busy. Please wait for a while and retry.
    DEVICE_PRECONDITION_FAILED Precondition is not met to execute the request on the device.
    DEVICE_STORAGE_NOT_ENOUGH Insufficient storage space on the device.
    DEVICE_FATAL_ERROR Fatal error. Reboot the device and contact support if there is no improvement.
    errorMessage Error message
    Response Schema application/json Explanation
    errorCode object  
    Response Schema application/json Explanation
    errorCode API_KEY_NOT_FOUND API Key is not found.
    ACCESS_KEY_NOT_FOUND Access Key is not found.
    ASSET_NOT_FOUND Asset is not found.
    ASSET_TOTAL_SIZE_ERROR The total size of the uploaded assets has exceeded the limit.
    INVALID_API_KEY The API Key is invalid.
    INVALID_ACCESS_KEY The Access Key is invalid.
    INVALID_ARGUMENT Invalid argument. Need to check the request parameters.
    INVALID_CSR Invalid argument. CSR is invalid.
    INVALID_TOKEN Token is invalid.
    INTERNAL_SERVER_ERROR Internal server error.
    SERVICE_UNAVAILABLE Service unavailable.
    REQUEST_NOT_FOUND Request is not found.
    RESOURCE_BUSY Resource is busy.
    RESOURCE_NOT_FOUND Resource is not found(except DEVICE_NOT_FOUND).
    DEVICE_NOT_FOUND The device is not found.
    DEVICE_NOT_SUPPORT The device is not support the api.
    DEVICE_NOT_READY The device is not ready.
    DEVICE_NOT_ONLINE The device is not online.
    DEVICE_NETWORK_ERROR A network error is occurred on the device.
    DEVICE_BUSY The device is busy. Please wait for a while and retry.
    DEVICE_PRECONDITION_FAILED Precondition is not met to execute the request on the device.
    DEVICE_STORAGE_NOT_ENOUGH Insufficient storage space on the device.
    DEVICE_FATAL_ERROR Fatal error. Reboot the device and contact support if there is no improvement.
    errorMessage Error message
    Last modified: 19 Feb 2025