Skip to content

批量控制设备

接口地址:/v2/binding/enduserapi/batchControlDevice

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

批量控制设备

请求示例:

javascript
{
  "cacheTime": 0,
  "data": "",
  "dataFormat": 0,
  "deviceList": [
    {
      "deviceKey": "",
      "gatewayDeviceKey": "",
      "gatewayProductKey": "",
      "productKey": ""
    }
  ],
  "isCache": 0,
  "isCover": 0,
  "qos": 0,
  "type": 0
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
paramparambodytrue批量控制设备批量控制设备
  cacheTime缓存时间,单位为秒,缓存时间范围 1-7776000 秒,启用缓存时必须设置缓存时间falseinteger(int32)
  data控制设备的命令 当类型为透传时,命令最大长度为 4096truestring
  dataFormat数据类型 1:Hex 2:Text (当 type 为透传时,需要指定 dataFormat)falseinteger(int32)
  deviceList设备列表truearraypkdk
    deviceKey设备deviceKeytruestring
    gatewayDeviceKey网关设备deviceKeyfalsestring
    gatewayProductKey网关产品productKeyfalsestring
    productKey产品productKeytruestring
  isCache是否启用缓存 1:启用 2:不启用,默认不启用falseinteger(int32)
  isCover是否覆盖之前发送的相同的命令 1:覆盖 2:不覆盖,默认不覆盖,启用缓存时此参数有效falseinteger(int32)
  qosQoS等级设置,参数值范围 0、1,默认为1falseinteger(int32)
  type类型 1:透传 2:属性 3:服务trueinteger(int32)

响应状态:

状态码说明schema
200批量控制设备成功返回注册码响应数据«PkdkResult»
5032token 验证失败
5041无权限
5070请输入类型
5071类型错误,类型 1:透传 2:属性 3:服务
5072请输入数据类型
5073数据类型错误,数据类型 1:Hex 2:Text (当 type 为透传时,需要指定 dataFormat)
5074请输入控制设备的命令
5075控制设备的命令长度不能超过 4096
5106请输入token
5311请输入设备列表
5312设备列表总数超出范围
5328请输入缓存时间
5329缓存时间超出范围
5330是否启用缓存超出范围
5331是否覆盖之前发送的相同的命令超出范围
5340批量控制设备失败

响应参数:

参数名称参数说明类型schema
code响应状态码integer(int32)integer(int32)
data响应数据PkdkResultPkdkResult
  failureList失败列表arrayPkdkMsg
    datapkdkpkdk
      deviceKey设备deviceKeystring
      gatewayDeviceKey网关设备deviceKeystring
      gatewayProductKey网关产品productKeystring
      productKey产品productKeystring
    msgstring
  successList成功列表arrayPkdkSuc
    datapkdkpkdk
      deviceKey设备deviceKeystring
      gatewayDeviceKey网关设备deviceKeystring
      gatewayProductKey网关产品productKeystring
      productKey产品productKeystring
    ticketstring
extMsg扩展消息string
msg响应消息string

响应示例:

javascript
{
	"code": 0,
	"data": {
		"failureList": [
			{
				"data": {
					"deviceKey": "",
					"gatewayDeviceKey": "",
					"gatewayProductKey": "",
					"productKey": ""
				},
				"msg": ""
			}
		],
		"successList": [
			{
				"data": {
					"deviceKey": "",
					"gatewayDeviceKey": "",
					"gatewayProductKey": "",
					"productKey": ""
				},
				"ticket": ""
			}
		]
	},
	"extMsg": "",
	"msg": ""
}