First-time Quick Match

Last Updated on : 2024-07-30 10:31:56download

During the first-time match, get information about the recommended keys.

API address

POST: /v2.0/cloud/rc/infrared/quick-match/{infrared_id}/first-step

Request parameter

Parameter name	Type	IN	Required	Description
infrared_id	String	path	true	The device ID of the specified infrared remote control.

Description of body

Parameter name	Type	IN	Required	Description
category_id	Integer	body	true	The ID of the specified product category.
brand_id	Integer	body	true	The ID of the specified brand.

Return parameter

Parameter name	Type	Description
result	QuickMatchFirstResVO	The returned result of matching.

Description of result

Parameter name	Type	Description
recommend_key	String	The recommended key.
recommend_key_id	Integer	The ID of the specified recommended key.
recommend_remote_id	Integer	The recommended index ID of the remote control.

Request example

POST: /v2.0/cloud/rc/infrared/quick-match/vdevo15345926009****/first-step

{
  "category_id": 5,
  "brand_id": 37
}

Return example

{
    "tid": "2ed56bba48b911ef825a5a25494a584c",
    "result": {
        "recommend_key": "power_on",
        "recommend_remote_id": 2,
        "recommend_key_id": 0
    },
    "t": 1721714567270,
    "success": true
}

Error code

For more information, see error code.