Cloud Services API ReferenceAdvanced Device ServicesExtension APIsIR Control Hub Open ServiceCommon APIs for Infrared DevicesGet Infrared Code Library Information

Get Infrared Code Library Information

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

Get the infrared code information of the remote control based on the remote control index ID.

API address

GET: /v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remotes/{remote_index}/rules

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.
remote_index	Integer	uri	true	The ID of a specified remote control.

Return parameter

Parameter name	Type	Description
result	List

Description of result

Parameter name	Type	Description
key_id	Integer	The key ID.
key	String	The key.
key_name	String	The name of a specified key.
code	String	The code of a specified key.

Request example

GET: /v2.0/infrareds/vdevo15345926009****/categories/0/brands/222/remotes/555/rules

Return example

{
    "result": [
        {
            "code": "BB4LmVTniWRbOZ7Y4v0oFKoFYAJJffa+aNWu8g+zVz0=",
            "key_id": 1,
            "key_name": "Power supply",
            "key": "power"
        }
    ],
    "t": 1630918169311,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Remote Control Brand

Next DocGet Keys of Remote Control