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 NameURL
Switch Channel TablePUT:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels
Switch ChannelsPOST:/v2.0/infrareds/{infrared_id}/channel/switch
Delete Custom Channel TableDELETE:/v2.0/infrareds/{infrared_id}/remote/custom/{submit_id}
Update Custom Channel TablePUT:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/custom/{submit_id}
Get Carriers by Region IDGET:/v2.0/infrareds/{infrared_id}/areas/{area_id}/operators
Get Channel ListGET:/v2.0/infrareds/{infrared_id}/remote/channels
Get Channel ListGET:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels
Get All Channel NamesGET:/v2.0/infrareds/{infrared_id}/remote/all-channels
Get Region ListGET:/v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities/{city_id}/areas
Get Province ListGET:/v2.0/infrareds/{infrared_id}/provinces
Get Channels Bound with Set-Top BoxGET:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/selected-channels
Get City ListGET:/v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities

Infrared Smart Match APIs

API NameURL
Get Token by Smart MatchingPOST:/v2.0/infrareds/{infrared_id}/matching-remotes/token
Get Matching Result by TokenGET:/v2.0/infrareds/{infrared_id}/matching-remotes

Infrared Air Conditioner APIs

API NameURL
Control Air Conditioner with Multiple KeysPOST:/v2.0/infrareds/{infrared_id}/air-conditioners/{remote_id}/scenes/command
Send Single CommandPOST:/v2.0/infrareds/{infrared_id}/air-conditioners/testing/command
Send Key CombinationPOST:/v2.0/infrareds/{infrared_id}/air-conditioners/testing/scenes/command
Get Air Conditioner StatusGET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/ac/status
Control Air Conditioner with Single CommandPOST:/v2.0/infrareds/{infrared_id}/air-conditioners/{remote_id}/command
Get Air Conditioner Status in BulkGET:/v1.0/cloud/rc/infrared/ac/status/batch

Infrared Timer APIs

API NameURL
Add Infrared Scheduled TaskPOST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Update Scheduled TaskPUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Update Scheduled Task StatusPUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers/status
Get Infrared Scheduled TaskGET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Delete Scheduled TaskDELETE:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers

Infrared Common APIs

API NameURL
Get Remote Control BrandGET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/remotes/{remote_index}/brands
Get Infrared Code Library InformationGET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remotes/{remote_index}/rules
Get Keys of Remote ControlGET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/keys
Send Standard CommandPOST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/command
Get Brand ListGET:/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 IndexesGET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remote-indexs
Send Key CommandPOST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/raw/command
Get Remote Control ListGET:/v2.0/infrareds/{infrared_id}/remotes
Send Key Command (During Pairing)POST:/v2.0/infrareds/{infrared_id}/testing/raw/command
Delete Remote ControlDELETE:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}
Add Remote ControlPOST:/v2.0/infrareds/{infrared_id}/remotes
Modify Remote Control NamePUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}
Get Category ListGET:/v2.0/infrareds/{infrared_id}/categories

Infrared Learning APIs

API NameURL
Update Learning CodePUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Save Learning CodePOST:/v2.0/infrareds/{infrared_id}/learning-codes
Send Learning CodePOST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Get Learning CodesGET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Modify Learning StatusPUT:/v2.0/infrareds/{infrared_id}/learning-state
Get Learned Remote Control CodeGET:/v2.0/infrareds/{infrared_id}/learning-codes
Delete Learning CodeDELETE:/v2.0/infrareds/{infrared_id}/learning-codes/{learn_id}
Get General Key InformationGET:/v2.0/infrareds/{category_id}/base-key