Cloud Services API ReferenceAdvanced Device ServicesExtension APIsIR Control Hub Open ServiceCommon APIs for Infrared DevicesGet Remote Control List

Get Remote Control List

Last Updated on : 2024-02-29 09:27:40download

Get a list of remote controls under the specified device based on the device ID.

API address

GET: /v2.0/infrareds/{infrared_id}/remotes

Request parameter

Parameter name	Type	IN	Required	Description
infrared_id	String	uri	true	The device ID.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
category_id	Integer	The ID of a specified category.
brand_id	Integer	The ID of a specified brand.
brand_name	String	The name of a specified brand.
remote_id	String	The ID of a specified remote control.
operator_id	Integer	The ID of a specified carrier.
operator_name	String	The name of a specified carrier.
area_id	Integer	The ID of a specified region.
area_name	String	The name of a specified region.
remote_name	String	The name of a specified remote control.
remote_index	Integer	The ID of a specified remote control index.

Request example

GET: /v2.0/infrareds/vdevo15345926009****/remotes

Return example

{
    "result": [
        {
            "area_name": "** District, ** City, ** Province",
            "remote_index": 111,
            "operator_id": 1,
            "remote_id": "6ce6b0392e09f778bf****",
            "brand_name": "Brand name",
            "area_id": 111,
            "brand_id": 111,
            "operator_name": "Zhejiang WASU",
            "category_id": 1,
            "remote_name": "Set-top box 26"
        }
    ],
    "t": 1630662091160,
    "success": true
}

Error code

For more information, see error code.

Prev DocSend Key Command

Next DocSend Key Command (During Pairing)