# 设备控制

# 协议描述

iFLYOS将会向你的服务器发送相关指令的Request,你的服务器在收到request之后需要对设备进行相应操作,并在操作成功后回复操作成功的Response。若操作失败,请返回ErrorResponse。

# 1. 开关控制

# 1.1 设备打开

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"TurnOn",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 1.2 关闭设备

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"TurnOff",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 2. 动作控制

# 2.1 设置启动

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Start",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 2.2 设置暂停

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"PAUSE",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 2.3 设置继续

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Continue",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 2.4 设置播放

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Play",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 2.5 设置上升

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Ascend",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 2.6 设置下降

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Descend",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 3. 灯光控制

# 3.1 设置颜色

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetColor",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
   },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "color":"Red",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }  
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
color 要设置的颜色,颜色取值 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 3.2 亮度设置

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetBrightness",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "brightness":"50",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }            
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
brightness 灯光亮度数值,取值0~100。0代表最小亮度,100代表最大亮度。若灯光亮度为档位设计,则取近似档位。 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 3.3 按步长调亮(默认步长 10)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpBrightness",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234", 
    "deltaValue":"10",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }             
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 亮度调整百分比,默认为10。若灯光为档位,则每次调节为1档。 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 3.4 按步长调暗(默认步长 10)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownBrightness",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234", 
    "deltaValue":"10",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }            
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 亮度调整百分比,默认为10。若灯光为档位,则每次调节为1档。 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 3.5 色温设置

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetColorTemperature",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "colorTemperature":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }            
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
colorTemperature 色温档位取值,1~5之间的数字,对应关系见下表。 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

色温常见取值:

色温取值 对应色温值 说明
5 2200 暖黄光
4 2700 暖白光
3 4000 自然光
2 5500 正白光
1 7000 冷白光

# 3.6 色温调暖

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpColorTemperature",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234", 
    "deltaValue":"10",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }             
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 色温调整档位,默认为1。 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 3.7 色温调冷

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownColorTemperature",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234", 
    "deltaValue":"10",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }             
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 色温调整档位,默认为1。 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 4. 温度控制

# 4.1 温度设置指定值

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetTemperature",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "temperature":"27",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }             
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
temperature 设置的温度,单位为摄氏度,max为最大温度,min为最小温度 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 4.2 步长调高温度(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpTemperature",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }      
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 温度调整档位,默认为1,单位为摄氏度。 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 4.3 按步长调低温度(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownTemperature",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }         
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 温度调整档位,默认为1,单位为摄氏度。 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 5. 风速控制

# 5.1 风速设置

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetFanSpeed",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "fanSpeed":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }        
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
fanSpeed 风速值,取值如下 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

风扇类的风速对应值

风速值 说明
1 对应风速 1档
2 对应风速 2档
3 对应风速 3档
4 对应风速 4档
max 最大风速
min 最小风速

空调类的风速对应值

风速值 说明
auto 自动风
low 低风
medium 中风
high 高风
max 最大风速
min 最小风速

# 5.2 步长调大风速(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpFanSpeed",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
     "extensions": {
      "extension1": "",
      "extension2": ""
    }        
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 风速调整档位,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 5.3 步长调小风速(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownFanSpeed",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }          
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 风速调整档位,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 6. 电视频道控制

# 6.1 设置频道

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SelectTVChannel",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "channel":"中央六台",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
channel 频道数字或频道名称 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 6.2 频道数加1

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpTVChannel",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 6.3 频道数减1

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownTVChannel",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 6.4 返回上个频道

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"ReturnTVChannel",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }          
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 7. 音量控制

# 7.1 音量设置

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetVolume",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "volume":"10",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }        
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
volume 音量值,支持1-100的取值 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 7.2 步长调大音量(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpVolume",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
     "extensions": {
      "extension1": "",
      "extension2": ""
    }        
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 音量调整档位,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 7.3 步长调小音量(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownVolume",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }          
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 音量调整档位,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 7.4 设置为静音

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetMute",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }          
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 7.5 取消静音

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"CancelMute",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }          
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 8. 火力控制

# 8.1 火力设置指定值

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetFirepower",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "firepower":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }             
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
firepower 设置的火力档位,max为最大火力,min为最小火力 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 8.2 步长调大火力(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpFirepower",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }      
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 火力调整档位,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 8.3 按步长调小火力(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownFirepower",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }         
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 火力调整档位,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 9. 吸力控制

# 9.1 吸力设置指定值

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetSuction",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "suction":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }             
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
suction 设置的吸力档位,max为最大吸力,min为最小吸力,standard为标准档吸力,strong为强劲档吸力 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 9.2 步长调大吸力(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpSuction",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }      
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 吸力调整档位,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 9.3 按步长调小吸力(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownSuction",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }         
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 吸力调整档位,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 10. 开合度控制

# 10.1 开合度设置指定值

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetOpenup",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "openup":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }             
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
openup 设置的开合度,max为开到最大,min为开到最小 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 4.2 按步长调大开合度(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustUpOpenup",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }      
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 开合度调整,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 4.3 按步长调小开合度(默认步长为1)

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"AdjustDownOpenup",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "deltaValue":"1",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }         
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
deltaValue 开合度调整,默认为1 String 否 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 11. 设置播放

# 11.1 设置上一首

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Previous",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 11.2 设置下一首

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Next",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 11.3 设置快进

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"FastForward",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 11.4 设置快退

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Rewind",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 可否为空
accessToken 授权时获取的access token String 是 否
deviceId 设备的唯一Id String 是 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 是

# 12. 模式控制

# 12.1 设置模式

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"SetMode",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "mode":"auto",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
mode 要设置的模式。模式取值 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 12.2 取消模式

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"CancelMode",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "mode":"auto",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
mode 要设置的模式。模式取值 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 13. 功能控制

# 13.1 打开XX功能

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"OpenFunction",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "function":"XXX",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
function 要打开的功能。取值待定 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 13.2 关闭XX功能

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"CloseFunction",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "deviceId":"34234",
    "function":"XXX",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
deviceId 设备的唯一Id String 是 是
function 要关闭的功能。取值待定 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 14.场景控制

# 14.1 打开场景

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Activate",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "sceneId":"21234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header 参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload 参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
sceneId 场景的唯一Id String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 14.2 关闭场景

# 请求样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Deactivate",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "accessToken":"access token",
    "sceneId":"21234",
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header 参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload 参数说明

参数 说明 类型 必须出现 是否必填
accessToken 授权时获取的access token String 是 是
sceneId 设备的唯一Id String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 成功响应

当你收到IVS发送的Request并成功执行之后,你需要回复一个执行成功的Response。

# 1. 设备成功响应

# 消息样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Response",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "deviceId":"34234",
    "attributes":[
      {
        "attribute": "brightness",
        "value":50
      },
      {
        "attribute": "color",
        "value":"red"
      }
      ],
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
deviceId 设备的唯一Id String 是 是
attributes 设备属性信息,支持上报一个或多个属性信息。当设备属性信息发生变化时,建议将属性变更上报给iFLYOS。属性取值 String 是 是
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

# 2. 场景成功响应

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"Response",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "sceneId":"21234",
    "devices":[
          {
             "deviceId":"9081EACF3F92A...",
             "actions":"TurnOn",
             "attributes":{
                 "name":"",
                 "value":""
              }
          }
     ],
    "extensions": {
      "extension1": "",
      "extension2": ""
    }
  }
}

Header 参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload 参数说明

参数 说明 类型 必须出现 是否必填
sceneId 场景的唯一Id String 是 是
devices 用户场景内的设备列表 List 否 否
extensions 产品扩展属性,存放设备相关附加信息,是键值对。iFLYOS不了解或使用这些数据。为空返回null或者不返回该字段 Object 否 否

devices 对象说明

参数名 参数类型 参数说明 返回值是否必须
deviceId String 设备唯一标识符。 是
actions String 设备的操作类型,详情见操作类型 是
attributes String 设备属性信息,支持上报一个或多个属性信息。当设备属性信息发生变化时,建议将属性变更上报给iFLYOS。属性取值 是

# 异常响应

当你收到IVS发送的Request,但执行失败之后,你需要回复一个执行失败的ErrorResponse。

# 1. 设备异常响应

# 消息样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"ErrorResponse",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "deviceId":"34234",
    "errorCode":"DEVICE_NOT_SUPPORT_FUNCTION",
    "message":"device not support"
    "friendlyResponse":"超出了可以设置的范围,再试试吧"
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
deviceId 设备的唯一Id String 是 是
errorCode 错误类型,取值如下 String 是 是
message 错误描述信息 String 是 是
friendlyResponse 请求播报的TTS文本 String 否 否

# 2. 场景异常响应

# 消息样式

{
  "header":{
    "namespace":"iFLYOS.IoT.Device.Control",
    "name":"ErrorResponse",
    "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
    "payloadVersion":1
  },
  "payload":{
    "sceneId":"21234",
    "errorCode":"SCENE_IS_NOT_EXIST",
    "message":"scene not support"
    "friendlyResponse":"没有找到这个场景,请创建后再试试。"
  }
}

Header参数说明

参数 说明 类型
messageId 代表一条message的唯一ID String
payloadVersion payload版本,目前取值为1 Integer

payload参数说明

参数 说明 类型 必须出现 是否必填
sceneId 场景的唯一Id String 是 是
errorCode 错误类型,取值如下 String 是 是
message 错误描述信息 String 是 是
friendlyResponse 请求播报的TTS文本 String 否 否

错误码列表

错误码errorCode 错误码说明
INVALID_ACCESS_TOKEN access_token无效
ALREADY_IN_OPERATION 设备已经在运行了
GATEWAY_OFFLINE 网关离线
DEVICE_IS_NOT_EXIST 未找到设备
DEVICE_NOT_SUPPORT_FUNCTION 设备不支持该功能
DEVICE_NOT_SUPPORT_MODE 设备不支持该模式
DRIVER_INTERNAL_ERROR 驱动器内部错误
DEVICE_BUSY 设备繁忙
DEVICE_LOW_POWER 设备电量低
EXPIRED_ACCESS_TOKEN access_token已失效
FIRMWARE_OUT_OF_DATE 固件已过期
HARDWARE_MALFUNCTION 硬件故障
INTERNAL_ERROR 内部错误
INVALID_REQUEST 所发请求不正确
INVALID_VALUE 请求的值无效
INVALIDATE_PARAMS 请求参数有误
IOT_DEVICE_OFFLINE 设备已离线
NOT_IN_OPERATION 设备不在运行中
NOT_SUPPORTED_IN_CURRENT_MODE 当前状态不支持请求
SERVICE_ERROR 服务异常
VALUE_OUT_OF_RANGE 值超出接受范围
SCENE_NOT_SUPPORT 不支持场景操作
SCENE_WITH_SUCCESS 场景控制全部失败