Cloud Services API ReferenceAdvanced Device ServicesExtension APIsIR Control Hub Open ServiceInfrared Learning APIsSave Learning Code

Save Learning Code

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

Save the remote control code learned by the device and generate a DIY remote control.

API address

POST: /v2.0/infrareds/{infrared_id}/learning-codes

Request parameter

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

Description of body

Parameter name	Type	Required	Description
category_id	Integer	false	The ID of a specified category.
brand_id	Integer	false	The ID of a specified brand.
brand_name	String	false	The name of a specified brand.
remote_name	String	false	The name of a specified remote control.
codes	List	false	The list.

Description of codes

Parameter name	Type	Required	Description
category_id	Integer	false	The ID of a specified category.
key_name	String	false	The name of a specified key.
key	String	true	The key of a specified infrared code. It is used to distinguish the keys when there are multiple learning keys.
code	String	true	The infrared code.
id	Long	false	The key ID.

Return parameter

Parameter name	Type	Description
result	String	The ID of a specified remote control.

Request example

POST: /v2.0/infrareds/vdevo15345926009****/learning-codes

{
  "category_id": 1,
  "remote_name": "test",
  "codes": [
    {
      "code": "c42230112602f401260226022602260226022602260226022602260226027206260226022602720626027206260272062602720626027206260272065802f401260272062602260226027206260226022602260226024006260226022602260226022602260272062602260226027206260272062602260258024006260272062602720626024c9af6226608260220bf",
      "key": "test"
    }
  ]
}

Return example

{
    "result": "d5s65ca55",
    "t": 1631089922125,
    "success": true
}

Error code

For more information, see error code.

Prev DocUpdate Learning Code

Next DocSend Learning Code