文档中心 > API类目 > 天猫精灵开放API

alibaba.ailabs.iot.cloud.device.report (天猫精灵云云接入设备状态、事件上报接口)

承接天猫精灵云云接入设备的状态、事件上报

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
cloud_report_param CloudReportParam 必须 上报总入参
  • └ payload
  • String
  • 必须
  • { "onlinestate": 1 }
  • 设备状态或者事件Map组成的Json字符串
  • └ device_id
  • String
  • 必须
  • devId_1233
  • 设备id
  • └ user_access_token
  • String
  • 可选
  • token_123
  • 用户accessToken
  • └ open_user_id
  • String
  • 可选
  • 1234561232
  • 天猫精灵授权给厂商的userId
  • └ account_type
  • Number
  • 必须
  • 1
  • 账号类型(1:token 2:openUserId)
  • └ skill_id
  • Number
  • 必须
  • 513
  • 技能id
  • └ time_stamp
  • Number
  • 必须
  • 4325435435
  • 上报时间戳(毫秒)
  • └ message_id
  • String
  • 必须
  • messageId_123
  • 消息id,问题定位用
  • └ payload_version
  • Number
  • 必须
  • 2
  • 协议版本(原有协议版本为1,新版协议为2)
  • └ report_type
  • Number
  • 必须
  • 1
  • 上报类型,1:属性上报 2:在离线上报 3:事件上报
  • └ extension
  • String
  • 可选
  • {"uuid":"123456"}
  • 保留业务字段

响应参数

名称 类型 示例值 描述
ret_value Boolean TRUE 返回值,是否上报成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAilabsIotCloudDeviceReportRequest req = new AlibabaAilabsIotCloudDeviceReportRequest();
AlibabaAilabsIotCloudDeviceReportRequest.CloudReportParam obj1 = new AlibabaAilabsIotCloudDeviceReportRequest.CloudReportParam();
obj1.setPayload("{     \"onlinestate\": 1   }");
obj1.setDeviceId("devId_1233");
obj1.setUserAccessToken("token_123");
obj1.setOpenUserId("1234561232");
obj1.setAccountType(1L);
obj1.setSkillId(513L);
obj1.setTimeStamp(4325435435L);
obj1.setMessageId("messageId_123");
obj1.setPayloadVersion(2L);
obj1.setReportType(1L);
obj1.setExtension("{\"uuid\":\"123456\"}");
req.setCloudReportParam(obj1);
AlibabaAilabsIotCloudDeviceReportResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_ailabs_iot_cloud_device_report_response>
    <ret_value>TRUE</ret_value>
</alibaba_ailabs_iot_cloud_device_report_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
300001 参数无效 按文档规范上传
310000 属性不存在 确认产品物模型是否有该属性
301000 用户不存在 确认用户token是否过期
310004 未找到产品信息 确认产品是否已注册在天猫精灵iot平台
302002 设备操作不支持 确认产品物模型是否有效
300000 参数为空 确认参数是否正确
310006 属性值超过最小值 确认参数是否与物模型匹配
310007 属性值不存在 确认物模型是否正确
310005 属性值超过最大值 确认入参与物模型是否匹配
10001 内部错误 联系答疑

API工具

如何获得此API

FAQ

返回
顶部