简要描述:

获取设备属性值

请求URL:

/api/v1/commands/obtain/properties

请求方式:

POST

请求参数

{
    "productKey":"xxx",
    "deviceName":"xxx",
    "async":true,
    "subDevice": true,
    "expiration": 3600,
    "properties":[
        "prop1",
        "prop2"
    ]
}

请求参数说明:

参数名 必选 类型 长度 说明
productKey string 产品key
deviceName string 设备名称
async bool 异步接收回调,回调信息将通过feedback返回
subDevice bool 默认false代表非子设备;true代表子设备,此时productKey和deviceNames应为子设备的产品key和名称列表
expiration long 离线消息有效期对应的秒数, 仅当async为true才可设置此功能,用于离线消息缓存;例如:有效期为1小时,expiration设置为3600
properties array 属性列表,即产品功能中标准功能/自定义功能中的属性功能标识

返回参数

{
    "code":0,
    "message":"success",
    "data":{
        "mid":"123",
        "version":"1.0",
        "pKey":"xxx",
        "dName":"xxx",
        "obj":"thing.service",
        "action":"property.get_reply",
        "data":{
            "ret":0,
            "msg":"xxx",
            "payload":{
                "prop1":"xx",
                "prop2":"xxx"
            }
        }
    }
}

返回参数说明:

参数名 类型 长度 说明
mid string 消息Id
version string 版本号
pKey string 产品key
dName string 设备名称
obj string 操作对象
action string 请求对应方法
data object 数据体
ret int 错误码
msg string 消息体
payload object 参数集合

results matching ""

    No results matching ""