设备群组

更新时间：2023-06-20 12:34:12下载pdf

本文介绍设备群组相关接口。

API 列表

请求方法	API	接口说明
GET	/v1.0/device-groups	查询设备群组列表
GET	/v1.0/device-groups/{group_id}	查询群组详情
GET	/v1.0/users/{uid}/device-groups	查询群组列表
POST	/v1.0/device-groups	创建设备群组
PUT	/v1.0/device-groups/{group_id}	修改群组分组
DELETE	/v1.0/device-groups/{group_id}	删除群组分组
POST	/v1.0/device-groups/{device_group_id}/issued	给设备群组下发指令

查询设备群组列表

接口地址

GET /v1.0/device-groups

请求参数

参数名	类型	参数类型	说明	必填
uid	String	URL	用户 ID	否
pid	String	URL	产品 ID	是
owner_id	String	URL	家庭 ID	是

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功时为空。
t	Long	返回 13 位时间戳。
result	List	设备群组列表。

Result

参数名	类型	说明
device_id	String	设备 ID
device_name	String	设备名称
online	Boolean	在线状态
check	Boolean	是否检查

请求示例

GET /v1.0/device-groups/?pid=jQRc7Cgy8OVzwSRG&uid=ay15512324287785nVuX&owner_id=3792737

返回示例

{
    "result": [
      {
        "device_id": "deveo45678opcww2",
        "device_name": "",
        "online": true,
        "check": false
      }
    ],
    "success": true,
    "t": 1586138482180
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误

查询群组详情

接口地址

GET /v1.0/device-groups/{group_id}

请求参数

参数名	类型	参数类型	说明	必填
group_id	String	URI	设备分组ID	是

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功时为空。
t	Long	返回 13 位时间戳。
result	Object	群组详情。

Result

参数名	类型	说明
id	String	设备 ID
name	String	设备名称
device_num	Int	设备数量
devices	List	设备信息列表

Devices

参数名	类型	说明
device_id	String	设备 ID
device_name	String	设备名称
online	Boolean	在线状态
check	Boolean	是否检查

请求示例

GET /v1.0/device-groups/{group_id}

返回示例

{
    "result": {
      "id": "",
      "name": "",
      "device_num": 1,
      "devices" : [{
        "device_id": "deveo45678opcww2",
        "device_name": "",
        "online": true,
        "check": false
      }]
      },
    "success": true,
    "t": 1586138482180
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误

查询群组列表

接口地址

GET /v1.0/users/{uid}/device-groups

请求参数

参数名	类型	参数类型	说明	必填
uid	String	URI	用户 ID	是
type	Int	URL	群组类型： 0：单品群组（默认） 1：子设备群组	否

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功时为空。
t	Long	返回 13 位时间戳。
result	List	群组列表。

Result

参数名	类型	说明
id	String	设备 ID
name	String	设备名称
device_num	Int	设备数量
devices	List	设备信息列表

devices说明

参数名	类型	说明
device_id	String	设备 ID
device_name	String	设备名称
online	Boolean	在线状态
check	Boolean	是否检查

请求示例

GET /v1.0/users/{uid}/device-groups

返回示例

{
    "result": [
      {
        "id": "",
        "name": "",
        "device_num": 1,
        "devices" : [{
          "device_id": "deveo45678opcww2",
          "device_name": "",
          "online": true,
          "check": false
        }]
      }
    ],
    "success": true,
    "t": 1586138482180
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误

创建群组列表

接口地址

POST /v1.0/device-groups

请求参数

参数名	类型	参数类型	说明	必填
uid	String	Body	用户 ID	是
name	String	Body	群组名称	是
pid	Int	Body	产品 ID	是
owner_id	String	Body	家庭 ID	是
device_list	List	Body	设备	是

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功时为空。
t	Long	返回 13 位时间戳。
result	Object	群组列表。

Result

参数名	类型	说明
id	String	群组 ID
name	String	群组名称
functions	List	指令集

请求示例

POST /v1.0/device-groups
{
    "uid":"aye78wr78q",
    "name":"test",
    "pid":"jhisd4hiac",
    "owner_id":"7887323781",
    "device_list":["devo537878w7", "devo732878w7"],
}

返回示例

{
    "result": [
      {
        "id": "56789783748",
        "name": "test",
        "functions" : [{
          "code": "",
          "value": ""
        }]
      }
    ],
    "success": true,
    "t": 1586138482180
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误

更新群组分组

接口地址

PUT /v1.0/device-groups/{group_id}

请求参数

参数名	类型	参数类型	说明	必填
group_id	String	URI	群组 ID	是
name	String	Body	群组名称	是
device_list	List	Body	设备	是

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功时为空。
t	Long	返回 13 位时间戳。
result	Boolean	更新结果。

请求示例

PUT /v1.0/device-groups/{group_id}
{
    
    "name":"test",
    "device_list":["devo537878w7", "devo732878w7"]
}

返回示例

{
    "result": true,
    "success": true,
    "t": 1586138482180
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误

删除设备群组

接口地址

DELETE /v1.0/device-groups/{group_id}

请求参数

参数名	类型	参数类型	说明	必填
group_id	String	URI	设备群组 ID	是

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功时为空。
t	Long	返回 13 位时间戳。
result	Boolean	删除结果。

请求示例

DELETE /v1.0/device-groups/787382328

返回示例

{
    "result": true,
    "success": true,
    "t": 1586138482180
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误

为设备群组下发指令

说明：同一设备群组中设备的类型相同。

接口地址

POST /v1.0/device-groups/{device_group_id}/issued

请求参数

参数名	类型	参数类型	说明	必填
device_group_id	String	URI	设备群组 ID	是
functions	Object	Body	指令集	是

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功时为空。
t	Long	返回 13 位时间戳。
result	Object	群组列表。

请求示例

POST /v1.0/device-groups/724682634/issued
{
   "functions"：[
   {
       "code":"switch_led",
       "value":true
   },
   {
       "code":"bright",
       "value":30
   }]
}

返回示例

{
    "result": true,
    "success": true,
    "t": 1586138482180
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误