简介

您所在的位置:网站首页 错误40006 简介

简介

2024-07-10 09:40| 来源: 网络整理| 查看: 265

简介 ​推送消息 ​

向主题推送消息,支持POST协议:

1、POST接口

JSON格式

数据类型 "Content-Type": "application/json;

API: https://apis.bemfa.com/va/postJsonMsg

参数是否必须说明uid是用户私钥,巴法云控制台获取topic是主题名,可在控制台创建type是主题类型,当type=1时是MQTT协议,3是TCP协议msg是消息体,要推送的消息,自定义即可,比如on,或off等等wemsg否发送到微信的消息,自定义即可。如果携带此字段,会将消息发送到微信

请求体示例:

{ "uid": "7801e4ba1bf7406593d47250797860fd", "topic": "led002", "type": 3, "msg": "on" }

正确返回:

{ "code": 0, "message": "OK", "data": 0 }

code 字段说明:

code状态码说明0成功10002请求参数有误40000未知错误40004私钥或主题错误

推送示例可参考:

2、POST接口

数据类型 "Content-Type": "application/x-www-form-urlencoded"

API: https://apis.bemfa.com/va/postmsg

参数是否必须说明uid是用户私钥,巴法云控制台获取topic是主题名,可在控制台创建type是主题类型,当type=1时是MQTT协议,3是TCP协议msg是消息体,要推送的消息,自定义即可,比如on,或off等等wemsg否发送到微信的消息,自定义即可。如果携带此字段,会将消息发送到微信

正确返回:

{ "code": 0, "message": "OK", "data": 0 }

code 字段说明:

code状态码说明0成功10002请求参数有误40000未知错误40004私钥或主题错误

推送示例可参考:

获取消息 ​

获取主题消息,支持GET协议:

1、HTTP GET接口

API: https://apis.bemfa.com/va/getmsg

参数是否必须说明uid是用户私钥,巴法云控制台获取topic是主题名,可在控制台创建type是主题类型,当type=1时是MQTT协议,3是TCP协议num否获取的历史数据条数,不填默认默认是1,最大5000

正确返回:

{ "code": 0, "message": "OK", "data": [ { "msg": "on", "time": "2022-08-03 17:26:34", "unix": 1659518794 } ] }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40004私钥或主题错误

data内字段说明:

字段说明msg获取的主题消息time消息发送的时间,时区UTC/GMT+08:00unix消息发送的时间戳获取所有主题 ​

1、GET接口

API: https://apis.bemfa.com/va/alltopic

参数是否必须说明uid是用户私钥,巴法云控制台获取type是主题类型,当type=1时是MQTT协议,3是TCP协议

正确返回:

{ "code": 0, "message": "OK", "data": [ { "topic": "cat002", "msg": "off", "name": "home light", "online": true, "tid": "light", "sid": "", "time": "2022-08-03 16:39:27", "unix": 1659515967 }, { "topic": "me001", "msg": "on", "name": "电视", "online": false, "tid": "outlet", "sid": "", "time": "2022-08-03 11:49:11", "unix": 1659498551 } ] }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40003私钥错误

data内字段说明:

字段说明topic主题值msg消息体name主题名字online是否在线tid设备类型sid如果是分享设备,此字段是分享者密钥time消息发送的时间,时区UTC/GMT+08:00unix消息发送的时间戳

tid字段说明:

字段说明outlet插座light灯fan风扇sensor传感器aircondition空调switch开关curtain窗帘获取设备在线 ​

GET接口

API: https://apis.bemfa.com/va/online

参数是否必须说明uid是用户私钥,巴法云控制台获取topic是主题名,可在控制台创建type是主题类型,当type=1时是MQTT协议,3是TCP协议

正确返回:

{ "code": 0, "message": "OK", "data": false }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40004私钥或主题错误

data 字段说明:

状态码说明true设备在线false设备离线创建主题 ​

用户创建主题

POST接口

数据类型 "Content-Type": "application/x-www-form-urlencoded"

https://pro.bemfa.com/v1/addtopic

参数是否必须说明uid是用户私钥topic是主题值,仅限字母、数字type是类型类型name否主题昵称,中英文不限

type字段值说明

值说明1MQTT协议设备3TCP协议设备5MQTT协议设备V2版本,内测中7TCP协议设备V2版本,内测中

topic字段值说明:

根据topic字段后三位判断主题类型

当主题名字后三位是001时为插座设备。

当主题名字后三位是002时为灯泡设备。

当主题名字后三位是003时为风扇设备。

当主题名字后三位是004时为传感器设备。

当主题名字后三位是005时为空调设备。

当主题名字后三位是006时为开关设备。

当主题名字后三位是009时为窗帘设备。

请求正常响应:

{ "code": 0, "message": "OK", "data": 0 }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40006设备已存在40009主题错误,仅限字母、数字,最大长度64删除主题 ​

用户删除主题

POST接口

数据类型 "Content-Type": "application/x-www-form-urlencoded"

https://pro.bemfa.com/v1/deltopic

参数是否必须说明uid是用户私钥topic是主题名称,仅限字母、数字类型type是设备类型

type字段值说明

值说明1MQTT协议设备3TCP协议设备5MQTT协议设备V2版本,内测中7TCP协议设备V2版本,内测中

请求正常响应:

{ "code": 0, "message": "OK", "data": 0 }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40004uid或topic错误修改主题昵称 ​

修改设备昵称

POST接口

数据类型 "Content-Type": "application/x-www-form-urlencoded"

https://apis.bemfa.com/va/setName

参数是否必须说明uid是用户私钥topic是主题名称,仅限字母、数字类型type是类型类型name是主题昵称

type字段值说明

值说明1MQTT协议设备3TCP协议设备5MQTT协议设备V2版本,内测中7TCP协议设备V2版本,内测中

请求正常响应:

{ "code": 0, "message": "OK", "data": 0 }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误获取主题昵称 ​

获取主题昵称

GET接口

https://apis.bemfa.com/va/getName

参数是否必须说明uid是用户私钥topic是主题名称type是类型类型

type字段值说明

值说明1MQTT协议设备3TCP协议设备5MQTT协议设备V2版本,内测中7TCP协议设备V2版本,内测中

请求正常响应:

{ "code": 0, "message": "OK", "data": "传感器" }

data 字段是获取的主题昵称。

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40004密钥或主题错误获取时间 ​

单片机使用建议使用http,端口80。https默认端口443。

GET接口

API: https://api.bemfa.com/api/time/now/

参数是否必须说明type否type不填默认为1,type=1是只获取时间,等于2获取日期和时间

示例:https://api.bemfa.com/api/time/now/?type=1

esp8266示例下载: 点击下载

esp32示例下载: 点击下载

设备分享 ​

设备分享相关共有三个接口:设备分享,获取设备已分享列表,删除设备分享。

1、设备分享接口

POST接口

数据类型 "Content-Type": "application/x-www-form-urlencoded"

API: https://apis.bemfa.com/va/sharedevice

参数是否必须说明uid是用户私钥,巴法云控制台获取topic是主题名,可在控制台创建type是主题类型,当type=1时是MQTT协议,3是TCP协议name是设备昵称email是接收人的邮箱

正确返回:

{ "code": 0, "message": "OK", "data": null }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40004私钥或主题错误40005接入人邮箱错误或不存在40005设备已存在

2、获取设备已分享列表

GET接口

API: https://apis.bemfa.com/va/getShareList

参数是否必须说明uid是用户私钥,巴法云控制台获取topic是主题名,可在控制台创建type是主题类型,当type=1时是MQTT协议,3是TCP协议

正确返回:

{ "code": 0, "message": "OK", "data": [ { "email": "[email protected]", "time": "2022-08-04 10:45:57", "unix": 1659581157 }, { "email": "[email protected]", "time": "2022-08-04 10:45:59", "unix": 1659581159 }, ] }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40004私钥或主题错误

data内字段说明:

字段说明email接收者邮箱time消息发送的时间,时区UTC/GMT+08:00unix消息发送的时间戳

3、删除分享

POST接口

数据类型 "Content-Type": "application/x-www-form-urlencoded"

API: https://apis.bemfa.com/va/delshare

参数是否必须说明uid是用户私钥,巴法云控制台获取topic是主题名,可在控制台创建type是主题类型,当type=1时是MQTT协议,3是TCP协议email是接收人的邮箱

正确返回:

{ "code": 0, "message": "OK", "data": null }

code 字段说明:

状态码说明0成功10002请求参数有误40000未知错误40004私钥或主题错误40005接入人邮箱错误或不存在


【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3