IR Control Hub Open Service

Last Updated on : 2023-06-15 05:15:27

Provide OpenAPI for the control of universal Infrared remote connecting to multi-brand, multi-category devices.

Infrared x-box APIs

API Name	URL
Switch Channel Table	PUT:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels
Switch Channels	POST:/v2.0/infrareds/{infrared_id}/channel/switch
Delete Custom Channel Table	DELETE:/v2.0/infrareds/{infrared_id}/remote/custom/{submit_id}
Update Custom Channel Table	PUT:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/custom/{submit_id}
Get Carriers by Region ID	GET:/v2.0/infrareds/{infrared_id}/areas/{area_id}/operators
Get Channel List	GET:/v2.0/infrareds/{infrared_id}/remote/channels
Get Channel List	GET:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels
Get All Channel Names	GET:/v2.0/infrareds/{infrared_id}/remote/all-channels
Get Region List	GET:/v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities/{city_id}/areas
Get Province List	GET:/v2.0/infrareds/{infrared_id}/provinces
Get Channels Bound with Set-Top Box	GET:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/selected-channels
Get City List	GET:/v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities

Infrared Smart Match APIs

API Name	URL
Get Token by Smart Matching	POST:/v2.0/infrareds/{infrared_id}/matching-remotes/token
Get Matching Result by Token	GET:/v2.0/infrareds/{infrared_id}/matching-remotes

Infrared Air Conditioner APIs

API Name	URL
Control Air Conditioner with Multiple Keys	POST:/v2.0/infrareds/{infrared_id}/air-conditioners/{remote_id}/scenes/command
Send Single Command	POST:/v2.0/infrareds/{infrared_id}/air-conditioners/testing/command
Send Key Combination	POST:/v2.0/infrareds/{infrared_id}/air-conditioners/testing/scenes/command
Get Air Conditioner Status	GET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/ac/status
Control Air Conditioner with Single Command	POST:/v2.0/infrareds/{infrared_id}/air-conditioners/{remote_id}/command
Get Air Conditioner Status in Bulk	GET:/v1.0/cloud/rc/infrared/ac/status/batch

Infrared Timer APIs

API Name	URL
Add Infrared Scheduled Task	POST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Update Scheduled Task	PUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Update Scheduled Task Status	PUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers/status
Get Infrared Scheduled Task	GET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Delete Scheduled Task	DELETE:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers

Infrared Common APIs

API Name	URL
Get Remote Control Brand	GET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/remotes/{remote_index}/brands
Get Infrared Code Library Information	GET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remotes/{remote_index}/rules
Get Keys of Remote Control	GET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/keys
Send Standard Command	POST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/command
Get Brand List	GET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands
Send Standard Command (During Pairing)	POST:/v2.0/infrareds/{infrared_id}/testing/command
Get Remote Control Indexes	GET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remote-indexs
Send Key Command	POST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/raw/command
Get Remote Control List	GET:/v2.0/infrareds/{infrared_id}/remotes
Send Key Command (During Pairing)	POST:/v2.0/infrareds/{infrared_id}/testing/raw/command
Delete Remote Control	DELETE:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}
Add Remote Control	POST:/v2.0/infrareds/{infrared_id}/remotes
Modify Remote Control Name	PUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}
Get Category List	GET:/v2.0/infrareds/{infrared_id}/categories

Infrared Learning APIs

API Name	URL
Update Learning Code	PUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Save Learning Code	POST:/v2.0/infrareds/{infrared_id}/learning-codes
Send Learning Code	POST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Get Learning Codes	GET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Modify Learning Status	PUT:/v2.0/infrareds/{infrared_id}/learning-state
Get Learned Remote Control Code	GET:/v2.0/infrareds/{infrared_id}/learning-codes
Delete Learning Code	DELETE:/v2.0/infrareds/{infrared_id}/learning-codes/{learn_id}
Get General Key Information	GET:/v2.0/infrareds/{category_id}/base-key

Prev DocDevice Status & Settings API

Next DocCommon APIs for Infrared Devices