文档中心
机智云 文档中心
English
热搜词
APP
SDK
Android
ios
WIFI
Gizwits Open API(新)
文档编辑
  • Windows 平台按 Ctrl + F 打开快捷搜索
  • Mac 平台按 command + F 打开快捷搜索

概述

机智云是一个开放的物联网设备平台,它为企业和个人开发者提供设备接入、用户账号管理、用户与设备绑定管理、设备远程监控、定时任务以及设备高级数据等服务。

这些数据都是存储在机智云的数据库中的。那么作为开发者,如何去访问这些数据呢?

Open API 就是机智云对外提供这些数据的访问接口!

接口列表

根据机智云提供的服务,Open API 提供如下功能:

  • 用户管理:用户的注册、登录、密码重置等功能
API列表 描述
get_app_users 获取用户信息
post_app_users 创建新用户
put_app_users 修改用户信息
post_app_login 用户登录
post_app_request_token 获取APP Token
post_app_reset_password 请求重置密码
post_app_sms_code 验证码的获取和校验
get_app_verify_codes 获取图片验证码
post_app_verify_codes 校验图片验证码
put_app_verify_codes 校验短信验证码
  • 消息中心:用户查看消息、标记已读和删除系统消息等功能
API列表 描述
get_app_messages 查询消息列表
put_app_messages 标记消息已读和删除
API列表 描述
post_app_bind_mac 通过 MAC 地址绑定设备
delete_app_bindings 解除设备
get_app_bindings 获取绑定列表
post_app_bind_latest 通过二维码绑定设备
put_app_bindings_did 修改绑定信息
get_app_did_bindings 解绑 Guest 用户
  • 设备远程监控:获取设备的当前状态、设备上报的原始数据、设备的上下线记录、设备的远程控制等功能
API列表 描述
get_app_devdata_did_latest 获取设备最新状态
get_app_datapoint 获取产品数据点定义
get_app_devices_did 获取设备详情
get_app_devices_did_raw_data 获取设备的通信日志和上下线记录
post_app_control_did 远程控制设备
  • 设备分享:比如用户把自己的绑定设备分享给其他用户,解绑其他用户对自己设备的绑定等
API列表 描述
get_app_sharing 查询分享邀请
post_app_sharing 创建分享邀请
delete_app_sharing_id 取消/收回分享
put_app_sharing_id 接受/拒绝分享
get_app_sharing_code 获取二维码分享信息
post_app_sharing_code 接受二维码分享邀请
put_app_sharing_idalias 修改用户备注信息
post_app_sharing_did_transfer owner 权限转移
  • 设备分组:对多个设备进行分组,发送一次指令就能控制分组下的多个设备
API列表 描述
get_app_group 查询用户所有的分组
post_app_group 创建分组
delete_app_group_id 删除设备分组
put_app_group_id 修改分组信息
get_app_group_id_devices 查询分组的设备信息
post_app_group_id_devices 将设备列表添加到分组
delete_app_group_id_devices 将设备列表从分组移除
post_app_group_id_control 对设备分组内的设备统一控制
  • 设备联动:通过创建设备间联动规则,当设备触发规则后,联动控制其他设备。
API列表 描述
get_app_rules_params 查询规则可用变量
get_app_rules 查询联动规则列表
post_app_rules 创建联动规则
delete_app_rules 删除联动规则
put_app_rules 修改联动规则
  • 用户场景:用户可通过场景功能预设的一系列设备动作并在需要时触发。
API列表 描述
get_app_scene 查询用户所有的场景
post_app_scene 创建场景
delete_app_scene_id 删除场景
put_app_scene_id 修改场景信息
get_app_scene_id_task 查询场景任务执行状态
post_app_scene_id_task 执行场景任务
API列表 描述
get_app_devices_scheduler 获取定时任务
post_app_devices_scheduler 创建定时任务
delete_app_devices_scheduler 删除定时任务
put_app_devices_scheduler 修改定时任务
API列表 描述
get_app_common_scheduler 获取定时任务
post_app_common_scheduler 创建定时任务
delete_app_common_scheduler 删除定时任务
put_app_common_scheduler 修改定时任务
API列表 描述
get_app_bindings 获取设备聚合数据
  • 系统信息:比如查看当前 Open API 版本,获取所有可能的错误列表等
API列表 描述
get_status 查询服务状态信息
get_errors 错误状态码列表

协议约定

请求方式

机智云 Open API 是 RESTful 风格的 HTTP API,您可以使用任何标准的 HTTP 客户端访问机智云 Open API。

推荐 HTTP 客户端:

HTTP头部请求说明

X-Gizwits-Application-Id

X-Gizwits-Application-Id 简称 AppID,是一个应用在机智云平台中的唯一标识,所有 OpenAPI 接口都需要传入这个头部参数。

在开发者中心的产品页面中,点击左边栏的”应用配置”菜单,创建一个应用即可获得一个 AppID:

Get AppID

X-Gizwits-User-token

X-Gizwits-User-token 简称 UserToken,它代表着接口调用中的用户上下文。

UserToken 具有有效期,默认为 7 天。

可以通过用户注册或者登录接口获取 UserToken,返回字段中的 token 就是 UserToken,expire_at 表示 UserToken 过期的时间戳:

1
2
3
4
5
{
"uid": "29db4f0d806e451a84264ba3da64d9de",
"token": "86a0ee91548f4971832e371811702316",
"expire_at": 13894002020
}

每次登录可以获取一个新的 UserToken,新旧 UserToken 都可以使用。

因为机智云 Open API 大多数的接口都是与用户相关的,所以一般的接口调用顺序如下:

  1. 判断本地是否有 UserToken,以及 UserToken 是否过期
  2. 如果不存在 UserToken 或者 UserToken 过期,调用用户登录接口,获取并保存 UserToken
  3. 使用 UserToken 调用其它接口

加密参数

统一使用32位加密

lower:小写

UPPER:大写

示例:
lower(md5(product_secret + X-Gizwits-Timestamp ))

选择md5,32位[小]进行加密,填入product_secret和X-Gizwits-Timestamp,无需“+”号,如下图所示

photo

在线调试 Open API

我们提供了在线 API 调试工具,在每个接口描述中,都会给出对应的调试接口链接。

下面以用户登录为例,说明 API 调试工具的使用:

  • 点击 用户登录 进入接口调试页面
  • 接口右边有个红色叹号,点击后弹出对话框,提示需要输入的头部信息
  • 该接口需要输入 X-Gizwits-Application-Id,根据前面的说明获取 AppID 并填入,点击 “Authorize” 进行授权
  • 页面自动刷新,并且叹号变成蓝色,表示需要输入的头部信息已填写(已填写并不一定表示值是正确的,如果值错误,会反应在接口返回内容中)
  • 在参数输入框中输入参数值(点击参数右边的 Example Value 黄色框框,可以快速输入示例 JSON)
  • 点击 “试一下” 按钮,即可完成接口调用
  • 接口调用完成,会显示本地调用等效的 curl 语句,请求 URL,响应体,响应码和响应头

用户管理

创建用户

调试接口

有以下几种方式可以创建新用户:

  • 匿名注册,通过唯一的 phone_id 创建用户
  • 用户名密码注册,通过 username 和 passowrd 创建用户
  • 手机注册,通过 phone, password 和 code(短信验证码)创建用户,短信验证码的获取参考下面章节
  • 邮箱注册,通过 email 和 password 创建用户
  • 第三方登录用户创建,通过authData内的 src、 uid 和 token 创建用户。目前支持腾讯QQ、新浪微博、百度、微信、Facebook、Twitter、Google+、Amazon

第三方登录注意事项:

  • Google 和 amazon 第三方登录,authData 里面的 token 需要带上 “Bearer “ 开头
  • QQ 和 Twitter 需要在开发者中心填写API_KEY和API_Secret
  • Facebook、Twitter、Google、Amazon仅可在美东和欧洲环境使用

密码强度要求:

  • 密码长度不小于 8 位
  • 必须由大写,小写,数字,特殊符号至少 3 种以上字符组合

请求地址及地址

POST
http://api.gizwits.com/app/users

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
phone_id string body 匿名标识,匿名注册的请求参数
username string body 用户名,用户名密码注册的请求参数
password string body 密码,用户名密码注册、手机注册、邮箱注册的请求参数
email string body 邮件地址,邮箱注册的请求参数
phone string body 手机号码,手机号码,手机注册的请求参数
code string body 验证码,短信验证码,手机注册的请求参数
lang string body 语言:en,zh-cn
src string body 平台类型:qq,sina,baidu,wechat,twitter,facebook,google, amazon
uid string body 第三方登录平台返回的uid
token string body 第三方登录平台返回的token

响应参数

参数 类型 描述
uid string 用户唯一id
token string 用户token
expire_at integer token过期时间(时间戳)

返回例子

1
2
3
4
5
{
"token": "f8324047f20144f6914e7be19304f943",
"uid": "f082f4e235974cfeb6a1b40a6024f47e",
"expire_at": 1504772734
}

获取用户信息

调试接口

请求地址及地址

GET
http://api.gizwits.com/app/users

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token

响应参数

参数 类型 描述
username string 用户名
phone string 手机号码
email string 注册邮箱
name string 姓名
gender string 性别,M:男, F:女, N:未知
birthday string 生日,日期格式:YYYY-MM-DD or MM-DD
address string 地址
lang string 语言版本en, zh-cn
remar string 备注
uid string 用户唯一id
is_anonymous boolean 是否匿名用户

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
{
"username": "gizwits",
"uid": "f082f4e235974cfeb6a1b40a6024f47e",
"phone": "18888888888",
"birthday": "2017-01-01",
"address": "guangzhou",
"lang": "zh-cn",
"remark": "remark",
"name": "gizwits",
"is_anonymous": false,
"gender": "M",
"email": "club@gizwits.com"
}

修改用户信息

调试接口

有以下几种不同注册对应的修改方式

  • 匿名注册的用户转普通用户: 输入 username, password
  • 匿名注册的用户转手机用户: 输入 phone, password, code (通过获取验证码接口获取)
  • 修改密码: 输入 old_pwd, new_pwd
  • 修改手机号: 输入 phone, code (通过获取验证码接口获取)
  • 修改基本信息:姓名、性别、生日、地址、语言版本、备注

请求地址及方式

PUT
http://api.gizwits.com/app/users

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
username string body 用户名,用于匿名转普通用户
password string body 密码,用于匿名转普通用户
phone string body 手机号码,用于匿名转手机注册用户
code string body 验证码,用于匿名转手机注册用户
old_pwd string body 旧密码,用于修改密码
new_pwd string body 新密码,用于修改密码
email string body 注册邮箱,用于匿名转邮箱注册用户
name string body 姓名
gender string body 性别,M:男, F:女, N:未知
birthday string body 生日,日期格式:YYYY-MM-DD or MM-DD
address string body 地址
lang string body 语言版本en, zh-cn
remar string body 备注

响应参数

参数 类型 描述
updatedAt string 修改时间(UTC时间)

返回例子

1
2
3
{
"updatedAt": "2017-01-01T08:32:56.996638"
}

用户登录

调试接口

匿名用户和第三方登录用户调用用户创建用户接口进行登录。

请求地址及方式

POST
http://api.gizwits.com/app/login

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
username string body 用户名,可以是用户的 username/email/phone
password string body 密码
lang string body 语言版本

响应参数

参数 类型 描述
uid string 用户唯一id
token string 用户token
expire_at integer token过期时间(时间戳)

返回例子

1
2
3
4
5
{
"token": "f8324047f20144f6914e7be19304f943",
"uid": "f082f4e235974cfeb6a1b40a6024f47e",
"expire_at": 1504772734
}

获取APP Token

调试接口

该接口获取的token参数主要用于调用获取短信验证码获取图片验证码接口时作为请求参数使用。

请求地址及方式

POST  
http://api.gizwits.com/app/request_token

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-Application-Auth string header MD5_32位加密(appid + appsecret)

响应参数

参数 类型 描述
uid string 用户唯一id
expire_at integer token过期时间(时间戳)

返回例子

1
2
3
4
{
"token": "f8324047f20144f6914e7be19304f943",
"expire_at": 1504772734
}

请求重置密码

调试接口

只有设置了 email 或者 phone 的用户才可以重置密码。

  • 通过 email 重置密码,只需传入 email ,通过邮件发送重置密码链接
  • 通过 phone 重置密码,传入 phone, new_pwd, code (通过调用获取短信验证码接口获取)

请求地址及方式

POST
http://api.gizwits.com/app/reset_password

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
email string body 注册邮箱
phone string body 注册手机号码
new_pwd string body 新密码
code string body 验证码

响应参数

验证码的获取和校验

调试接口

短信验证码的主要用途有:

  • 手机号用户注册
  • 手机号用户重置密码
  • 其他您认为需要短信验证码的敏感操作

接口能实现获取和校验验证码:

  • 获取短信验证码只需要传入 phone
  • 验证短信验证码需要传入 phone 和 code

关于国外手机号

  • 发送短信验证码到国外手机号,需要遵循如下格式:+{国家码}{手机号}。假设一个美国(国家码为 1)的手机号为 4246531234,那么 phone 就应该填写为 “+14246531234”
  • 国家码列表可以通过这里获取。

短信验证码正确校验后立即失效,默认有效期为 24 小时。

请求地址及方式

POST
http://api.gizwits.com/app/sms_code

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token,通过获取APP Token接口取得
phone string body 手机号码
code string body 验证码

响应参数

获取图片验证码

调试接口

返回的 captcha_url 就是图片验证码的 URL,将图片显示给用户

请求地址及方式

GET
http://api.gizwits.com/app/verify/codes

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token,通过获取APP Token接口取得

响应参数

参数 类型 描述
captcha_url string 图片验证码URL地址
captcha_id string 图片验证码id

返回例子

1
2
3
4
{
"captcha_url": "http://api.gizwits.com/captcha/image/22d9cdc8edb13fd19f770afbed45351831403b5d/",
"captcha_id": "22d9cdc8edb13fd19f770afbed45351831403b5d"
}

校验图片验证码并发送验证码

调试接口

获取图片验证码接口的图片验证码进行校验,校验通过将发送短信验证码

请求地址及方式

POST
http://api.gizwits.com/app/verify/codes

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token,通过获取APP Token接口取得
captcha_id string body 图片验证码id
captcha_code string body 图片验证码的值
phone string body 手机号码

响应参数

校验短信验证码

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/verify/codes

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token,通过获取APP Token接口取得
phone string body 手机号码
sms_code string body 验证码

响应参数

消息中心

查询消息列表

调试接口

获取用户的消息,如分享信息、D3规则推送的消息

请求地址及方式

GET
https://api.gizwits.com/app/messages?type=1&limit=20&skip=0

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
type integer query 消息类型,1:设备分享消息
limit integer query 返回的结果条数
skip integer query 表示跳过的条数,间接表示页数。

响应参数

参数 类型 描述
total integer 消息总数
limit integer 返回的结果条数
skip integer 跳过的条数
previous string 上一页的请求地址
next string 下一页的请求地址
id string 消息id编号
created_at string 消息创建时间(UTC时间)
updated_at string 消息更新时间(UTC时间)
type integer 消息类型,1:设备分享消息
status integer 消息状态,0 未读,1 已读,2 删除
content string 信息内容

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"meta": {
"total": 50,
"limit": 1,
"skip": 0,
"previous": "/app/messages?skip=5&type=1&limit=1",
"next": "/app/messages?skip=7&type=1&limit=1"
},
"objects": [
{
"status": 0,
"created_at": "2017-09-11T11:41:23Z",
"updated_at": "2017-09-11T11:41:23Z",
"content": "您给 188****888 共享了设备 微信宠物屋!",
"type": 1,
"id": "59b676638c7d500018a9ed98"
},
]
}

标记已读和删除消息

调试接口

将用户信息标记为已读和删除消息

请求地址及方式

PUT
https://api.gizwits.com/app/messages/{id}?status=1

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id integer path 消息id编号
status integer query 消息状态:1:已读,2:删除

响应参数

绑定管理

当设备与用户之间绑定后,设备与用户之间就会存在对应的“绑定角色”关系。

绑定角色分为4种类,首绑用户: special ;拥有者: owner ;访客: guest ;普通用户: normal

角色场景说明:

  • 当设备没有分享过且设备没有任何用户绑定过。A用户绑定该设备,A用户成为 special , B用户再绑定该设备,B用户成为normal 。
  • 设当前A用户为 special ,B用户为 normal 。当A用户解除绑定,B用户成为 special ,A用户与该设备之间没有“绑定角色”关系。
  • 设当前A用户为 special ,B用户为 normal 。产品开启了设备分享,A用户将设备分享给C用户,无论C用户是否接受,A用户成为 owner,B用户变成 guest。
  • 当开启分享功能且设备没有任何用户绑定。A用户绑定该设备,A用户成为 owner ,其他用户无法再绑定该设备。
  • 设当前A用户为 owner ,C用户未绑定过该设备 。A用户将设备分享给C用户,且C用户接受分享。A用户成仍是 owner,C用户为 guest。
  • 设当前A用户为 owner ,B用户为 guest 。A用户将设备解除绑定,A用户和B用户与该设备之间没有“绑定角色”关系。
  • 除 owner 用户,其他用户无法分享设备,一个设备只有一个owner

绑定设备

可以通过一下两种方式绑定设备:

  • 通过 product_key 和 MAC 地址绑定设备
  • 通过二维码绑定设备,二维码内容为 product_key 和 MAC 加密后的内容,所以本质上和上面一种方式一样

通过 MAC 地址绑定设备

调试接口

将用户与设备进行绑定

请求地址及方式

POST
http://api.gizwits.com/app/bind_mac

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
X-Gizwits-Timestamp string header 请求时间戳,与服务器相差不能超过 5 分钟
X-Gizwits-Signature string header 签名,计算方法为 lower(md5(product_secret + X-Gizwits-Timestamp ))
product_key string body 产品product_key
mac string body 设备mac地址
remark string body 备注
dev_alias string body 设备别名
set_owner integer body 是否设置成 owner,只对开启了设备分享功能的产品有效;0(默认值):不设置成owner,1:设置成owner

响应参数

参数 类型 描述
product_key string 产品product_key
did string 设备id
mac string 设备mac地址
is_online boolean 是否在线
passcode string 设备 passcode
host string 连接服务器的域名
port integer M2M 的 mqtt 端口号
port_s integer M2M 的 mqtt SSL 端口号
ws_port integer websocket 端口号
wss_port integer websocket SSL 端口号
remark string 设备备注
is_disabled boolean 是否注销
type string 设备类型,单品设备:normal,中控设备:center_control,中控子设备:sub_dev
dev_alias string 设备别名
dev_label Array[string] 设备标签列表,目前用于语音 API 批量设备控制
role string 绑定角色, 特殊用户:special,拥有者:owner,访客:guest,普通用户:normal

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"product_key": "4214bf2d79694a259232431b6f2ef46b",
"did": "gKufzxZwYeyd3Skbsb6mza",
"mac": "accf2350d446",
"is_online": false,
"passcode": "JHHOOIWJBA",
"host": "m2m.gizwits.com",
"port": 1883,
"port_s": 8883,
"ws_port": 8080,
"wss_port": 8880,
"remark": "备注信息",
"is_disabled": false,
"type": "normal",
"dev_alias": "设备别名",
"dev_label": [],
"role": "special"

}

解绑设备

调试接口

用户已绑定的设备进行解绑

请求地址及方式

DELETE
https://api.gizwits.com/app/bindings

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
devices Array body 需要解绑的设备数组
did string body 设备ID

响应参数

参数 类型 描述
success Array[string] 解绑成功的设备
failed Array[string] 解绑失败的设备

返回例子

1
2
3
4
5
6
7
{
"failed": [],
"success": [
"xAAcCYawLFD9JfMysqYf7d",
"WCWGkbS4Ttynzwx9brzpEa"
]
}

获取绑定列表

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/bindings

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
limit integer query 返回的结果条数
skip integer query 表示跳过的条数,间接表示页数
show_disabled integer query 是否显示已注销的设备,1:显示,0:不显示
show_proto_ver integer query 是否显示设备通信协议版本,1:显示,0:不显示

响应参数

参数 类型 描述
devices Array 绑定的设备组
product_key string 产品product_key
did string 设备id
mac string 设备mac地址
is_online boolean 是否在线
passcode string 设备 passcode
host string 连接服务器的域名
port integer M2M 的 mqtt 端口号
port_s integer M2M 的 mqtt SSL 端口号
ws_port integer websocket 端口号
wss_port integer websocket SSL 端口号
remark string 设备备注
is_disabled boolean 是否注销
type string 设备类型,单品设备:normal,中控设备:center_control,中控子设备:sub_dev
dev_alias string 设备别名
dev_label Array[string] 设备标签列表,目前用于语音 API 批量设备控制
proto_ver string 协议版本号,’01’, ‘01_01’, ‘03’, ‘04’
wifi_soft_version string wifi版本号
is_sandbox boolean 是否连接sandbox环境
role string 绑定角色, 首绑用户:special,拥有者:owner,访客:guest,普通用户:normal

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
"devices": [
{
"product_key": "55af63815cc34788aeeb9451a2454412",
"did": "7r7u8XPkCRLGVYTYrtjoCB",
"mac": "virtual:site",
"is_online": false,
"passcode": "123456",
"host": "sandbox.gizwits.com",
"port": 1883,
"port_s": 8883,
"ws_port": 8080,
"wss_port": 8880,
"remark": "备注信息",
"is_disabled": false,
"type": "normal",
"dev_alias": "设备别名",
"dev_label": [],
"proto_ver": "04",
"wifi_soft_version": null,
"is_sandbox": true,
"role": "special"
},
{
"product_key": "4214bf2d79694a259232431b6f22f46b",
"did": "gKufzxZwYeyd3Skbsb6mza",
"mac": "accf2350d447",
"is_online": false,
"passcode": "JHHOOIWJBA",
"host": "m2m.gizwits.com",
"port": 1883,
"port_s": 8883,
"ws_port": 8080,
"wss_port": 8880,
"remark": "备注信息",
"is_disabled": false,
"type": "normal",
"dev_alias": "设备别名",
"dev_label": [],
"proto_ver": "04",
"wifi_soft_version": "04000006",
"is_sandbox": true,
"role": "special"
}
]
}

通过二维码绑定设备

调试接口

必须是通过机智云的二维码生成服务(查看教程)生成的二维码才可以调用本接口。

请求地址及方式

POST
https://api.gizwits.com/app/bind_latest

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
qr_content string body 通过扫描二维码得出的字符串
set_owner integer body 是否设置成 owner,只对开启了设备分享功能的产品有效;0(默认值):不设置成owner,1:设置成owner

响应参数

修改绑定信息

调试接口

用户可以对绑定的设备修改别名和备注。

同一个设备被多个用户绑定,每个用户都可以对该设备设置别名和备注,互不冲突。

请求地址及方式

PUT
https://api.gizwits.com/app/bindings/{did}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did integer path 设备ID
remark string body 设备备注
dev_alias string body 设备别名
dev_label Array[string] body 设备标签列表,目前用于语音 API 批量设备控制

注:body的参数最少填写输入一个

响应参数

参数 类型 描述
remark string 设备备注
dev_label Array[string] 设备标签列表,目前用于语音 API 批量设备控制
dev_alias string 设备别名

返回例子

1
2
3
4
5
6
7
8
{
"remark": "备注",
"dev_label": [
"标签1",
"标签2"
],
"dev_alias": "设备别名"
}

查询设备绑定的Guest用户

调试接口

查看接受设备分享邀请的用户信息

请求地址及方式

GET
https://api.gizwits.com/app/{did}/bindings

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 设备ID

响应参数

参数 类型 描述
username string 账号username,中间4个字母*替代
phone string 账号phone,中间4个数字*替代
created_at string Guest 用户接受分享的时间(UTC时间)
uid string Guest用户的UID
email string 账号email,@前面4个字符*替代

返回例子

1
2
3
4
5
6
7
8
9
[
{
"username": "2****2",
"phone": null,
"created_at": "2017-09-19T07:12:32Z",
"uid": "c0a85d0773e24f15a6853f3148c82313",
"email": null
}
]

解绑 Guest 用户

调试接口

Owner 解除 Guest 用户对设备的绑定关系

请求地址及方式

DELETE
https://api.gizwits.com/app/{did}/bindings

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 设备ID
uid string query guest 的 uid,不能是自己

响应参数

设备远程监控

获取设备最新状态

调试接口

该接口获取的是 24 小时内,设备最近一次上报的数据点值。

请求地址及方式

GET
https://api.gizwits.com/app/devdata/{did}/latest

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
did string path 设备ID

响应参数

参数 类型 描述
did string 设备ID
updated_at string 最后更新时间
attr object 数据点及其值

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"did": "WCWGkbS42tynzwx9brzpEa",
"updated_at": 1505809000,
"attr": {
"alert_full": 0,
"alert_shutdown": 0,
"mode": "制冷",
"fan_swing": 0,
"switch": 0,
"fan_speed": "低风",
"fault_roomtemp": 0,
"room_temp": -10,
"set_temp": 16,
"off_timing": 0,
"on_timing": 0
}
}

获取产品数据点定义

调试接口

API 调用限制

  • AppID 和 product_key 关联
  • AppID 为超级 AppID

请求地址及方式

GET
https://api.gizwits.com/app/datapoint?product_key={product_key}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
product_key string path 产品product_key

响应参数

参数 类型 描述
name string 产品名称
entities Array [EntityItem]
protocolType string 固定值:standard
product_key string 产品product_key
packetVersion string 固定值:4
ui inline_model_7 手机客户端 UI 定义
EntityItem —————— ——————
id integer 固定值:0
name string 固定值:entity0
display_name string 固定值:机智云开发套件
attrs Array [AttrItem]
inline_model_7 —————— ——————
object inline_model_1
sections Array UI 片段列表:[SectionItem]
AttrItem —————— ——————
id integer 数据点顺序
name string 数据点标示名
display_name string 数据点显示名
desc string 固定值:…..
type string 读写类型,W: 读写,R: 只读,N: 报警,E: 故障
data_type string 数据类型,bool:布尔;’uint8’,’uint16’,’uint32’:数值型;enum:枚举;binary:扩展型]
uint_spec inline_model_4 当 data_type 为 uint8/uint16/uint32 时,有该字段
enum Array 当 data_type 为 enum 时,有该字段
position inline_model_5 字节与比特位描述
inline_model_1 —————— ——————
version integer 固定值:4
showEditButton boolean 固定值:false
SectionItem —————— ——————
elements Array [ElementItem]
inline_model_4 —————— ——————
min integer 最少值
max integer 最大值
ratio number 分辨率k
addition integer 增量
inline_model_5 —————— ——————
bit_offset integer 位索引,如果为变长协议,固定为 0
len integer 长度
unit string 单位,’bit’, ‘byte’
byte_offset integer 字节索引,如果为变长协议,固定为 0
ElementItem —————— ——————
title string 数据点显示名
key string entity0.{数据点标示名}
type string ‘QBooleanElement’, ‘QFloatElement’, ‘QRadioElement’, ‘QMultilineElement’, ‘QLabelElement’
keyboardType string 键盘类型,固定值,”NumbersAndPunctuation”
maxLength integer type 为 QMultilineElement 才有该字段,最大长度,为数据点定义长度的 2 倍
items Array type 为 QRadioElement 才有该字段,枚举值列表
boolValue boolean type 为 QBooleanElement 才有该字段,固定值:false
bind string type 为 QFloatElement 才有该字段,固定值:floatValue:float
maximumValue number type 为 QFloatElement 才有该字段,最大值
minimumValue number type 为 QFloatElement 才有该字段,最少值
value integer type 为 QFloatElement 才有该字段,固定值:0
object inline_model_6
inline_model_6 —————— ——————
action string 固定值:entity0
bind Array[string] 固定值:entity0.{数据点标示名}
perm string 读写类型:W: 读写,R: 只读,N: 报警,E: 故障
unit_spec inline_model_2 type 为 QFloatElement 才有该字段
inline_model_2 —————— ——————
max integer 最大值
step integer 步进
min integer 最小值

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
 "name": "宠物屋",
"entities": [
{
"id": 0,
"display_name": "机智云开发套件",
"attrs": [
{
"display_name": "开启/关闭红色灯",
"name": "LED_OnOff",
"data_type": "bool",
"position": {
"bit_offset": 0,
"len": 1,
"unit": "bit",
"byte_offset": 0
},
"type": "status_writable",
"id": 0,
"desc": "....."
}
],
"name": "entity0"
}
],
"protocolType": "standard",
"product_key": "268162799f764b999f834b5a02eb894d",
"packetVersion": "0x00000004",
"ui": {
"object": {
"version": 4,
"showEditButton": false
},
"sections": [
{
"elements": [
{
"boolValue": false,
"object": {
"action": "entity0",
"bind": [
"entity0.LED_OnOff"
],
"perm": "W"
},
"type": "QBooleanElement",
"key": "entity0.LED_OnOff",
"title": "开启/关闭红色灯"
}
]
}
]
}
}

获取设备详情

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/devices/{did}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 设备ID

响应参数

参数 类型 描述
product_key string 产品product_key
did string 设备id
mac string 设备mac地址
is_online boolean 是否在线
passcode string 设备 passcode
host string 连接服务器的域名
port integer M2M 的 mqtt 端口号
port_s integer M2M 的 mqtt SSL 端口号
ws_port integer websocket 端口号
wss_port integer websocket SSL 端口号
remark string 设备备注
is_disabled boolean 是否注销
type string 设备类型,单品设备:normal,中控设备:center_control,中控子设备:sub_dev
dev_alias string 设备别名
dev_label Array[string] 设备标签列表,目前用于语音 API 批量设备控制
role string 绑定角色, 首绑用户:special,拥有者:owner,访客:guest,普通用户:normal

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"remark": "",
"ws_port": 8080,
"did": "gKufzxZwYeyd3Skbsb6mzz",
"port_s": 8883,
"is_disabled": false,
"host": "m2m.gizwits.com",
"product_key": "4214bf2d79694a259232431b6f2ef46a",
"port": 1883,
"mac": "accf2350d446",
"role": "guest",
"is_online": false,
"passcode": "JHHOOIWJBY",
"wss_port": 8880
}

获取设备的通信日志和上下线记录

调试接口

入参的类型(type)

  1. 通信日志查询, type 字段为 cmd
  2. 上下线记录查询, type 字段为 online

返回结果(type)
meta:

  1. 通信日志查询, type 字段为 cmd
  2. 上下线记录查询, type 字段为 online

objects:

  1. 通信数据查询返回数据字段的 type 字段为 app2dev(app 到设备的通信), dev2app(设备到 app 的通信)
  2. 上下线查询返回数据的 type 字段为 dev_online(上线), dev_re_online(完成离线流程前再次登陆), dev_offline(离线)

结束时间戳end_time

  1. 必须小于等于当前系统时间戳
  2. 必须大于开始时间戳.
  3. 终止时间戳与开始时间戳之差必须小于48小时

请求地址及方式

GET
https://api.gizwits.com/app/devices/{did}/raw_data?type={type}&start_time={start_time}&end_time={end_time}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 设备ID
type string query 类型,cmd:通信日志;online:上下线记录
start_time integer query 开始时间戳,单位秒
end_time integer query 结束时间戳,单位秒
skip integer query 跳过的条数,跳过条目数+返回条目数必须<=5000, 默认为0
limit query integer query 返回的条数,需<=1000,默认为20
sort string query 排序方式,dese:降序;ase:升序。默认降序

响应参数

参数 类型 描述
sort string 排序方式,dese:降序;ase:升序
limit integer 返回的条数
end_time integer 结束时间戳
did string 设备ID
skip integer 跳过的条数
start_time integer 开始时间戳
total integer 查询结果的条数
type string meta的type。查询类型,cmd:通信日志;online:上下线记录
type string objects的type。 类型:app2dev:app 到设备的通信;dev2app:设备到 app 的通信;dev_online:上线;dev_re_online:完成离线流程前再次登陆;dev_offline:离线
ip string 上报数据端的IP地址
payload_bin string 通讯数据
timestamp integer 上报数据的时间
source string app2dev时,才有此字段触发端的类型,d3:有D3规则引擎触发;client:客户端上报数据
uid string app2dev时,才有此字段。用户的User ID
appid string app2dev时,才有此字段。APP ID

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
"meta": {
"sort": "desc",
"limit": 20,
"end_time": 1505871861,
"did": "WCWGkbS4Ttynzwx9brzpEa",
"skip": 0,
"start_time": 1505750399,
"total": 17,
"type": "cmd"
},
"objects": [
{
"ip": "10.104.109.219",
"payload_bin": "000000030b0000910400000010000000",
"type": "dev2app",
"timestamp": 1505871342.875
},
{
"ip": "127.0.0.1",
"payload_bin": "0000000309000090010200000010",
"type": "app2dev",
"timestamp": 1505871743.564,
"source": "d3"
},
{
"uid": "c0a85d0773e24f15a6853f3148c80a33",
"timestamp": 1505871743.2,
"ip": "183.233.131.216",
"payload_bin": "000000030400009002",
"source": "client",
"appid": "17f5eabb5782434da65fffdc87e605bf",
"type": "app2dev"
}
]
}

远程控制设备

调试接口

通过云端对设备进行控制

原始指令(raw):

默认格式为十进制数组,设置 binary_coding 参数可使用 hex 和 base64,
如要发送 payload 为二进制 011000010110001001100011 ,每组byte换成一个十进制数组的值得就是:[97,98,99];
如要发送 payload 为16进制 616263 ,每组byte换成一个十进制数组的值得就是:[97,98,99]。

1
2
3
{
"raw": [97,98,99]
}

数据点方式(attrs):

设备产品必须定义了数据点。如要设置扩展类型的字段 binary 为16进制 1234567 ,需要补齐扩展型长度:
扩展型默认为hex16 ,设置 binary_coding 参数可使用 base64 。

1
2
3
4
5
{
"attrs": {
"binary": "1234567000"
}
}

请求地址及方式

POST
https://api.gizwits.com/app/control/{did}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 设备ID
raw Array[integer] body 原始控制指令
attrs object body

注:body的参数最少填写输入一个

响应参数

设备分享

开启设备分享功能后,“绑定角色”就会有 Owner 和 Guest。

设备分享的主要有两种方式:

  • 普通设备分享
  • 通过二维码分享设备

分享使用场景

普通设备分享

  • Owner 选择一个要分享的设备,调用创建分享邀请接口创建分享邀请
  • Owner 和 Guest 都将收到一条设备分享消息
  • 被分享的用户调用查询分享邀请接口,查询分享给自己的邀请
  • 被分享的用户调用接受分享邀请接口接受邀请,被分享的用户成为 Guest
  • Owner 和 Guest 都将收到一条设备接受分享消息

通过二维码分享设备

  • Owner 选择一个要分享的设备,调用创建分享邀请接口创建分享邀请
  • 接口返回字段中的 qr_content 生成二维码信息,Owner 将二维码图片展示给需要分享的用户
  • 用户扫描二维码,获取邀请码,调用查询二维码分享信息接口,查看分享内容
  • 再调用接受二维码分享邀请接口,接受分享邀请,被分享的用户成为 Guest
  • Owner 和 Guest 都将收到一条设备分享消息

取消设备分享

  • Owner 调用取消/收回分享接口,取消分享出去的邀请取消,及收回已经接受的邀请
  • Guest 用户若还没有接受,Owner 将收到一条设备取消分享消息
  • Guest 用户对设备的绑定被取消,同时,Owner 和 Guest 都将收到一条设备取消分享消息

Owner 权限转移

  • Owner 调用权限转移接口,填写需要转移的设备和需要成为owner用户的ID
  • 原 Owner 用户解绑设备,原 Guest 用户成为新的 Owner

创建分享邀请

调试接口

此接口只有设备主账号可以调用

  • 如果 type 为普通分享,uid/username/email/phone 四选一,为是被分享者的用户信息;
  • 如果 type 为二维码分享,uid、username、email、phone 设置为空,若设置不会生效;
  • 普通分享24小时过期,二维码分享15分钟过期;
  • 针对二维码分享,客户端收到返回的二维码内容之后,本地生成二维码图片;

请求地址及方式

POST
https://api.gizwits.com/app/sharing

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
type integer body 分享类型,0:普通分享,1:二维码分享
did string body 设备ID
uid string body 普通分享类型,被分享的用户ID
username string body 普通分享类型,被分享的用户名
email string body 普通分享类型,被分享的用户邮箱地址
phone string body 普通分享类型,被分享的用户手机号码
duration integer body 持续分享时间,guest 接受分享之后可使用设备的时长,单位:分钟。最小时长 1 分钟,最大时长 1440 分钟

响应参数

参数 类型 描述
id string 分享记录id,针对普通分享才有
qr_content integer 二维码图片内容,针对二维码分享才有

返回例子

1
2
3
4
{
"qr_content": "type=share&code=60a6cacabe4046f4aa25ac1f79d81a4f",
"id": null
}

查询分享邀请

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/sharing?sharing_type={sharing_type}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
sharing_type integer query 分享类型,0:我分享的设备,1:分享给我的设备
status string query 分享状态,0:未接受分享,1:已接受分享,2:拒绝分享,3:取消分享
did string query 指定的设备did,只有owner用户可查询指定did的分享信息
limit integer query 返回的条数,默认20
skip integer query 跳过的条数,默认0

响应参数

参数 类型 描述
total integer 总条数
limit integer 返回的条数
skip integer 跳过的条数
previous string 上一页的请求地址
next string 下一页的请求地址
id integer 分享记录id
type integer 分享类型,0:普通分享,1:二维码分享
uid string 用户ID
username string 用户名,中间4个字母*替代
user_alias string 用户别名
email string 用户邮箱地址,@前面4个字符*替代
phone string 用户手机号码,中间4个数字*替代
did string 设备id
product_name string 产品名称
dev_alias string 设备别名
status integer 当前分享状态 0:未接受分享,1:已接受分享,2:拒绝分享,3:取消分享
created_at string 创建分享时间 (UTC时间)
updated_at string 分享状态更新时间 (UTC时间)
expired_at string 分享超时时间 (UTC时间)

注:

  • 若 sharing_type 为 0,表示以 Owner 身份查询自己发出的分享邀请,返回结果中用户信息为 Guest 的信息
  • 若 sharing_type 为 1,表示以 Guest 身份查询收到的分享邀请,返回结果中的用户信息为 Owner 的信息

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
"meta": {
"previous": null,
"skip": 0,
"total": 1,
"limit": 20,
"next": null
},
"objects": [
{
"status": 0,
"username": "G****s",
"uid": "f082f4e235974cfeb6a1b2346024f47e",
"did": "gKufzxZwYeyd3Skbsb6mza",
"created_at": "2017-07-21T09:46:56Z",
"updated_at": "2017-07-21T09:46:56Z",
"email": "G****s@gizwits.com",
"phone": null,
"dev_alias": "设备别名",
"id": 10411,
"user_alias": "gizwits",
"type": 0,
"product_name": "微信宠物屋",
"expired_at": "2017-07-22T09:46:56Z"
}
]
}

取消/收回分享

调试接口

二维码分享的设备无法收回

请求地址及方式

DELETE
https://api.gizwits.com/app/sharing/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id integer path 分享记录id

响应参数

参数 类型 描述
id integer 分享记录id

返回例子

1
2
3
{
"id": 10471
}

接受/拒绝分享

调试接口

二维码分享的设备无法收回

请求地址及方式

PUT
https://api.gizwits.com/app/sharing/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id integer path 分享记录id
status integer query 接受/拒绝分享,1:接受分享,2:拒绝分享

响应参数

参数 类型 描述
id integer 分享记录id

返回例子

1
2
3
{
"id": 10471
}

获取二维码分享信息

调试接口

设备拥有者 owner 无法使用此接口

请求地址及方式

GET
https://api.gizwits.com/app/sharing/code/{code}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
code integer path 二维码分享的qr_content

响应参数

参数 类型 描述
owner string 设备拥有者信息,手机号/邮箱/用户名/uid
product_name string 产品名称
dev_alias string 设备别名
expired_at string 分享超时时间(UTC时间)

返回例子

1
2
3
4
5
6
{
"owner": "G****s",
"product_name": "微信宠物屋",
"dev_alias": "设备别名",
"expired_at": "2017-08-21T12:22:58Z"
}

接受二维码分享邀请

调试接口

设备拥有者 owner 无法使用此接口

请求地址及方式

POST
https://api.gizwits.com/app/sharing/code/{code}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
code integer path 二维码分享的qr_content

响应参数

修改用户备注信息

调试接口

请求地址及方式

PUT
https://api.gizwits.com/app/sharing/{id}/alias?user_alias={user_alias}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id integer path 分享记录id
user_alias string query

响应参数

owner 权限转移

调试接口

请求地址及方式

POST
https://api.gizwits.com/app/sharing/1/transfer?uid=1

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string 设备ID
uid string query 需要成为owner用户的ID

响应参数

设备分组

设备分组常用场景:

1、将多个设备归类到某一个物理空间,如:房间、客厅。方便管理

2、对相同产品的多个设备进行统一控制,如:走廊的全部灯开关

查询用户所有的分组

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/group

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token

响应参数

参数 类型 描述
created_at string 设备分组创建时间(UTC 时间)
updated_at string 设备分组更新时间(UTC 时间)
product_key string 产品 product_key,单PK的分组才会有值
group_name string 设备分组名称
verbose_name string 产品名称,单PK的分组才会有值
id string 设备分组 id

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
{
"created_at": "2017-09-22T09:57:44Z",
"updated_at": "2017-09-22T09:57:44Z",
"product_key": "4214b12d79694a259232431b6f2ef46a",
"group_name": "分组名称1",
"verbose_name": "微信宠物屋",
"id": "59c4de98dc348f001a08feba"
},
{
"created_at": "2017-09-22T09:58:18Z",
"updated_at": "2017-09-22T09:58:18Z",
"product_key": "",
"group_name": "分组名称2",
"verbose_name": "",
"id": "59c4deba8c7d50001ba06df3"
}
]

创建分组

调试接口

请求地址及方式

POST
https://api.gizwits.com/app/group

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
product_key string body 产品PK,对单个pk分组需要输入此参数
group_name string body 设备分组名称

响应参数

参数 类型 描述
id string 设备分组 id

返回例子

1
2
3
{
"id": "59c4deba8c7d50001ba06df3"
}

删除设备分组

调试接口

请求地址及方式

DELETE
https://api.gizwits.com/app/group/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 设备分组 id

响应参数

修改分组信息

调试接口

请求地址及方式

PUT
https://api.gizwits.com/app/group/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 设备分组 id
group_name string body 设备分组名称

响应参数

查询分组的设备信息

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/group/{id}/devices

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 设备分组 ID

响应参数

参数 类型 描述
did string 该分组下的设备ID
type string 设备类型:普通设备:noramal;中控设备:center_control;中控子设备:sub_dev
verbose_name string 产品名称,单PK的分组才会有值
dev_alias string 设备别名
product_key string 产品 product_key,单PK的分组才会有值

返回例子

1
2
3
4
5
6
7
8
9
[
{
"did": "WCWGkbS4Ttynzwx9brzpEa",
"type": "normal",
"verbose_name": "微信宠物屋",
"dev_alias": "设备别名",
"product_key": "4234bf2d79694a259232431b6f2ef46a"
}
]

将设备列表添加到分组

调试接口

请求地址及方式

POST
https://api.gizwits.com/app/group/{id}/devices?show_detail={show_detail}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 设备分组 ID
show_detail integer query 返回错误信息,1:添加失败的did返回详细错误信息,0(默认值):添加失败的did,不返回详细错误信息
dids Array body 需要添加到分组的设备ID数组

响应参数

参数 类型 描述
failed Array 添加成功的设备ID 数组
detail Array 添加失败原因,show_detail为1时候才会返回此信息
success Array 添加失败的设备ID 数组
did string 添加的失败的设备ID
error_message string 失败错误信息
error_code integer 失败错误码
detail_msg string 详细错误信息

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"failed": [
"WCWGkbS4Ttynz123czpEa"
],
"detail": [
{
"did": "WCWGkbS123cynzwxrzpEa",
"error_message": "device not found!",
"error_code": 9014,
"detail_msg": null
}
],
"success": [
"XD3GkbS21tynzwx9brzpEa"
]
}

将设备列表从分组移除

调试接口

请求地址及方式

DELETE
https://api.gizwits.com/app/group/{id}/devices

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 设备分组 ID
dids Array body 需要移出分组的设备ID数组

响应参数

参数 类型 描述
failed Array 添加成功的设备ID 数组
success Array 添加失败的设备ID 数组
did string 添加的失败的设备ID

返回例子

1
2
3
4
5
6
{
"failed": [],
"success": [
"WCWGkb234tynzwx9brzpEa"
]
}

对设备分组内的设备统一控制

调试接口

通过云端对分组内的所有设备进行控制,该接口只能统一控制单PK分组的设备。

原始指令(raw):

默认格式为十进制数组,设置 binary_coding 参数可使用 hex 和 base64,
如要发送 payload 为二进制 011000010110001001100011 ,每组byte换成一个十进制数组的值得就是:[97,98,99];
如要发送 payload 为16进制 616263 ,每组byte换成一个十进制数组的值得就是:[97,98,99]。

1
2
3
{
"raw": [97,98,99]
}

数据点方式(attrs):

设备产品必须定义了数据点。如要设置扩展类型的字段 binary 为1234567(16进制),需要补齐扩展型长度;
扩展型默认为hex16 ,设置 binary_coding 参数可使用 base64 。

1
2
3
4
5
6
{
"attrs": {
"boolean":true,
"binary": "1234567000"
}
}

请求地址及方式

POST
https://api.gizwits.com/app/group/{id}/control

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 设备分组 ID
raw Array[integer] body 原始控制指令
attrs object body

响应参数

参数 类型 描述
did string 分组下的设备ID
result boolean 是否控制成功,true:成功;false:失败

返回例子

1
2
3
4
5
6
7
8
9
10
[
{
"did": "WCWGkbS4Tty123x9brzpEa",
"result": true
},
{
"did": "gKufzxZw43dd3Skbsb6mzz",
"result": false
}
]

设备联动

创建设备联动的规则,实现一个或多个设备的状态变化时,自动控制一个或多个设备的状态改变。

联动的设备需要绑定同一个用户,不同产品下的设备需要先进行产品关联。

联动规则创建后,可以随时进行修改,或者删除。

点击查看详细使用教程

查询规则可用变量

调试接口

通过该接口可以查询appid所绑定的全部产品的数据点。

请求地址及方式

GET
https://api.gizwits.com/app/rules/params?product_key={product_key}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
product_key string query 多个pk用“,”隔开,参数为空时默认选中与appid绑定的所有pk,填入与appid无绑定的pk时该pk无效

响应参数

参数 类型 描述
display_name string 数据点显示名称
enum Array 枚举值
type string 数据类型,数值型:int;布尔型:bool;枚举型:enum;扩展型:binary
name string 数据点名称

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"4214b435f9694a259232431b6f2ef46a": [
{
"display_name": "开关",
"enum": [],
"type": "bool",
"name": "switch"
},
{
"display_name": "倒计时开机",
"enum": [],
"type": "int",
"name": "on_timing"
},
{
"display_name": "倒计时关机",
"enum": [],
"type": "int",
"name": "off_timing"
}
]
}

查询联动规则列表

调试接口

通过该接口可以查询appid所绑定的全部产品的数据点。

请求地址及方式

GET
https://api.gizwits.com/app/rules?limit=20&skip=0

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
limit integer query 返回的结果条数
skip integer query 表示跳过的条数,间接表示页数

响应参数

参数 类型 描述
remark string 联动规则备注
name string 联动规则名称
did string 设备ID
interval integer 最小触发间隔(单位:秒)
product_key string 产品PK
rule_id integer 联动规则ID
event string 触发方式
event_attr object 当触发方式为alert(报警)/fault(故障),[RulesEventAttr]
input Array 规则中需要用到的设备数据 [RulesInput]
condition Array 条件判断 [RulesCondition]
output Array 触发动作 [RulesOutput]
RulesEventAttr —————— ——————
attr_name string 发生这个报警/故障的数据点
value string 报警/故障的发生/取消, 1表示发生, 0表示取消
RulesOutput —————— ——————
did string 被控制的设备id
type string 触发类型,devctrl:控制设备;delay:延时
attrs object 数据点方式控制设备
raw Array 原始控制指令
delay integer 延时时长, 单位:秒
RulesInput —————— ——————
did string 规则数据的来源的设备id
prefix string 用于在条件及输出中引用这个设备的数据点值的前缀
product_key string 规则数据的来源的设备对应的产品PK
RulesCondition —————— ——————
opt string 比较运算符, 可选值有: >, >=, <, <=, ==, != (注:只有数值类型才能比较大小)
right string 右比较参数
left string 左比较参数

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
"rules": [
{
"remark": "",
"name": "打开开关,三灯100值",
"did": "WCWGkbS4Ttynzwx9brzpEa",
"interval": 0,
"product_key": "4214bf2d123194a259232431b6f2ef46a",
"event": "data",
"output": [
[
{
"did": "WCWGk43ftynzwx9brzpEa",
"type": "devctrl",
"attrs": {
"LED_R": 100,
"LED_G": 100,
"LED_B": 100
}
}
],
[
{
"did": "WCWGk43ftynzwx9brzpEa",
"type": "devctrl",
"attrs": {
"fan_swing": 1
}
}
]
],
"input": [
{
"did": "WCWGk43ftynzwx9brzpEa",
"prefix": "device1",
"product_key": "4214bf2d123194a259232431b6f2ef46a"
},
{
"did": "WCWGk43ftynzwx9brzpEa",
"prefix": "device2",
"product_key": "4214bf2d123194a259232431b6f2ef46a"
}
],
"rule_id": 8826,
"condition": [
[
{
"opt": "==",
"right": "1",
"left": "device1.switch"
}
]
]
}
]
}

创建联动规则

调试接口

product_key与did:

当触发方式为online/offline/alert/fault/data时, 产生这个触发方式的设备由该参数指定, 以下把指定的这个设备称为主设备

event参数

表示该规则的触发方式,以下是可选值的意义:

1
2
3
4
5
online  : 设备上线
offline : 设备下线
alert : 设备某个报警数据点发生报警
fault : 设备某个故障数据点发生故障
data : 设备上报状态

event_attr参数

表示当触发方式为alert(报警)/fault(故障)时, 发生这个报警/故障的数据点,以及报警/故障的发生/恢复,由该参数指定

1
2
3
4
"event_attr": {
"attr_name": "datapoint_alert", //发生这个报警/故障的数据点
"value": "1" //报警/故障的发生/取消, 值为1时表示发生, 值为0时表示取消
}

注:

  • 这里提到的报警/故障的”发生”指的是-设备上一次上报的报警/故障数据点的值为0, 这一次上报的为1, 那么报警/故障发生
  • 这里提到的报警/故障的”恢复”指的是-设备上一次上报的报警/故障数据点的值为1, 这一次上报的为0, 那么报警/故障恢复
  • 其他情况均不属于”发生”和”恢复”

input参数

指定规则中需要用到的设备数据,数组中每一个对象代表一个设备的数据,不需要使用设备数据时可忽略此参数:

1
2
3
4
5
[{
"product_key": "pk1", //设备所属Product key
"did": "did1", //设备did
"prefix": "device1" //用于在条件及输出中引用这个设备的数据点值的前缀, 如设置了这个参数为device1时,则device1.datapoint1表示引用这个设备的标识名为datapoint1的数据点
}]

condition参数

指定触发规则需要满足的条件, 云端处理时将逐组检查数组内的条件, 任意一组条件满足时触发输出

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[
[{
"left": "device1.datapoint1",//左比较参数, 参数的值类型需要和右比较参数一致
"opt": "==", //比较运算符, 可选值有: >, >=, <, <=, ==, != (注:只有数值类型才能比较大小)
"right": "1" //右比较参数, 参数的值类型需要和左比较参数一致,使用常数时注意,"1"代表数字1,"'1'"或"\"1\""才是字符串"1"
}],
[{// 每个数组表示一组条件,当这个组里的所有条件都满足时,这一组条件满足
"left": "device1.datapoint1",
"opt": "==",
"right": "1"
},{
"left": "device2.datapoint2",
"opt": ">",
"right": "25"
}]
]

output参数

指定当条件满足时, 需要做的事情,可认为云端同时执行各组动作,各组之间互不影响

原始指令(raw):

默认格式为十进制数组
如要发送 payload 为二进制 011000010110001001100011 ,每组byte换成一个十进制数组的值得就是:[97,98,99];
如要发送 payload 为16进制 616263 ,每组byte换成一个十进制数组的值得就是:[97,98,99]。

1
2
3
{
"raw": [97,98,99]
}

数据点方式(attrs):

设备产品必须定义了数据点。如要设置扩展类型的字段 binary 为16进制 1234567,需要补齐扩展型长度:

1
2
3
4
5
{
"attrs": {
"binary": "1234567000"
}
}

output参数示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
[
[{ // 每个数组表示一组输出动作,按顺序执行,前面的动作执行失败时,后面不会执行
"type": "devctrl", // output的类型, devctrl表示控制设备
"did": "did1", // 指定被控制的设备的did
"attrs": { // key-value形式
"datapoint1": 1, // 设置datapoint1值为1
"datapoint2": 25,
"datapoint3": "黄色"
}
},{
"type": "delay", // output的类型, delay表示延时
"delay": 5 // 延时时长, 单位:秒
},{
"type": "devctrl",
"did": "QxP6E9qFwwzsqKb2UYf4uw",
"raw": [1, 2, 3] // raw形式
}],
[{
"type": "devctrl",
"did": "QxP6E9qFwwzsqKb2UYf4uw",
"attrs": {
"datapoint1": 1,
"datapoint2": 25,
"datapoint3": "黄色"
}
}]
]

请求地址及方式

POST
https://api.gizwits.com/app/rules

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
remark string body 联动规则备注
name string body 联动规则名称
did string body 设备ID
interval integer body 最小触发间隔(单位:秒)
product_key string body 产品PK
event string body 触发方式
event_attr object body 当触发方式为alert(报警)/fault(故障),[RulesEventAttr]
input Array body 规则中需要用到的设备数据 [RulesInput]
condition Array body 条件判断 [RulesCondition]
output Array body 触发动作 [RulesOutput]
RulesEventAttr —————— body ——————
attr_name string body 发生这个报警/故障的数据点
value string body 报警/故障的发生/取消, 1表示发生, 0表示取消
RulesOutput —————— body ——————
did string body 被控制的设备id
type string body 触发类型,devctrl:控制设备;delay:延时
attrs object body 数据点方式控制设备
raw Array body 原始控制指令
delay integer body 延时时长, 单位:秒
RulesInput —————— body ——————
did string body 规则数据的来源的设备id
prefix string body 用于在条件及输出中引用这个设备的数据点值的前缀
product_key string body 规则数据的来源的设备对应的产品PK
RulesCondition —————— body ——————
opt string body 比较运算符, 可选值有: >, >=, <, <=, ==, != (注:只有数值类型才能比较大小)
right string body 右比较参数
left string body 左比较参数

响应参数

参数 类型 描述
rule_id integer 联动规则ID

返回例子

1
2
3
{
"rule_id": 1213
}

删除联动规则

调试接口

请求地址及方式

DELETE
https://api.gizwits.com/app/rules/{rule_id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
rule_id integer path 需要删除的联动规则ID

响应参数

参数 类型 描述
rule_id integer 联动规则ID

返回例子

1
2
3
{
"rule_id": 1234
}

修改联动规则

调试接口

请求地址及方式

PUT
https://api.gizwits.com/app/rules/{rule_id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
remark string body 联动规则备注
name string body 联动规则名称
did string body 设备ID
interval integer body 最小触发间隔(单位:秒)
product_key string body 产品PK
rule_id integer body 联动规则ID
event string body 触发方式
event_attr object body 当触发方式为alert(报警)/fault(故障),[RulesEventAttr]
input Array body 规则中需要用到的设备数据 [RulesInput]
condition Array body 条件判断 [RulesCondition]
output Array body 触发动作 [RulesOutput]
RulesEventAttr —————— body ——————
attr_name string body 发生这个报警/故障的数据点
value string body 报警/故障的发生/取消, 1表示发生, 0表示取消
RulesOutput —————— body ——————
did string body 被控制的设备id
type string body 触发类型,devctrl:控制设备;delay:延时
attrs object body 数据点方式控制设备
raw Array body 原始控制指令
delay integer body 延时时长, 单位:秒
RulesInput —————— body ——————
did string body 规则数据的来源的设备id
prefix string body 用于在条件及输出中引用这个设备的数据点值的前缀
product_key string body 规则数据的来源的设备对应的产品PK
RulesCondition —————— body ——————
opt string body 比较运算符, 可选值有: >, >=, <, <=, ==, != (注:只有数值类型才能比较大小)
right string body 右比较参数
left string body 左比较参数

响应参数

参数 类型 描述
rule_id integer 联动规则ID

返回例子

1
2
3
{
"rule_id": 1234
}

用户场景

查询用户所有的场景

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/scene

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token

响应参数

参数 类型 描述
id string 场景 id
scene_name string 场景名称
created_at string 场景创建时间(UTC 时间)
updated_at string 场景更新时间(UTC 时间)
remark string 场景备注
task_type string 场景任务类型:”delay”: 延时任务,”device”: 控制当个设备任务,”group”: 控制设备分组任务(仅可控制单 product_key 分组)
did string 针对单品控制任务,设备 did
product_key string 针对非延时任务,产品 product_key
group_name string 针对设备分组控制任务,设备分组名称
raw string 针对非延时任务,原始控制指令,base64 编码
attrs object 针对非延时任务,数据点控制命令,枚举型数据点传序号,扩展型数据点传 base64 编码字符串
dev_remark string 针对设备控制任务,设备备注
time integer 针对延时任务,延时时间,以秒为单位,最大值: 3600 秒
group_id string 针对设备分组控制任务,设备分组 id
verbose_name string 针对非延时任务,产品名称
dev_alias string 针对设备控制任务,设备别名

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
[
{
"remark": "备注",
"tasks": [
{
"task_type": "device",
"did": "WCWGkbS4Ttynzw123rzpEa",
"product_key": "4214bf2d79321259232431b6f2ef46a",
"group_name": "",
"raw": "",
"attrs": {
"switch": true
},
"dev_remark": "",
"time": 0,
"group_id": "",
"verbose_name": "微信宠物屋",
"dev_alias": ""
}
],
"created_at": "2017-09-25T10:09:07Z",
"updated_at": "2017-09-25T10:09:07Z",
"scene_name": "场景名",
"id": "59c8d5c3234d50001a21c872"
}
]

创建场景

调试接口

原始指令(raw):

默认格式为 base64 ,设置 binary_coding 参数可使用 hex,
如要发送 payload 为 010203 ,编译后就是: AQID ;

1
2
3
{
"raw": "AQID"
}

数据点方式(attrs):

设备产品必须定义了数据点。如要设置扩展类型的字段 binary 为1234567(16进制),需要补齐扩展型长度;
扩展型默认为hex16 ,设置 binary_coding 参数可使用 base64 。

1
2
3
4
5
6
{
"attrs": {
"boolean":true,
"binary": "1234567000"
}
}

请求地址及方式

POST
https://api.gizwits.com/app/scene

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
scene_name string body 场景名称
remark string body 场景备注
task_type string body 场景任务类型: “delay”: 延时任务,”device”: 控制当个设备任务,”group”: 控制设备分组任务(仅可控制单 product_key 分组)
time integer body 针对延时任务,延时时间,以秒为单位,最大值: 3600 秒
did string body 针对单品控制任务,设备 did
group_id string body 针对设备分组控制任务,设备分组 id
attrs object body 针对非延时任务,数据点控制命令,枚举型数据点传序号,扩展型数据点传 base64 编码字符串
raw string body 针对非延时任务,原始控制指令,base64 编码

响应参数

参数 类型 描述
id string 场景 id

返回例子

1
2
3
{
"id": "59c8d5c38c7d50001a21c872"
}

删除场景

调试接口

请求地址及方式

DELETE
https://api.gizwits.com/app/scene/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 场景ID

响应参数

修改场景信息

调试接口

请求地址及方式

POST
https://api.gizwits.com/app/scene/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 场景ID
scene_name string body 场景名称
remark string body 场景备注
task_type string body 场景任务类型: “delay”: 延时任务,”device”: 控制当个设备任务,”group”: 控制设备分组任务(仅可控制单 product_key 分组)
time integer body 针对延时任务,延时时间,以秒为单位,最大值: 3600 秒
did string body 针对单品控制任务,设备 did
group_id string body 针对设备分组控制任务,设备分组 id
attrs object body 针对非延时任务,数据点控制命令,枚举型数据点传序号,扩展型数据点传 base64 编码字符串
raw string body 针对非延时任务,原始控制指令,base64 编码

响应参数

查询场景任务执行状态

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/scene/{id}/task

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 场景ID

响应参数

参数 类型 描述
status integer 场景任务执行状态,0:进行中;1:执行完成;2:执行失败;3:任务未在执行

返回例子

1
2
3
{
"status": 1
}

执行场景任务

调试接口

请求地址及方式

POST
https://api.gizwits.com/app/scene/{id}/task

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 场景ID

响应参数

  • 返回成功,场景任务开始执行

定时任务管理

定时任务分为如下几类:

  • 一次性定时任务
  • 按星期重复定时任务
  • 按天重复定时任务

每个定时任务都可以设置使能状态,只有开启状态的定时任务才会被执行。

定时任务管理下的全部接口均使用 UTC 时间

定时任务管理接口只能对单个设备设置定时任务

获取定时任务

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/devices/{did}/scheduler?limit=20&skip=0

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 需要设置定时任务的设备id
limit integer query 返回的结果条数
skip integer query 表示跳过的条数,间接表示页数。

响应参数

参数 类型 描述
id string 定时任务id
created_at string 任务创建时间 UTC 时间
product_key string 产品PK
did string 需要设置定时任务的设备id
raw string 原始控制指令
attrs object
date string 一次性定时任务的执行时间
time string 定时任务执行的时间,精确到分钟,格式xx:xx,如:02:30
repeat string 是否重复,”none”,”mon”, “tue”, “wed”, “thu”, “fri”, “sat”, “sun”
days Array 重复的日期列表,如[1, 15]表示每月1日和15日重复
start_date string 定时任务执行的开始日期,该天0点开始,格式xxxx-xx-xx,如2016-09-01
end_date string 定时任务执行的结束日期,该天24点结束,格式xxxx-xx-xx,如2016-10-01
enabled boolean 是否启用,若不启用则时间到也不触发,默认启用
remark string 任务备注

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[
{
"remark": "备注",
"repeat": "none",
"end_date": "2017-09-26",
"did": "LWHWrRAnzRbxtv9cyuNFSY",
"created_at": "2017-09-26T06:36:47",
"enabled": true,
"days": [],
"product_key": "b6777e0a343b422b8c474254e016b4dc",
"id": "59c9f57f8c7d50001963992c",
"raw": "",
"attrs": {
"bool": true
},
"time": "15:00",
"date": "2017-09-26",
"start_date": "2017-09-20"
}
]

创建定时任务

调试接口

创建一次性定时任务

  • repeat 设置为 none
  • date 和 time 必须填写,并且注意 date 和 time 为执行定时任务时的 UTC 时间

创建按星期重复定时任务

  • repeat 为重复星期,多个用逗号分隔;比如每周一执行,设置为 “mon”,每周一、周三执行,设置为 “mon,wed”;
  • repeat 为重复星期时,可选值为: mon,tue,wed,thu,fri,sat,sun
  • time 必须填写,并且注意星期和 time 为执行定时任务时的 UTC 时间
  • 可以选填 start_date 和 end_date 表示定时任务开启的日期范围

创建按天重复的定时任务

  • repeat 设置为 day
  • days 设置为要执行的日期列表;比如每月 1 号执行,设置为 [“1”];每月 1 号、15 号执行,设置为 [“1”, “15”]
  • time 必须填写,并且注意 days 和 time 为执行定时任务时的 UTC 时间
  • 可以选填 start_date 和 end_date 表示定时任务开启的日期范围

原始指令(raw):

默认格式为 hex16 ,设置 binary_coding 参数可使用 base64 ,
如要发送 payload 为二进制 011000010110001001100011 ,每组byte换成16进制就是: 616263 ;

1
2
3
{
"raw": 616263
}

数据点方式(attrs):

设备产品必须定义了数据点。如要设置扩展类型的字段 binary 为1234567(16进制),需要补齐扩展型长度;
扩展型默认为hex16 ,设置 binary_coding 参数可使用 base64 。

1
2
3
4
5
6
{
"attrs": {
"boolean":true,
"binary": "1234567000"
}
}

请求地址及方式

POST
https://api.gizwits.com/app/devices/{did}/scheduler

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 需要设置定时任务的设备id
raw string body 原始控制指令
attrs object body
date string body 一次性定时任务的执行时间
time string body 定时任务执行的时间,精确到分钟,格式xx:xx,如:02:30
repeat string body 是否重复,”none”,”mon”, “tue”, “wed”, “thu”, “fri”, “sat”, “sun”
days Array body 重复的日期列表,如[1, 15]表示每月1日和15日重复
start_date string body 定时任务执行的开始日期,该天0点开始,格式xxxx-xx-xx,如2016-09-01
end_date string body 定时任务执行的结束日期,该天24点结束,格式xxxx-xx-xx,如2016-10-01
enabled boolean body 是否启用,若不启用则时间到也不触发,默认启用
remark string body 任务备注

响应参数

参数 类型 描述
id string 定时任务id

返回例子

1
2
3
{
"id": "59c9f57f8c7d50001963992c"
}

修改定时任务

调试接口

请求地址及方式

PUT
https://api.gizwits.com/app/devices/{did}/scheduler/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 需要设置定时任务的设备id
id string path 需要修改的定时任务id
raw string body 原始控制指令
attrs object body
date string body 一次性定时任务的执行时间
time string body 定时任务执行的时间,精确到分钟,格式xx:xx,如:02:30
repeat string body 是否重复,”none”,”mon”, “tue”, “wed”, “thu”, “fri”, “sat”, “sun”
days Array body 重复的日期列表,如[1, 15]表示每月1日和15日重复
start_date string body 定时任务执行的开始日期,该天0点开始,格式xxxx-xx-xx,如2016-09-01
end_date string body 定时任务执行的结束日期,该天24点结束,格式xxxx-xx-xx,如2016-10-01
enabled boolean body 是否启用,若不启用则时间到也不触发,默认启用
remark string body 任务备注

响应参数

参数 类型 描述
id string 定时任务id

返回例子

1
2
3
{
"id": "59c9f57f8c7d50001963992c"
}

删除定时任务

调试接口

请求地址及方式

DELETE
https://api.gizwits.com/app/devices/{did}/scheduler/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 需要设置定时任务的设备id
id string path 定时任务id

响应参数

通用定时任务

通用定时任务定时任务管理 的升级接口,能对场景、分组和单个设备创建定时任务。

获取定时任务

调试接口

请求地址及方式

GET
https://api.gizwits.com/app/common_scheduler?did={did}&group_id={group_id}&scene_id={scene_id}&limit={limit}&skip={skip}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 需要设置定时任务的设备id
group_id string path 分组id
scene_id string path 场景id
limit integer query 返回的结果条数
skip integer query 表示跳过的条数,间接表示页数。

响应参数

参数 类型 描述
id string 定时任务id
created_at string 任务创建时间 UTC 时间
product_key string 产品PK
scene_id string
group_id string
did string 需要设置定时任务的设备id
raw string 原始控制指令
attrs object
date string 一次性定时任务的执行时间
time string 定时任务执行的时间,精确到分钟,格式xx:xx,如:02:30
repeat string 是否重复,”none”,”mon”, “tue”, “wed”, “thu”, “fri”, “sat”, “sun”
days Array 重复的日期列表,如[1, 15]表示每月1日和15日重复
start_date string 定时任务执行的开始日期,该天0点开始,格式xxxx-xx-xx,如2016-09-01
end_date string 定时任务执行的结束日期,该天24点结束,格式xxxx-xx-xx,如2016-10-01
enabled boolean 是否启用,若不启用则时间到也不触发,默认启用
remark string 任务备注

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[
{
"remark": "备注",
"repeat": "none",
"end_date": "2017-09-26",
"did": "LWHWrRAnzRbxtv9cyuNFSY",
"created_at": "2017-09-26T06:36:47",
"enabled": true,
"days": [],
"product_key": "b6777e0a343b422b8c474254e016b4dc",
"id": "59c9f57f8c7d50001963992c",
"raw": "",
"attrs": {
"bool": true
},
"time": "15:00",
"date": "2017-09-26",
"scene_id": "",
"group_id": "",
"start_date": "2017-09-20"
}
]

创建定时任务

调试接口

  • did, group_id, scene_id 参数只需传其中一个,分别用于创建设备,设备分组,用户场景定时任务,
  • 若同时传了多个,则按此优先级取第一个有效字符串;
  • 针对场景任务,不需要传 raw 和 attrs 控制命令,传了会被忽略;
  • 创建循环类型与定时任务管理接口一致。

原始指令(raw):

默认格式为 hex16 ,设置 binary_coding 参数可使用 base64 ,
如要发送 payload 为二进制 011000010110001001100011 ,每组byte换成16进制就是: 616263 ;

1
2
3
{
"raw": 616263
}

数据点方式(attrs):

设备产品必须定义了数据点。如要设置扩展类型的字段 binary 为1234567(16进制),需要补齐扩展型长度;
扩展型默认为hex16 ,设置 binary_coding 参数可使用 base64 。

1
2
3
4
5
6
{
"attrs": {
"boolean":true,
"binary": "1234567000"
}
}

请求地址及方式

POST
https://api.gizwits.com/app/common_scheduler

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string body 需要设置定时任务的设备id
group_id string body 需要设置定时任务的设备分组id
scene_id string body 需要设置定时任务的场景id
raw string body 原始控制指令
attrs object body
date string body 一次性定时任务的执行时间
time string body 定时任务执行的时间,精确到分钟,格式xx:xx,如:02:30
repeat string body 是否重复,”none”,”mon”, “tue”, “wed”, “thu”, “fri”, “sat”, “sun”
days Array body 重复的日期列表,如[1, 15]表示每月1日和15日重复
start_date string body 定时任务执行的开始日期,该天0点开始,格式xxxx-xx-xx,如2016-09-01
end_date string body 定时任务执行的结束日期,该天24点结束,格式xxxx-xx-xx,如2016-10-01
enabled boolean body 是否启用,若不启用则时间到也不触发,默认启用
remark string body 任务备注

响应参数

参数 类型 描述
id string 通用定时任务id

返回例子

1
2
3
{
"id": "59c9f57f8c7d50001963992c"
}

修改定时任务

调试接口

请求地址及方式

PUT
https://api.gizwits.com/app/common_scheduler/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
id string path 通用定时任务id
did string body 需要设置定时任务的设备id
group_id string body 需要设置定时任务的设备分组id
scene_id string body 需要设置定时任务的场景id
raw string body 原始控制指令
attrs object body
date string body 一次性定时任务的执行时间
time string body 定时任务执行的时间,精确到分钟,格式xx:xx,如:02:30
repeat string body 是否重复,”none”,”mon”, “tue”, “wed”, “thu”, “fri”, “sat”, “sun”
days Array body 重复的日期列表,如[1, 15]表示每月1日和15日重复
start_date string body 定时任务执行的开始日期,该天0点开始,格式xxxx-xx-xx,如2016-09-01
end_date string body 定时任务执行的结束日期,该天24点结束,格式xxxx-xx-xx,如2016-10-01
enabled boolean body 是否启用,若不启用则时间到也不触发,默认启用
remark string body 任务备注

响应参数

参数 类型 描述
id string 通用定时任务id

返回例子

1
2
3
{
"id": "59c9f57f8c7d50001963992c"
}

删除定时任务

调试接口

请求地址及方式

DELETE
https://api.gizwits.com/app/common_scheduler/{id}

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 需要设置定时任务的设备id
id string path 通用定时任务id

响应参数

高级数据接口

获取设备聚合数据

该接口可以对设备上报的数值型数据点数据进行聚合,可以按小时/天/周/月对数据点数据进行求和/平均值/最大值/最小值进行聚合。

一次可以获取多个数据点的聚合数据。

要使用该接口,必须先请求开通该接口。请求通过的之后上报的数据才会进行聚合运算。

调试接口

请求地址及方式

PUT
https://api.gizwits.com/app/devdata/{did}/agg_data

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid
X-Gizwits-User-token string header 用户token
did string path 设备ID
start_ts integer query 开始时间,单位为毫秒
end_ts integer query 结束时间,单位为毫秒
attrs string query 数字类型数据点名称,多个数据点用逗号分隔
aggregator string query 统计方式,sum:合计;avg:平均值;max:最大值;min:最少值
unit string query 汇总方式,hours:小时;day:天;weeks:周;months:月

响应参数

参数 类型 描述
aggregator string 统计方式,sum:合计;avg:平均值;max:最大值;min:最少值
end_ts integer 开始时间,单位为毫秒
start_ts integer 结束时间,单位为毫秒
attrs string 查询的数据点
unit string sum:合计;avg:平均值;max:最大值;min:最少值
datatime string
uid string 用户id
product_key string 产品PK
attrs object 数据点聚合结果

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"query": {
"aggregator": "sum",
"end_ts": null,
"start_ts": 1505318400000,
"attrs": "set_temp, alert_shutdown, room_temp",
"unit": "HOURS"
},
"data": [
{
"datatime":"",
"uid":"c0a85d0773e24f15a6853f3148c80a33",
"product_key":"42121342d79694a259232431b6f2ef46a",
"attrs":{
"set_temp":"12",
"alert_shutdown":"12",
"room_temp":"12"
}
}
]
}

系统信息

查询 Open API 版本

调试接口

请求地址及方式

GET
https://api.gizwits.com/status

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid

响应参数

参数 类型 描述
version string open API 版本号

返回例子

1
2
3
4
5
{
"status": {
"version": "2.15.1"
}
}

获取 Open API 所有的错误码

调试接口

请求地址及方式

GET
https://api.gizwits.com/errors

请求参数

参数 类型 必填 参数类型 描述
X-Gizwits-Application-Id string header appid

响应参数

参数 类型 描述
status string 响应码
error_code string 错误码
error_message string 错误信息

返回例子

1
2
3
4
5
6
7
8
9
10
11
12
[
{
"status": 404,
"error_message": "scene not found!",
"error_code": 9220
},
{
"status": 400,
"error_message": "the scene does not belong to you!",
"error_code": 9221
}
]

详细错误信息可查看下表Open API 错误码表

附录:Open API 错误码表

错误码 错误类别 描述
9001 GIZ_OPENAPI_MAC_ALREADY_REGISTERED mac already registered!
9002 GIZ_OPENAPI_PRODUCT_KEY_INVALID product_key invalid
9003 GIZ_OPENAPI_APPID_INVALID appid invalid
9004 GIZ_OPENAPI_TOKEN_INVALID token invalid
9005 GIZ_OPENAPI_USER_NOT_EXIST user not exist
9006 GIZ_OPENAPI_TOKEN_EXPIRED token expired
9007 GIZ_OPENAPI_M2M_ID_INVALID m2m_id invalid
9008 GIZ_OPENAPI_SERVER_ERROR server error
9009 GIZ_OPENAPI_CODE_EXPIRED code expired
9010 GIZ_OPENAPI_CODE_INVALID code invalid
9011 GIZ_OPENAPI_SANDBOX_SCALE_QUOTA_EXHAUSTED sandbox scale quota exhausted!
9012 GIZ_OPENAPI_PRODUCTION_SCALE_QUOTA_EXHAUSTED production scale quota exhausted!
9013 GIZ_OPENAPI_PRODUCT_HAS_NO_REQUEST_SCALE product has no request scale!
9014 GIZ_OPENAPI_DEVICE_NOT_FOUND device not found!
9015 GIZ_OPENAPI_FORM_INVALID form invalid!
9016 GIZ_OPENAPI_DID_PASSCODE_INVALID did or passcode invalid!
9017 GIZ_OPENAPI_DEVICE_NOT_BOUND device not bound!
9018 GIZ_OPENAPI_PHONE_UNAVALIABLE phone unavailable!
9019 GIZ_OPENAPI_USERNAME_UNAVALIABLE username unavailable!
9020 GIZ_OPENAPI_USERNAME_PASSWORD_ERROR username or password error!
9021 GIZ_OPENAPI_SEND_COMMAND_FAILED send command failed!
9022 GIZ_OPENAPI_EMAIL_UNAVALIABLE email unavailable!
9023 GIZ_OPENAPI_DEVICE_DISABLED device is disabled!
9024 GIZ_OPENAPI_FAILED_NOTIFY_M2M fail to notify m2m!
9025 GIZ_OPENAPI_ATTR_INVALID attr invalid!
9026 GIZ_OPENAPI_USER_INVALID user invalid!
9027 GIZ_OPENAPI_FIRMWARE_NOT_FOUND firmware not found!
9028 GIZ_OPENAPI_JD_PRODUCT_NOT_FOUND JD product info not found!
9029 GIZ_OPENAPI_DATAPOINT_DATA_NOT_FOUND datapoint data not found!
9030 GIZ_OPENAPI_SCHEDULER_NOT_FOUND scheduler not found!
9031 GIZ_OPENAPI_QQ_OAUTH_KEY_INVALID qq oauth key invalid!
9032 GIZ_OPENAPI_OTA_SERVICE_OK_BUT_IN_IDLE ota upgrade service OK, but in idle or disable!
9033 GIZ_OPENAPI_BT_FIRMWARE_UNVERIFIED bt firmware unverified,except verify device!
9034 GIZ_OPENAPI_BT_FIRMWARE_NOTHING_TO_UPGRADE bt firmware is OK, but nothing to upgrade!
9035 GIZ_OPENAPI_SAVE_KAIROSDB_ERROR Save kairosdb error!
9036 GIZ_OPENAPI_EVENT_NOT_DEFINED event not defined!
9037 GIZ_OPENAPI_SEND_SMS_FAILED send sms failed!
9038 GIZ_OPENAPI_APPLICATION_AUTH_INVALID X-Gizwits-Application-Auth invalid!
9039 GIZ_OPENAPI_NOT_ALLOWED_CALL_API Not allowed to call deprecated API!
9040 GIZ_OPENAPI_BAD_QRCODE_CONTENT bad qrcode content!
9041 GIZ_OPENAPI_REQUEST_THROTTLED request was throttled
9042 GIZ_OPENAPI_DEVICE_OFFLINE device offline!
9043 GIZ_OPENAPI_TIMESTAMP_INVALID X-Gizwits-Timestamp invalid!
9044 GIZ_OPENAPI_SIGNATURE_INVALID X-Gizwits-Signature invalid!
9045 GIZ_OPENAPI_DEPRECATED_API API deprecated!
9046 GIZ_OPENAPI_REGISTER_IS_BUSY Register already in progress!
9077 GIZ_OPENAPI email already exists but not activate!
9080 GIZ_OPENAPI_CANNOT_SHARE_TO_SELF can not share device to self!
9081 GIZ_OPENAPI_ONLY_OWNER_CAN_SHARE guest or normal user can not share device!
9082 GIZ_OPENAPI_NOT_FOUND_GUEST guest user not found!
9083 GIZ_OPENAPI_GUEST_ALREADY_BOUND guest user alread bound!
9084 GIZ_OPENAPI_NOT_FOUND_SHARING_INFO sharing record not found!
9085 GIZ_OPENAPI_NOT_FOUND_THE_MESSAGE message record not found!
9087 GIZ_OPENAPI_SHARING_IS_WAITING_FOR_ACCEPT sharing alread created,waiting for the guest to accept!
9088 GIZ_OPENAPI_SHARING_IS_EXPIRED sharing record expired!
9089 GIZ_OPENAPI_SHARING_IS_COMPLETED sharing record status is not unaccept!
9090 GIZ_OPENAPI_INVALID_SHARING_BECAUSE_UNBINDING owner binding disabled!
9092 GIZ_OPENAPI_ONLY_OWNER_CAN_BIND owner exist, guest can not bind!
9093 GIZ_OPENAPI_ONLY_OWNER_CAN_OPERATE permission denied, you are not owner!
9094 GIZ_OPENAPI_SHARING_ALREADY_CANCELLED sharing already canceled!
9095 GIZ_OPENAPI_OWNER_CANNOT_UNBIND_SELF can not unbind self!
9096 GIZ_OPENAPI_ONLY_GUEST_CAN_CHECK_QRCODE permission denied, you are not guest!
9098 GIZ_OPENAPI_MESSAGE_ALREADY_DELETED notify delele binding failed!
9099 GIZ_OPENAPI_BINDING_NOTIFY_FAILED notify delele binding failed!
9100 GIZ_OPENAPI_ONLY_SELF_CAN_MODIFY_ALIAS permission denied, you are not owner or guest!
9101 GIZ_OPENAPI_ONLY_RECEIVER_CAN_MARK_MESSAGE permission denied, you are not the receiver!
9999 GIZ_OPENAPI_RESERVED reserved