Common APIs for IR Devices

Last Updated on : 2024-06-05 03:15:12download

API list

Action	Description
infrared.remotes	Get a list of remote controls that are bound with an IR device.

Get remote controls bound with IR device

API endpoint

action: infrared.remotes

API description

Get a list of remote controls that are bound with an IR device based on an IR device ID.

Request parameter

Parameter name	Type	Description	Required
infrared_id	String	The infrared device ID.	Yes

Response parameter

Parameter name	Type	Description
code	Integer	The response code. See Global Error Codes.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	List	The returned result.

Description of result

Parameter name	Type	Description
category_id	String	The device category ID.
brand_id	String	The brand ID.
brand_name	String	The name of the brand.
remote_id	String	The device ID of the remote control.
remote_name	String	The name of the remote control.
remote_index	String	The remote control index.
operator_id	String	The carrier ID. This parameter is required when the device category is the set-top box.
operator_name	String	The name of the carrier. This parameter is required when the device category is the set-top box.
area_id	String	The area ID. This parameter is required when the device category is the set-top box.
area_name	String	The name of the area. This parameter is required when the device category is the set-top box.
iptv_type	Integer	Indicates whether the device is an IPTV. Valid values: `1`: yes. `0`: no. This parameter is required when the device category is the set-top box.
t	Long	The 13-digit timestamp when the remote control was added to the IR device.

Sample request

{
  "action": "infrared.remotes",
  "params": {
    "infrared_id": "vdevo157924607038167"
  }
}

Sample response on success

{
    "success": true,
    "result": [
        {
            "category_id": "5",
            "brand_id": "97",
            "remote_id": "6cf1fd8b5fb7e090c97mqf",
            "remote_name": "Gree air conditioner",
            "remote_index": "10727" ,
            "t": 1539776581583
        },
        {
            "category_id": "1",
            "brand_id": "1017",
            "brand_name": "ZTE",
            "remote_id": "6c9a93cdaf677cfd151q3t",
            "operator_id": "42",
            "operator_name": "IPTV of China Telecom, Zhejiang Branch",
            "area_id": "330106",
            "area_name": "Xihu District, Hangzhou, Zhejiang, China",
            "remote_name": "Set-top box 11",
            "remote_index": "5129",
            "iptv_type": 1,
            "t": 1539776581583
        }
    ],
    "t": 1539776581583
}

Sample response on failure

{
    "success": false,
    "code": 500,
    "msg": "system error,please contact the admin"
}