Universal infrared

Normal Remote Control Pairing

Request Method	API	Description
GET	/v1.0/infrareds/{infrared_id}/categories	Get device types which are infrared supported
GET	/v1.0/infrareds/{infrared_id}/categories/ {category_id}/brands	Get a list of brands under the infrared device type
GET	/v1.0/infrareds/{infrared_id}/categories/ {category_id}/brands/{brand_id}	Add normal remote control
POST	/v1.0/infrareds/{infrared_id}/normal/add-remote	Add normal remote control

Get device types which are infrared supported

Function Description

The purpose of this interface is to obtain the types of devices that support infrared devices. Currently, only TVs, set-top boxes, air conditioners, fans, etc. are supported.

Interface Address

GET /v1.0/infrareds/{infrared_id}/categories

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result description

Parameter	Type	Description
category_id	String	Device Type Id
category_name	String	Device name

Return success example

{
  "success": true,
  "t": 1539776581583,
  "result": [{
      "category_id": "1",
      "category_name": "机顶盒 "
    },
    {
      "category_id": "2",
      "category_name": "电视"
    },
    {
      "category_id": "5",
      "category_name": "空调"
    }
  ]
}

Return failure example

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

Get a list of brands of a specified type

Function Description

According to the device category supported by the infrared device, this interface can obtain the brand information supported by this device type, and currently supports TV and air conditioner.

Interface Address

GET /v1.0/infrareds/{infrared_id}/categories/{category_id}/brands

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
category_id	String	URI	Device Type Id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
brand_id	String	Brand Id
brand_name	String	Brand Name

Return success example

{
  "success": true,
  "result": [{
      "brand_id": "907",
      "brand_name": "天龙"
    },
    {
      "brand_id": "3080",
      "brand_name": "易美逊"
    },
    {
      "brand_id": "472",
      "brand_name": "飞鹿"
    },
    {
      "brand_id": "352",
      "brand_name": "奥图码"
    },
    {
      "brand_id": "2427",
      " brand_name": "彩讯"
    },
    {
      "brand_id": "232",
      "brand_name": "三洋"
    },
    {
      "brand_id": "1216",
      "brand_name": "Kaisui"
    }
  ]
}

Return failure example

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

Get brand support remote control index list

Function Description

This interface is used to obtain the remote control index

Interface Address

GET /v1.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
category_id	String	URI	Device Type Id	Yes
brand_id	String	URI	Brand Id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result description

Parameter	Type	Description
remote_index	String	Remote control index

Return success example

{
  "success": true,
  "result": [{
      "remote_index": "1092"
    },
    {
      "remote_index": "1102"
    },
    {
      "remote_index": "1107"
    },
    {
      "remote_index": "1112"
    },
    {
      "remote_index": "1117"
    }
  ]
}

Return failure example

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

Add normal remote control

Function Description

Add normal remote control

Interface Address

POST /v1.0/infrareds/{infrared_id}/normal/add-remote

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
category_id	String	BODY	Device Type Id	Yes
brand_id	String	BODY	brand Id	NO
brand_name	String	BODY	Brand Name	No
remote_index	String	BODY	Remote control index	Yes
remote_name	String	BODY	Name of the remote control	NO

Request Example

{
  "category_id": "2",
  "category_name": "电视",
  "brand_id": "27",
  "brand_name": "TCL",
  "remote_index": "10982",
  "remote_name": "遥控器名称"
}

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	json	Specific parameters returned

result Description

Parameter	Type	Description
remote_id	String	Remote control device ID

Return success example

{
    "success": true,
    "result": {
        "remote_id": "6cb9e4eaf1e462b3d4ihh7"
    }
}

Return failure example

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

Pairing of the set-top box's remote control

API	Request Method	Description
/v1.0/infrareds/{infrared_id}/provinces	GET	Get a list of provinces
/v1.0/infrareds/{infrared_id}/provinces/ {province_id}/cities	GET	Get a list of cities
/v1.0/infrareds/{infrared_id}/provinces/ {province_id}/cities/{city_id}/areas	GET	Get a list of provinces
/v1.0/infrareds/{infrared_id}/areas/{area_id}/iptvs	GET	This interface can only be used if the device type is a set-top box. Other device types cannot be called
/v1.0/infrareds/{infrared_id}/operators/ {operator_id}/brands?country_code=	GET	This interface can only be used if the device type is a set-top box. Other device types cannot be called
/v1.0/infrareds/{infrared_id}/operators/ {operator_id}/brands/{brand_id}/iptvs	GET	This interface is used to obtain the remote control index
/v1.0/infrareds/{infrared_id}/operators/ {operator_id}/areas/{area_id}	GET	This interface is used to obtain the remote control index
/v1.0/infrareds/{infrared_id}/box/add-remote	GET	This interface is used to add set-top box remote control
/v1.0/infrareds/{infrared_id}/{remote_id}/channel	GET	This interface is used to query TV channel list
/v1.0/infrareds/{infrared_id}/channel/switch	GET	This interface is used to switch TV channels
/v1.0/infrareds/{infrared_id}/remotes/{remote_id}/send-batch-keys	POST	issue control command

Get a list of provinces

Function Description

Get a list of provinces

Interface Address

GET /v1.0/infrareds/{infrared_id}/provinces

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
province_id	Integer	Province Id
province_name	String	Name of province

Return success example

{
  "success": true,
  "result": [{
      "province_id": 120000,
      "province_name": "天津市"
    },
    {
      "province_id": 320000,
      "province_name": "江苏省"
    }
  ]
}

Return failure example

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

Get a list of cities

Function Description

Get a list of cities

Interface Address

GET /v1.0/infrareds/{infrared_id}/provinces/{province_id}/cities

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
province_id	Integer	URI	Province id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
province_id	Integer	Province Id
city_id	Integer	City id
city_name	String	City Name

Return success example

{
  "success": true,
  "result": [{
      "province_id": 330000,
      "city_id": 330700,
      "city_name": "金华市"
    },
    {
      "province_id": 330000,
      "city_id": 330800,
      "city_name": "温州市"
    }
  ]
}

Return failure example

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

Get a list of regions

Function Description

Get a list of provinces

Interface Address

GET /v1.0/infrareds/{infrared_id}/provinces/{province_id}/cities/{city_id}/areas

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
province_id	Integer	URI	Province id	Yes
city_id	Integer	URI	City id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
province_id	Integer	Province Id
city_id	Integer	City id
area_id	Integer	Area id
area_name	String	Zone name

Return success example

{
  "success": true,
  "result": [{
      "province_id": 330000,
      "city_id": 30500,
      "area_id": 330523,
      "area_name": "安吉县"
    },
    {
      "province_id": 330000,
      "city_id": 30500,
      "area_id": 330522,
      "area_name": "长兴县"
    }
  ]
}

Return failure example

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

Get a list of carriers by region

Function Description

This interface can only be used if the device type is a set-top box. 
Other device types cannot be called

Interface Address

GET /v1.0/infrareds/{infrared_id}/areas/{area_id}/iptvs

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
area_id	String	URI	Zone Id,accurate to zone	Yes

Retrun message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
operator_id	String	Carrier Id
operator_name	String	Carrier name
country_code	String	Country code
iptv_type	Integer	Iptv type（1：IPTV； 0：Not IPTV）

Return success example

{
  "success": true,
  "result": [{
    "operator_id": "1062",
    "operator_name": "成都电信IPTV",
    "country_code": "CN",
    "iptv_type": 1
  }]
}

Return failure example

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

Get Brand List: According to Carrier

Function Description

This interface can only be used if the device type is a set-top box. 
Other device types cannot be called

Interface Address

GET /v1.0/infrareds/{infrared_id}/operators/{operator_id}/brands?country_code=

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
operator_id	String	URI	Carrier id	Yes
country_code	String	URL	International Code (China:CN)	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
brand_id	String	Brand Id
brand_name	String	Brand Name

Return success example

{
  "success": true,
  "result": [{
      "brand_id": "907",
      "brand_name": "天龙"
    },
    {
      "brand_id": "3080",
      "brand_name": "易美逊"
    },
    {
      "brand_id": "472",
      "brand_name": "飞鹿 "
    },
    {
      "brand_id": "352",
      "brand_name": "奥图码"
    }
  ]
}

Return failure example

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

Get Remote Control Index List: According to IPTV Carrier

Function Description

This interface is used to obtain the remote control index

Interface Address

GET /v1.0/infrareds/{infrared_id}/operators/{operator_id}/brands/{brand_id}/iptvs

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
operator_id	String	URI	Carrier Id	Yes
brand_id	String	URI	Brand Id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
remote_index	String	Remote control index

Return success example

{
  "success": true,
  "result": [{
      "remote_index": "1092"
    },
    {
      "remote_index": "1102"
    },
    {
      "remote_index": "1107"
    },
    {
      "remote_index": "1112"
    },
    {
      "remote_index": "1117"
    }
  ]
}

Return failure example

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

Get Remote Control Index List: According to Non-IPTV Carrier

Function Description

This interface is used to obtain the remote control index

Interface Address

GET /v1.0/infrareds/{infrared_id}/operators/{operator_id}/areas/{area_id}

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
operator_id	String	URI	Carrier Id	Yes
area_id	String	URI	Area Id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
remote_index	String	Remote control index

Return success example

{
  "success": true,
  "result": [{
      "remote_index": "1092"
    },
    {
      "remote_index": "1102"
    },
    {
      "remote_index": "1107"
    },
    {
      "remote_index": "1112"
    },
    {
      "remote_index": "1117"
    }
  ]
}

Return failure example

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

Add set-top box remote control

Function Description

This interface is used to add set-top box remote control

Interface Address

POST /v1.0/infrareds/{infrared_id}/box/add-remote

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes

Body parameter

Parameter	Type	Description	Required
category_id	String	Device Type Id	Yes
brand_id	String	brand Id	Yes
brand_name	String	Brand Name	No
remote_index	String	Remote control index	Yes
remote_name	String	Name of the remote control	No
iptv_type	Integer	Whether it is IPTV（1：yes；0：not）	No
operator_id	String	Carrier Id	Yes
operator_name	String	Carrier name	No
area_id	String	Area id	No
area_name	String	Zone name	No

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	json	Specific parameters returned

result Description

Parameter	Type	Description
remote_id	String	Remote control device ID

Request Example

{
  "category_id": "1",
  "category_name": "机顶盒",
  "brand_id": "97",
  "brand_name": "机顶盒",
  "remote_index": "592",
  "remote_name": "浙江电信iptv",
  "operator_id": "0",
  "operator_name": "浙江电信 iptv",
  "area_id": "110107",
  "area_name": "北京"
}

Return success example

{
  "success": true,
  "result": {
    "remote_id": "6cb9e4eaf1e462b3d4ihh7"
  }
}

Return failure example

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

Query TV channel list

Function Description

This interface is used to query TV channel list

Interface Address

GET /v1.0/infrareds/{infrared_id}/{remote_id}/channel

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
remote_id	String	URI	Remote control device ID	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result description

Parameter	Type	Description
channel_name	String	Channel name
channel_alias	String	Alias
channel_num	String	Channel No.
hd	Integer	Whether it is HD(0:SD 1:HD)

Return success example

{
  "success": true,
  "t": 1543927305251,
  "result": [{
      "channel_name": "湖南卫视",
      "channel_alias": "芒果台",
      "channel_num": "15",
      "hd": 1
    },
    {
      "channel_name": "CCTV-1",
      "channel_alias": "中央一台",
      "channel_num": "1",
      "hd": 1
    }
  ]
}

Return failure example

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

Switch TV channels

Function Description

This interface is used to switch TV channels

Interface Address

POST  /v1.0/infrareds/{infrared_id}/channel/switch

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
remote_id	String	URL	Remote control device ID	Yes
remote_index	String	URL	Remote control index	Yes
channel_num	String	URL	Channel No.	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	Object	Specific parameters returned

Return success example

{
  "success": true,
  "t": 1545135036437,
  "result": true
}

Return failure example

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

Infrared code learning

API	Request Method	Description
/v1.0/infrareds/{infrared_id}/learning-state?state=true	PUT	update learning status
/v1.0/infrareds/{infrared_id}/learning-codes?learning_time=xxxx	GET	query learned infrared code
/v1.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes	POST	infrared code that is learned under the next
/v1.0/infrareds/{infrared_id}/learning-codes	POST	save the infrared code learned
/v1.0/infrareds/{infrared_id}/learning-remotes/{remote_index}	PUT	update the infrared code learned
/v1.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes	GET	get saved learning infrared code
/v1.0/infrareds/{infrared_id}/learning-codes/{learn_id}	DELETE	delete the infrared code learned

Update learning status

Function Description

update learning status

Interface Address

PUT /v1.0/infrareds/{infrared_id}/learning-state?state=true

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
state	String	URL	Learning mode , true learning mode,false non-learning mode	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	Object	Specific parameters returned

Return success example

{
  "success": true,
  "t": 1545135036437,
  "result": true
}

Return failure example

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

Query learned infrared code

Function Description

query learned infrared code

Interface Address

GET /v1.0/infrareds/{infrared_id}/learning-codes?learning_time=xxxx

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
learning_time	URL	Long	Time to enter learning mode	Yes

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

result Description

Parameter	Type	Description
success	Boolean	Whether to learn infrared code
code	String	Learned infrared code(the parameter ‘code’ is empty if the parameter ‘success’ is false，)

Return success example

{
  "success": true,
  "t": 1545135036437,
  "result": {
    "success": true,
    "code": "xxxxx"
  }
}

Return failure example

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

Infrared code that is learned under the next

Function Description

 infrared code that is learned under the next

Interface Address

POST /v1.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
remote_id	URL	String	Device Id(if not，fill in ‘TUYA’)	Yes
code	BODY	String	The infrared code you learned	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	Object	Specific parameters returned

Return success example

{
  "success": true,
  "t": 1545135036437,
  "result": true
}

Return failure example

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

Save the infrared code learned

Function Description

save the infrared code learned

Interface Address

POST /v1.0/infrareds/{infrared_id}/learning-codes

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
remote_id	BODY	String	Remote control id (value when it is for replication)	No
remote_index	BODY	String	Remote control index (value when it is for replication)	No
brand_id	BODY	String	Brand ID (value when it is a copy function)	No
brand_name	BODY	String	Brand name (value when it comes to copying feature)	No
codes	BODY	Array	Saved infrared information	Yes

codes Description

Parameter	Type	Description
name	String	The name of the infrared code learned
key_name	String	Learned infrared code key key name
code	String	The infrared code you learned

Request Example

{
  "codes": [{
      "code": "xxxxxxxx",
      "name": "wer123"
    },
    {
      "code": "xxxxxxxx",
      "name ": "123"
    }
  ]
}

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

result Description

Parameter	Type	Description
remote_id	String	Remote control id

Return success example

{
  "success": true,
  "t": 1545135036437,
  "result": {
    "remote_id": "xxxx"
  }
}

Return failure example

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

Update the infrared code learned

Function Description

update the infrared code learned

Interface Address

PUT /v1.0/infrareds/{infrared_id}/learning-remotes/{remote_index}

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
remote_index	URI	String	Remote control id	Yes
codes	BODY	Array	Saved infrared information	Yes

codes Description

Parameter	Type	Description
name	String	The name of the infrared code learned
key_name	String	Infrared code key name
code	String	The infrared code you learned

Request Example

{
  "codes": [{
      "code": "xxxxxxxx",
      "name": "wer123"
    },
    {
      "code": "xxxxxxxx",
      "name": "123"
    }
  ]
}

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

result Description

Parameter	Type	Description
remote_id	String	Remote control id

Return success example

{
  "success": true,
  "t": 1545135036437,
  "result": {
    "remote_id": "xxxx"
  }
}

Return failure example

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

Get saved learning infrared code

Function Description

get saved learning infrared code

Interface Address

GET /v1.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
remote_id	URI	String	Remote control ID	Yes

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

result Description

Parameter	Type	Description
code	String	The infrared code you learned
name	String	The name of the infrared code
key_name	String	Learned infrared code keys
id	Long	Learned infrared code id
remote_id	String	Remote control id

Response Example

{
  "success": true,
  "t": 1545375286851,
  "result": [{
      "name": "123",
      "key_name": "1",
      "code": "xxxxxxxx",
      "id": 253006,
      "remote_id": "6c2949716ca8f52c01aquk"
    },
    {
      "name": "456",
      "key_name": "2",
      "code": "xxxxxxx",
      "id": 253007,
      "remote_id": "6c2949716ca8f52c01aquk"
    }
  ]
}

Return failure example

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

Delete the infrared code learned

Function Description

delete the infrared code learned

Interface Address

DELETE /v1.0/infrareds/{infrared_id}/learning-codes/{learn_id}

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
learn_id	URI	Long	Learned infrared code id	Yes

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Boolean	Return results

Response Example

{
  "success": true,
  "t": 1545135036437,
  "result": true
}

Return failure example

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

Infrared Timed Mission

API	Request Method	Description
/v1.0/infrareds/{infrared_id}/timers	POST	add infrared timing tasks
/v1.0/infrareds/{infrared_id}/timers/ categories/{category_id}/remotes/{remote_index}	GET	get infrared timing mission
/v1.0/infrareds/{infrared_id}/timers/ groups/{group_id}	PUT	update infrared timing task
/v1.0/infrareds/{infrared_id}/timers groups/{group_id}	DELETE	delete infrared timing task
/v1.0/infrareds/{infrared_id}/timers	DELETE	delete all scheduled tasks
/v1.0/infrareds/{infrared_id}/timers/groups/{group_id}/status	PUT	Update infrared packet timing status

Add infrared timing tasks

Function Description

add infrared timing tasks

Interface Address

POST  /v1.0/infrareds/{infrared_id}/timers

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
category_id	BODY	String	Type of device	Yes
remote_index	BODY	String	Remote control index	Yes
loops	BODY	String	Seven digits consisting of 0 and 1, 0 for off,1 generation table on, for example : 0000010 on behalf of Sunday, Monday, Tuesday, Wednesday, Thursday, Saturday scheduled mission closed, Saturday scheduled task start	Yes
time_zone	BODY	String	Time Zone, China Pass UTC+08:00	Yes
timezone_id	BODY	String	ZoneId ,eg. Asia/shanghai	Yes
instruct	BODY	Array	Time-specific time and equipment instructions for timing tasks, support and set up multiple timed tasks at the same time	Yes

instruct Description

Parameter	Type	Description	Required
time	String	Time to schedule task execution	Yes
date	String	Date of timed task execution	No(if loops is 0000000，date format: 20181212)
key	String	Key obtained by pairing rules	Yes

Request Example

{
  "instruct":[
    {
      "key": "43",
      "time":  "17:42",
      "date":"20181218"
    },
    {
      "key" : "43",
      "time": "17:43",
      "date":"20181218"
     } 
  ],
  "loops":"0000000",
  "category_id": "1", 
  "remote_index": "5129",
  "timezone_id": "Asiz/Shanghai",
  "time_ zone": "+8:00"
}

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

result Description

Parameter	Type	Description
group_id	String	The id of the timed task

Response Example

{
    "success": true,
    "result": {
        "group_id": "0000002ftg"
     }
}

Return failure example

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

Get infrared timing mission

Function Description

get infrared timing mission

Interface Address

GET /v1.0/infrareds/{infrared_id}/timers/categories/{category_id}/remotes/{remote_index}

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
category_id	URI	String	Type of device	Yes
remote_index	URI	String	Remote control index	Yes

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

result Description

Parameter	Type	Description
groups	Array	Timed task information
category	Object	Timed task classification

group Description

Parameter	Type	Description
timers	Array	Timed task information
id	String	Timed task number

category Description

Parameter	Type	Description
category	String	Classification of scheduled tasks
status	Integer	Status of the classification of scheduled tasks

timers Description

Parameter	Type	Description
date	String	Set a date for a time
timezone_id	String	Time zone id
loops	String	Loop timing information
time	String	Set time
status	Integer	Status of scheduled tasks(0:off;1:on;2:deleted)
key	String	Timed instructions

Response Example

{
	"success": true,
	"t": 1545135036437,
	"result": {
		"category": {
			"category": "1",
			"status": "1"
		},
		"groups": [{
			"id": "1",
			"timers": [{
				"date": "20181218",
				"timezone_id": "Asiz/Shanghai",
				"loops": "0000000",
				"time": "17:42",
				"status": 1,
				"key": "43"
			}]
		}]
	}
}

Update infrared timing task

Function Description

update infrared timing task

Interface Address

PUT /v1.0/infrareds/{infrared_id}/timers/groups/{group_id}

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
group_id	URI	String	Timed task id	Yes
category_id	BODY	String	Type of device	Yes
remote_index	BODY	String	Remote Control Index
loops	BODY	String	Seven digits consisting of 0 and 1, 0 for off,1 generation table on, for example : 0000010 on behalf of Sunday, Monday, Tuesday, Wednesday, Thursday, Saturday scheduled mission closed, Saturday scheduled task start	Yes
time_zone	BODY	String	Time Zone, China Pass edgy .00	Yes
timezone_id	BODY	String	Time zone id ，eg.Asia/shanghai	Yes
instruct	BODY	Array	Time-specific time and equipment instructions for timing tasks, support and set up multiple timed tasks at the same time	Yes

instruct Description

Parameter	Type	Description	Required
time	String	Time to time a task to execute a line	Yes
date	String	The day date of the scheduled task to execute the line	No(if loops is 0000000，date format: 20181212)
key	String	Key obtained by pairing rules	Yes

Request Example

{
  "instruct": [{
    "key": "43",
    "time": "17:42",
    "date": "20181218"
  }, {
    "key": "43",
    "time": "17:43",
    "date": "20181218"
  }],
  "loops": "0000000",
  "category_id": "1",
  "remote_index": "5129",
  "timezone_id": "Asiz/Shanghai",
  "time_zone": "+8:00"
}

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

Response Example

{
  "success": true,
  "result": true
}

Return failure example

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

Delete infrared timing task

Function Description

delete infrared timing task

Interface Address

DELETE /v1.0/infrareds/{infrared_id}/timers/groups/{group_id} 

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
group_id	URI	String	Timed Task Group Id	Yes

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

Response Example

{
  "success": true,
  "t": 1545135036437,
  "result": true
}

Return failure example

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

Delete all scheduled tasks

Function Description

delete all scheduled tasks

Interface Address

DELETE /v1.0/infrareds/{infrared_id}/timers

Request Parameters

Parameter	Parameter Position	Type	Description	Required
infrared_id	URI	String	Infrared Device ID	Yes
group_id	URI	String	Timed Task Group Id	Yes

Return Message

Parameter	Type	Description
code	Integer	Response code (details see error code section)
success	Boolean	whether succeed（true:success,false:fail）
msg	String	Request failed information, success is empty
result	Object	Return results

Response Example

{
  "success": true,
  "t": 1545135036437,
  "result": true
}

Return failure example

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

Update infrared packet timing status

Function Description

Update infrared packet timing status

Interface Address

PUT /v1.0/infrareds/{infrared_id}/timers/groups/{group_id}/status

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	URI	String	infrared id	是
group_id	URI	String	group Id	是

BODY Parameter

Parameter	Type	Parameter Position	Description	Required
value	body	String	value	是

Return Message

Parameter	Type	Description
code	Integer	Response code (see the error code section for details)
success	Boolean	Whether it is successful: (true: success, false: failure)
msg	String	Request failed information, successfully empty
result	List	Result

Request Example

PUT /v1.0/infrareds/{infrared_id}/timers/groups/{group_id}/status

{
  "value": "1"
}

Response Example

{
    "success": true,
    "t": 1545135036437,
    "result":true
}

Air conditioning class remote control

API	Request Method	Description
/v1.0/infrareds/{infrared_id}/ac/send-keys	POST	The combined air conditioner delivery command is mainly related to four states: power mode temp fan
/v1.0/infrareds/{infrared_id}/remotes/{remote_id}/ac/status	GET	query air conditioning status

Control air conditioning

Function Description

The combined air conditioner delivery command is mainly related to four states: power mode temp fan

1, open the air conditioning command to pass parameters: power = 1, other values are null;

2, turn off the air conditioning command pass parameters: power = 0, other values are null;

3, control air conditioning mode pass parameters: power = 1, mode = [0 - 4], other values are null;

4, control the specific temperature of the air conditioning parameters: power = 1, temp = specific temperature value, other values are null;

5, increase the air conditioning temperature parameters: power = 1, temp = 1, other values are null;

6, reduce the air conditioning temperature parameters: power = 1, temp = -1, other values are null;

7, control air conditioning wind speed parameters: power = 1, fan = [0 - 3], other values are null;

8, increase the air conditioning wind speed transmission parameters: power = 1, fan = 100, other values are null;

9, reduce the air conditioning wind speed transmission parameters: power = 1, fan = -100, other values are null;

Modes 0-4 represent: cooling, heating, automatic, air supply, dehumidification

Wind speed 0-3: automatic, low speed, medium speed, high speed

Temp = specific temperature value, - > temperature range 16 - 31

Interface Address

POST /v1.0/infrareds/{infrared_id}/ac/send-keys

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes

body parameter

Parameter	Type	Description	Required
remote_id	String	Remote control id(empty string stomps other fields for test mode)	Yes
remote_index	String	Remote control index	Yes
power	String	Switch (1: On 0: Off)	Yes
mode	String	Mode (0: cooling, 1: heating, 2: automatic, 3: air supply, 4: dehumidification)	No
temp	String	Temperature (16-30)	No
wind	String	Wind speed (0: automatic, 1: low, 2: medium, 3: high)	No
swing	String	Wind direction (0-2) not supported at this time	No

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	boolean	Specific parameters returned

Request Example

{
  "remote_id": "6cb2fb33541a44967fxqhy",
  "remote_index": "11842",
  "power": "1",
  "mode": "2",
  "temp": "20",
  "wind": "1"
}

Return success example

{
  "success": true,
  "result": true
}

Return failure example

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

Query air conditioning status

Function Description

query air conditioning status

Interface Address

GET /v1.0/infrareds/{infrared_id}/remotes/{remote_id}/ac/status

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
remote_id	Stirng	URI	Remote control id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

**result description **

Parameter	Type	Description
mode	String	Mode
temp	String	Temperature
wind	String	Wind speed
power	String	Switch
remote_id	String	Air conditioning remote control id

Return success example

{
  "success": true,
  "t": 1543927305251,
  "result": {
    "mode": "0",
    "temp": "20",
    "remote_id": "6cb2fb33541a44967fxqhy",
    "wind": "3"
  }
}

Return failure example

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

Universal Interface

API	Request Method	Description
/v1.0/infrareds/{infrared_id}/remotes	GET	obtain a list of remote controls bound under the infrared device
/v1.0/infrareds/{infrared_id}/add-remote	POST	Add remote controls
/v1.0/infrareds/{infrared_id}/remotes/{remote_id}	DELETE	remove remote control
/v1.0/infrareds/{infrared_id}	PUT	set remote control alias
/v1.0/infrareds/{infrared_id}/categories/{category_id}/brands/ {brand_id}/remotes/{remote_index}/rules	GET	This interface is used to get the pairing rules for the remote control, and the key in the return value is the key of the interface that issues the infrared code according to the key
/v1.0/infrareds/{infrared_id}/send-keys	POST	This interface is based on the key to issue an infrared code, the key in the request parameter is obtained from the get pairing rule key,currently this interface only supports tv and set-top box, Air conditioning has its own separate release rules.
/v1.0/infrareds/{infrared_id}/remotes/{remote_id}/send-keys.	POST	Key release based on common rules,key can refer to Appendix

Get a list of remote controls bound under infrared devices

Function Description

This interface is based on the infrared device Id to obtain a list of remote controls bound under the infrared device

Interface Address

GET /v1.0/infrareds/{infrared_id}/remotes

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result description

Parameter	Type	Description
category_id	String	Device Type Id
brand_id	String	brand Id
brand_name	String	Brand Name
remote_id	String	Remote control device ID
remote_name	String	Name of the remote control
remote_index	String	Remote control index
operator_id	String	Carrier Id(value when device type is set-top box)
operator_name	String	Carrier name (value when device type is set-top box)
area_id	String	Zone Id(value when device type is set-top box)
area_name	String	Zone name (value when device type is set-top box)
iptv_type	Integer	IPTV type(1:Yes;0:No has value when device type is set-top box)
t	Long	Add time (thirteen-digit standard timestamp)

Return success example

{
  "success": true,
  "result": [{
      "category_id": "5",
      "brand_id": "97",
      "remote_id": "6cf1fd8b5fb7e090c97mqf",
      "remote_name": "格力空调",
      "remote_index": "10727",
      "t": 1539776581583
    },
    {
      "category_id": "1",
      "brand_id": "1017",
      "brand_name": "中兴",
      "remote_id": "6c9a93cdaf677cfd151q3t",
      "operator_id": "42",
      "operator_name": "浙江电信IPTV",
      "area_id": "330106",
      "area_name": "浙江省杭州市西湖区",
      "remote_name": "机顶盒 11",
      "remote_index": "5129",
      "iptv_type": 1,
      "t": 1539776581583
    }
  ]
}

Request failed return example

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

Add remote control

Function Description

This interface can be added to the remote control of devices such as STB, TVs, air conditioners

Interface Address

POST /v1.0/infrareds/{infrared_id}/add-remote

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes

body parameter

Parameter	Type	Description
category_id	String	Device Type Id
brand_id	String	brand Id
brand_name	String	Brand Name
remote_index	String	Remote control index
remote_name	String	Name of the remote control
operator_id	String	Carrier Id(value when device type is set-top box)
operator_name	String	Carrier name (value when device type is set-top box)
area_id	String	Zone Id(value when device type is set-top box)
area_name	String	Zone name (value when device type is set-top box)
iptv_type	Integer	IPTV type(1:Yes;0:No has value when device type is set-top box)

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	json	Specific parameters returned

result description

Parameter	Type	Description
remote_id	String	Remote control device ID

Request Example

{
	"category_id":"5",
	"brand_id":"37",
	"brand_name":"海尔",
	"remote_index":"657",
	"remote_name":"海尔空调遥控器",
	"operator_id":"",
	"operator_name":"",
	"area_id":"",
	"area_name":"",
	"iptv_type":""
}

Return success example

{
    "result": {
        "remote_id": "6ca8ff6dcaf9bf7f40x45x"
    },
    "success": true,
    "t": 1580962693233
}

Request failed return example

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

Remove remote control

Function Description

remove remote control

Interface Address

DELETE /v1.0/infrareds/{infrared_id}/remotes/{remote_id}

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
remote_id	String	URI	Remote control device ID	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	boolean	Specific parameters returned

Return success example

{
  "success": true,
  "result": true
}

Request failed return example

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

Set remote control alias

Function Description

set remote control alias

Interface Address

PUT /v1.0/infrareds/{infrared_id}

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes

body parameter

Parameter	Type	Description	Required
remote_id	String	Remote control device ID	Yes
remote_name	String	Remote control alias	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	boolean	Specific parameters returned

Request Example

{
  "remote_id": "6cb5e6ed55541f4320eeyf",
  "remote_name": "空调 1"
}

Return success example

{
  "success": true,
  "result": true
}

Request failed return example

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

Get remote control pairing rules

Function Description

This interface is used to get the pairing rules for the remote control, and the key in the return value is the key of the interface that issues the infrared code according to the key

Interface Address

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

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
category_id	String	URI	Device Type Id	Yes
brand_id	String	URI	brand Id,If there is no brand, pass 0	Yes
remote_index	String	URI	Remote control index	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	array	Specific parameters returned

result Description

Parameter	Type	Description
key_name	String	Key name
key	String	Match Id
desc	String	Key description
code	String	Infrared code

Successful return of data example (normal remote control)

{
  "success": true,
  "result": [{
      "key": "1",
      "desc": "电源",
      "key_name": "power",
      "code": "5jCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
    },
    {
      "key ": "42",
      "desc": "确认",
      "key_name": "ok",
      "code": "54CYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
    },
    {
      "key": "43",
      "desc": "频道+",
      "key_ name": "channel_up",
      "code": "09CCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
    }
  ]
}

Successful return data example (air conditioning remote control)

{
  "success": true,
  "result": [{
      "key": "0",
      "desc": null,
      "key_name": "M0_T16_S0",
      "code": "5jCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
    },
    {
      "key": "0",
      "desc": null,
      "key_name": "M0_T16_S1",
      "code": "11CCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
    },
    {
      "key": "0",
      "desc": null,
      "key_name": "M0_T16_S2",
      "code": "90sCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
    },
    {
      "key": "0",
      "desc": null,
      "key_name": "M0_T16_S3",
      "code": "7dCCYZ55TmdmWoKreGWbE2HGP9 BFG9QuaLUVy6jVNsU="
    },
    {
      "key": "0",
      " desc": null,
      "key_name": "M0_T17_S0",
      "code": "6vbCCYZ55TmdmWoKreGWbE2HGP9BFG9QuaLUVy6jVNsU="
    }
  ]
}

Request failed return example

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

Control Remote Control: Based on Pairing Rules

Function Description

This interface is based on the key to issue an infrared code, the key in the request parameter  is obtained from the get pairing rule key,currently this interface only supports tv and set-top box, Air conditioning has its own separate release rules. 

Interface Address

POST /v1.0/infrareds/{infrared_id}/send-keys

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes

body parameter

Parameter	Type	Description	Description	Required
key	String	Infrared code key	This key is from getting pairing rules to get key	Yes
remote_index	String	Remote control index	Remote control index	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	boolean	Specific parameters returned

Request Example

{
  "remote_index": "5129",
  "key": "43"
}

Return success example

{
  "success": true,
  "result": true
}

Request failed return example

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

Control Remote Control: Based on the added remote

Function Description

Key release based on the added remote,key can refer to Appendix

Interface Address

POST /v1.0/infrareds/{infrared_id}/remotes/{remote_id}/send-keys

Request Parameters

Parameter	Type	Parameter Position	Description	Required
infrared_id	String	URI	Infrared Device Id	Yes
remote_id	String	URI	Remote control id	Yes
key	String	BODY	Universal keys,body parameters	Yes

Return Message

Parameter	Type	Description
success	boolean	Whether it was successful
result	boolean	Specific parameters returned

Request Example

{
  "key": "Power"
}

Return success example

{
  "success": true,
  "result": true
}

Request failed return example

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

Appendix

TV

key	Description
Power	Power
OK	Confirm
Channel+	Channels . . .
Channel-	Channel -
Menu	Menu
Up	On
Down	Next
Left	Left
Right	Right
Volume+	Volume s. . .
Volume-	Volume -
Return	Return
Homepage	Home
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8
9	9

Stb

key	Description
Power	Power
OK	Confirm
Channel+	Channels . . .
Channel-	Channel -
Up	On
Down	Next
Left	Left
Right	Right
Volume+	Volume s. . .
Volume-	Volume -
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8
9	9
#	#
Mute	Mute
Return	Return
Homepage	Home
Backward	Reback
Play	Play
Forward	Fast forward
Stop	Stop it
Pause	Time out
Prev	Top
Next	Next page
TV	Live
Demand	On-demand
Red	Red
Green	Green
Blue	Blue
Yellow	Yellow
Audio	Channel
Favorite	Collection
Information	Information
Setup	Set up
F1	F1
F2	F2
F3	F3
F4	F4
Help	Help
*	Input
Location	Positioning
Review	Look back
Desktop	Desktop
MemorySwitch	Memory / Switching

air conditioning

key	Description
PowerOn	Power On
PowerOff	Power Off
M0-M4	Mode 1-Mode 4 (Cooling, Heating, Automatic, Heating, Dehumidification)
T16-T30	Temperature 16-30
F0-F3	Wind speed 1-High speed 4 (Auto, low, medium, high speed)

fan

key	Description
PowerOn	Power On
PowerOff	Power Off
Swing	Oscillate fan
Speed	Fan speed
Timing	Timing