Next-step Quick Match

Last Updated on : 2024-07-30 10:38:10download

After you test the keys returned by the first match, you call this API to continue matching. You can call it multiple times until the matching process is completed.

API address

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

Request parameter

Parameter nameTypeINRequiredDescription
infrared_idStringpathtrueThe device ID of the specified infrared remote control.

Description of body

Parameter nameTypeINRequiredDescription
category_idIntegerbodytrueThe ID of the specified product category.
brand_idIntegerbodytrueThe ID of the specified brand.
remote_indexIntegerbodytrueThe index ID of the specified remote control.
KeyStringbodytrueThe key.
is_matchIntegerbodytrueSpecifies whether the code library and the device are matched successfully. Valid values:
  • 0: The match failed.
  • 1: The match succeeded.

Return parameter

Parameter nameTypeDescription
resultQuickMatchLastResVOThe returned result of matching.

Description of result

Parameter nameTypeDescription
recommend_keyStringThe recommended key.
recommend_key_idIntegerThe ID of the specified recommended key.
recommend_remote_indexIntegerThe recommended index ID of the remote control.
matched_remote_indexsListThe list of matched remote control indexes.

Request example

POST: /v2.0/cloud/rc/infrared/quick-match/vdevo15345926009****/next-step
{
  "category_id": 5,
  "brand_id": 37,
  "remote_index": 2,
  "key": "M0_T18_S2",
  "is_match": false
}

Return example

{
    "tid": "c178bba348bb11ef825a5a25494a584c",
    "result": {
        "matched_remote_indexs": [
            5696,
            2,
            5676,
            4878,
            207
        ],
        "recommend_key": "M0_T18_S2",
        "recommend_remote_index": 2,
        "recommend_key_id": 0
    },
    "success": true
}

Error code

For more information, see error code.