Universal Infrared

API List

Request method	API	description
GET	/v1.0/osaas/infrared/categories/{category_id}/brands	API for Obtaining the List of Infrared Device Brands.
GET	/v1.0/osaas/infrared/categories/{category_id}/brands/{brand_id}/remotes	API for Obtaining the List of Remote Control Index by supported brands.
GET	/v1.0/osaas/infrared/provinces	API for Obtaining the List of Provinces.
GET	/v1.0/osaas/infrared/provinces/{province_id}/cities	API for Obtaining the List of Cities.
GET	/v1.0/osaas/infrared/cities/{city_id}/areas	API for Obtaining the List of Areas.
GET	/v1.0/osaas/infrared/areas/{area_id}/operators	API for Obtaining the List of Carriers.
GET	/v1.0/osaas/infrared/areas/{area_id}/operators/{operator_id}/remotes	API for Obtaining the List of Remote Control index.
GET	/v1.0/osaas/infrared/operators/{operator_id}/brands	API for Obtaining the List of Brands by Carrier.
GET	/v1.0/osaas/infrared/operators/{operator_id}/brands/{brand_id}/remotes	API for Obtaining the List of Remote Control Index by Brand.

API for Obtaining the List of Infrared Device Brands

API Description

You can use this API to obtain the list of Infrared device brands(Ordinary remote control).

API Address

GET /v1.0/osaas/infrared/categories/{category_id}/brands

Request Parameters

Parameter	Type	Position	Description	Mandatory
category_id	String	URL	Unique ID of a infrared device category.	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Arrays	List of infrared device brand.

Parameters in result

Parameter	Type	Description
brand_id	String	Unique ID of a brand.
brand_name	String	Brand name.

Request Example

GET {url}/v1.0/osaas/infrared/categories/1/brands

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    {
      "brand_id": "907",
      "brand_name": "天龙"
    }
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Obtaining the List of Remote Control Index by supported brands

API Description

You can use this API to obtain the indexes of all remote control models of a specified brand by brand ID.

API Address

GET /v1.0/osaas/infrared/categories/{category_id}/brands/{brand_id}/remotes

Request Parameters

Parameter	Type	Position	Description	Mandatory
category_id	String	URI	Unique ID of a infrared device category.	Yes
brand_id	String	URI	Unique ID of a brand.	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Arrays	List of remote control index

Request Example

GET {url}/v1.0/osaas/infrared/categories/2/brands/12/remotes

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    "1000384"
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Obtaining the List of Provinces

API Description

You can use this API to obtain the list of provinces.

API Address

GET /v1.0/osaas/infrared/provinces

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Arrays	List of provinces

Parameters in result

Parameter	Type	Description
province_id	String	Unique ID of a province.
province_name	String	Province name

Request Example

GET {url}/v1.0/osaas/infrared/provinces

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    {
      "province_id": 120000,
      "province_name": "天津市"
    }
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Obtaining the List of Cities

API Description

You can use this API to obtain the list of cities.

API Address

GET /v1.0/osaas/infrared/provinces/{province_id}/cities

Request Parameters

Parameter	Type	Position	Description	Mandatory
province_id	String	URI	Unique ID of a province.	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Arrays	List of cities.

Parameters in result

Parameter	Type	Description
province_id	Integer	Unique ID of a province.
city_id	Integer	Unique ID of a city.
city_name	String	City name.

Request Example

GET {url}/v1.0/osaas/infrared/provinces/330000/cities

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    {
      "province_id": 330000,
      "city_id": 330700,
      "city_name": "金华市"
    }
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Obtaining the List of Areas

API Description

You can use this API to obtain the list of areas.

API Address

GET /v1.0/osaas/infrared/cities/{city_id}/areas

Request Parameters

Parameter	Type	Position	Description	Mandatory
city_id	String	URI	Unique ID of a city	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Arrays	List of areas

Parameters in result

Parameter	Type	Description
province_id	Integer	Unique ID of a province.
city_id	Integer	Unique ID of a city
area_id	Integer	Unique ID of a area
area_name	String	Area name

Request Example

GET {url}/v1.0/osaas/infrared/cities/30500/areas

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    {
      "province_id": 330000,
      "city_id": 30500,
      "area_id": 330523,
      "area_name": "安吉县"
    }
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Obtaining the List of Carriers

API Description

Regarding set-top box devices, get the IPTV list supported by specified areas.

API Address

GET /v1.0/osaas/infrared/areas/{area_id}/operators

Request Parameters

Parameter	Type	Position	Description	Mandatory
area_id	String	URI	Unique ID of a area	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Arrays	List of operators

Parameters in result

Parameter	Type	Description
operator_id	String	Unique ID of a operator
operator_name	String	Operator name.
country_abbr	String	Country code.
iptv_type	Integer	IPTV flag. 1: IPTV. 0: non-IPTV

Request Example

GET {url}/v1.0/osaas/infrared/areas/510114/operators

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    {
      "operator_id": "1062",
      "operator_name": "成都电信 IPTV",
      "country_abbr": "CN",
      "iptv_type": 1
    }
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Obtaining the List of Remote Control index

API Description

Get the remote control index supporting IPTV carriers by brand ID.

API Address

GET /v1.0/osaas/infrared/areas/{area_id}/operators/{operator_id}/remotes

Request Parameters

Parameter	Type	Position	Description	Mandatory
area_id	String	URI	Unique ID of a area	Yes
operator_id	String	URI	Unique ID of a operator	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Arrays	List of remote control index.

Request Example

GET {url}/v1.0/osaas/infrared/areas/510116/operators/1062/remotes

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    "5129"
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Obtaining the List of Brands by Carrier

API Description

Regarding set-top box devices, get the brand list supported by carriers.

API Address

GET /v1.0/osaas/infrared/operators/{operator_id}/brands

Request Parameters

Parameter	Type	Position	Description	Mandatory
operator_id	String	URI	Unique ID of a operator.	Yes
country_abbr	String	URL	Country code.	No

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Arrays	List of brand.

Parameters in result

Parameter	Type	Description
brand_id	String	Unique ID of a brand.
brand_name	String	Brand name.

Request Example

GET {url}/v1.0/osaas/infrared/operators/3040/brands?country_abbr=CN

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    {
      "brand_id": "907",
      "brand_name": "天龙"
    }
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Obtaining the List of Remote Control Index by Brand

API Description

Get the remote control index supporting IPTV carriers by brand ID.

API Address

GET /v1.0/osaas/infrared/operators/{operator_id}/brands/{brand_id}/remotes

Request Parameters

Parameter	Type	Position	Description	Mandatory
operator_id	String	URI	Unique ID of a operator.	Yes
brand_id	String	URI	Unique ID of a brand.	No

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Array	List of remote control index.

Request Example

GET {url}/v1.0/osaas/infrared/operators/3040/brands/2/remotes

Success Response Example

{
  "success": true,
  "t": 1539776581583,
  "result": [
    "4469"
  ]
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

Error Code

The following are common business exceptions for this interface. For more exception errors, see Global Error Codes.

error code	explain
500	system error