万能红外,用于创建施工模板,万能遥控器红外设备。
API列表
请求方式 |
API |
描述 |
GET |
/v1.0/osaas/infrared/categories/{category_id}/brands |
获取红外设备品牌列表 |
GET |
/v1.0/osaas/infrared/categories/{category_id}/brands/{brand_id}/remotes |
获取红外设备品牌支持遥控器索引列表 |
GET |
/v1.0/osaas/infrared/provinces |
获取省份列表 |
GET |
/v1.0/osaas/infrared/provinces/{province_id}/cities |
获取城市列表 |
GET |
/v1.0/osaas/infrared/cities/{city_id}/areas |
获取区域列表 |
GET |
/v1.0/osaas/infrared/areas/{area_id}/operators |
获取运营商列表 |
GET |
/v1.0/osaas/infrared/areas/{area_id}/operators/{operator_id}/remotes |
根据区域、普通运营商获取遥控器索引列表 |
GET |
/v1.0/osaas/infrared/operators/{operator_id}/brands |
根据iptv运营商获取红外品牌列表 |
GET |
/v1.0/osaas/infrared/operators/{operator_id}/brands/{brand_id}/remotes |
根据iptv运营商品牌获取遥控器索引列表 |
获取红外设备品牌列表
接口描述
调用该接口获取红外设备品牌列表(普通遥控器)
接口地址
GET /v1.0/osaas/infrared/categories/{category_id}/brands
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
category_id |
String |
URI |
红外品类唯一标识 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
红外设备类型品牌列表 |
result参数说明
参数名 |
类型 |
说明 |
brand_id |
String |
品牌唯一标识 |
brand_name |
String |
品牌名称 |
请求示例
GET {url}/v1.0/osaas/infrared/categories/1/brands
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
{
"brand_id": "907",
"brand_name": "天龙"
}
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
获取红外设备品牌支持遥控器索引列表
接口描述
调用该接口获取红外设备品牌支持遥控器索引列表(普通遥控器)
接口地址
GET /v1.0/osaas/infrared/categories/{category_id}/brands/{brand_id}/remotes
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
category_id |
String |
URI |
红外品类唯一标识 |
是 |
brand_id |
String |
URI |
品牌唯一标识 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
红外设备品牌支持遥控器索引列表 |
请求示例
GET {url}/v1.0/osaas/infrared/categories/2/brands/12/remotes
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
"1000384"
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
获取省份列表
接口描述
调用该接口获取省份列表
接口地址
GET /v1.0/osaas/infrared/provinces
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
省份列表 |
result参数说明
参数名 |
类型 |
说明 |
province_id |
String |
省份唯一标识 |
province_name |
String |
省份名称 |
请求示例
GET {url}/v1.0/osaas/infrared/provinces
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
{
"province_id": 120000,
"province_name": "天津市"
}
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
获取城市列表
接口描述
调用该接口获取城市列表
接口地址
GET /v1.0/osaas/infrared/provinces/{province_id}/cities
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
province_id |
String |
URI |
省份唯一标识 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
城市列表 |
result参数说明
参数名 |
类型 |
说明 |
province_id |
Integer |
省份唯一标识 |
city_id |
Integer |
城市唯一标识 |
city_name |
String |
城市名称 |
请求示例
GET {url}/v1.0/osaas/infrared/provinces/330000/cities
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
{
"province_id": 330000,
"city_id": 330700,
"city_name": "金华市"
}
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
获取区域列表
接口描述
调用该接口获取区域列表
接口地址
GET /v1.0/osaas/infrared/cities/{city_id}/areas
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
city_id |
String |
URI |
城市唯一标识 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
区域列表 |
result参数说明
参数名 |
类型 |
说明 |
province_id |
Integer |
省份唯一标识 |
city_id |
Integer |
城市唯一标识 |
area_id |
Integer |
区域唯一标识 |
area_name |
String |
区域名称 |
请求示例
GET {url}/v1.0/osaas/infrared/cities/30500/areas
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
{
"province_id": 330000,
"city_id": 30500,
"area_id": 330523,
"area_name": "安吉县"
}
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
获取运营商列表
接口描述
调用该接口获取运营商列表
接口地址
GET /v1.0/osaas/infrared/areas/{area_id}/operators
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
area_id |
String |
URI |
地区唯一标识 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
运营商列表 |
result参数说明
参数名 |
类型 |
说明 |
operator_id |
String |
运营商唯一标识 |
operator_name |
String |
运营商名称 |
country_abbr |
String |
国家简称 |
iptv_type |
Integer |
iptv 标志(1:IPTV; 0:非 IPTV) |
请求示例
GET {url}/v1.0/osaas/infrared/areas/510114/operators
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
{
"operator_id": "1062",
"operator_name": "成都电信 IPTV",
"country_abbr": "CN",
"iptv_type": 1
}
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
根据区域、普通运营商获取遥控器索引列表
接口描述
调用该接口根据区域、普通运营商获取遥控器索引列表
接口地址
GET /v1.0/osaas/infrared/areas/{area_id}/operators/{operator_id}/remotes
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
area_id |
String |
URI |
地区唯一标识 |
是 |
operator_id |
String |
URI |
运营商唯一标识 |
是 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
遥控器索引列表 |
请求示例
GET {url}/v1.0/osaas/infrared/areas/510116/operators/1062/remotes
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
"5129"
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
根据iptv运营商获取红外品牌列表
接口描述
调用该接口根据iptv运营商获取红外品牌列表
接口地址
GET /v1.0/osaas/infrared/operators/{operator_id}/brands
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
operator_id |
String |
URI |
运营商唯一标识 |
是 |
country_abbr |
String |
URL |
国家简称 |
否 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
品牌列表 |
result参数说明
参数名 |
类型 |
说明 |
brand_id |
String |
品牌唯一标识 |
brand_name |
String |
品牌名称 |
请求示例
GET {url}/v1.0/osaas/infrared/operators/3040/brands?country_abbr=CN
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
{
"brand_id": "907",
"brand_name": "天龙"
}
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
根据iptv运营商品牌获取遥控器索引列表
接口描述
调用该接口根据iptv运营商品牌获取遥控器索引列表
接口地址
GET /v1.0/osaas/infrared/operators/{operator_id}/brands/{brand_id}/remotes
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
operator_id |
String |
URI |
运营商唯一标识 |
是 |
brand_id |
String |
URI |
品牌唯一标识 |
否 |
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13位 |
result |
Arrays |
遥控器索引列表 |
请求示例
GET {url}/v1.0/osaas/infrared/operators/3040/brands/2/remotes
响应成功示例
{
"success": true,
"t": 1539776581583,
"result": [
"4469"
]
}
响应失败示例
{
"code": 500,
"msg": "system error,please contact the admin",
"success": false,
"t": 1561378856383
}
错误码
以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。