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

Get Remote Control Indexes

Last Updated on : 2023-06-20 14:54:06download

Get a list of remote control indexes based on the brand ID.

API address

GET: /v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remote-indexs

Request parameter

Parameter name	Type	IN	Required	Description
infrared_id	String	uri	true	The device ID.
category_id	Integer	uri	true	The ID of a specified category.
brand_id	Integer	uri	true	The ID of a specified brand.
country_code	String	query	false	The country code.
mode	String	query	false	The name of a specified model.
page	Integer	query	false	The page number.
size	Integer	query	false	The number of entries per page. Maximum value: `1,000`.

Return parameter

Parameter name	Type	Description
result	RemoteResultVO	The returned result.

Description of result

Parameter name	Type	Description
total_count	Integer	The total number of remote controls.
remote_index_list	List	The list of remote control indexes.

Description of remote_index_list

Parameter name	Type	Description
remote_index	Integer	The ID of a specified remote control index.

Request example

GET: /v2.0/infrareds/vdevo15345926009****/categories/0/brands/222/remote-indexs?countryCode=CN

{
  "page": 1,
  "size": 10,
  "mode": ""
}

Return example

{
    "result": {
        "remote_index_list": [
            {
                "remote_index": 2417
            },
            {
                "remote_index": 5152
            },
            {
                "remote_index": 2702
            },
            {
                "remote_index": 3967
            },
            {
                "remote_index": 4052
            }
        ],
        "total_count": 5
    },
    "t": 1630911158824,
    "success": true
}

Error code

For more information, see error code.

Prev DocSend Standard Command (During Pairing)

Next DocSend Key Command