Appearance
设备接口
本文档介绍巴法云设备管理相关的API接口,包含主题创建、消息推送、设备查询等功能。
硬件设备说明
硬件设备可以使用HTTP协议访问API接口(将https改为http即可)。
创建单个主题
创建一个新的设备主题。
接口信息
- 请求方法:
POST
- 请求地址:
https://pro.bemfa.com/v1/createTopic
- Content-Type:
application/json
请求参数
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
uid | string | 是 | 用户私钥 |
topic | string | 是 | 主题值,仅限字母、数字 |
type | number | 是 | 设备协议类型 |
name | string | 否 | 主题昵称,中英文不限 |
协议类型说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本(内测中) |
7 | TCP协议设备V2版本(内测中) |
设备类型识别
设备类型通过主题名称后三位数字识别:
后缀 | 设备类型 | 示例 |
---|---|---|
001 | 插座设备 | socket001 , power001 |
002 | 灯泡设备 | light002 , led002 |
003 | 风扇设备 | fan003 , air003 |
004 | 传感器设备 | sensor004 , temp004 |
005 | 空调设备 | ac005 , aircon005 |
006 | 开关设备 | switch006 , btn006 |
009 | 窗帘设备 | curtain009 , blind009 |
请求示例
json
{
"uid": "00ad90fe27444dff9d5ee32b94c5ae08",
"type": 3,
"topic": "led002"
}
响应示例
json
{
"code": 0,
"message": "OK",
"data": 0
}
状态码说明
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
40006 | 设备已存在 |
40009 | 主题错误,仅限字母、数字,最大长度64 |
创建多个主题
批量创建多个设备主题,最多一次可创建20个。
接口信息
- 请求方法:
POST
- 请求地址:
https://pro.bemfa.com/vs/web/v1/addTopics
- Content-Type:
application/json
请求参数
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
openID | string | 是 | 用户私钥 |
topics | string[] | 是 | 主题数组,最多20个 |
type | number | 是 | 设备协议类型 |
room | string | 否 | 设备房间 |
group | string | 否 | 设备分组 |
adminID | number | 否 | 企业ID |
协议类型说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本(内测中) |
7 | TCP协议设备V2版本(内测中) |
设备类型识别
设备类型通过主题名称后三位数字识别:
- 001: 插座设备
- 002: 灯泡设备
- 003: 风扇设备
- 004: 传感器设备
- 005: 空调设备
- 006: 开关设备
- 009: 窗帘设备
请求示例
json
{
"openID": "00ad90fe27444dff9d5ee32b94c5ae08",
"type": 3,
"topics": [
"xxsn001",
"xxsn1002",
"xxsn2002",
"xxsn042",
"led002"
],
"group": "分组一",
"adminID": 0
}
响应示例
json
{
"code": 0,
"msg": "success",
"data": {
"code": 0,
"message": ""
}
}
状态码说明
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
40006 | 设备已存在 |
删除主题
删除指定的设备主题。
接口信息
- 请求方法:
POST
- 请求地址:
https://pro.bemfa.com/v1/deleteTopic
- Content-Type:
application/json; charset=utf-8
请求参数
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
uid | string | 是 | 用户私钥 |
topic | string | 是 | 主题名称(仅限字母、数字) |
type | number | 是 | 设备协议类型 |
协议类型说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本(内测中) |
7 | TCP协议设备V2版本(内测中) |
请求示例
json
{
"uid": "4d9ec352e0376f2110a0c601a2857225",
"topic": "tttt006",
"type": 3
}
响应示例
json
{
"code": 0,
"message": "OK",
"data": 0
}
状态码说明
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
40004 | uid或topic错误 |
推送消息
向指定主题发送消息,支持向微信推送通知。
接口信息
- 请求方法:
POST
- 请求地址:
https://apis.bemfa.com/va/postJsonMsg
- Content-Type:
application/json; charset=utf-8
请求参数
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
uid | string | 是 | 用户私钥(从控制台获取) |
topic | string | 是 | 主题名称 |
type | number | 是 | 主题类型(1=MQTT协议,3=TCP协议) |
msg | string | 是 | 消息内容(如:on、off等) |
share | boolean | 否 | 是否为分享设备 |
wemsg | string | 否 | 微信推送消息(可选) |
请求示例
json
{
"uid": "7801e4ba1bf7406593d47250797860fd",
"topic": "led002",
"type": 3,
"msg": "on"
}
响应示例
json
{
"code": 0,
"message": "OK",
"data": 0
}
状态码说明
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
40004 | 私钥或主题错误 |
使用示例
可参考下图进行推送测试:
接口信息
请求方法:
GET
请求地址:
https://apis.bemfa.com/va/sendMessage
参数 | 是否必须 | 说明 |
---|---|---|
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
请求地址:
https://apis.bemfa.com/va/getmsg
参数 | 是否必须 | 说明 |
---|---|---|
uid | 是 | 用户私钥,巴法云控制台获取 |
topic | 是 | 主题名,可在控制台创建 |
type | 是 | 主题类型,当type=1时是MQTT协议,3是TCP协议 |
num | 否 | 获取的历史数据条数,不填默认默认是1,最大5000 |
示例:https://apis.bemfa.com/va/getmsg?uid=d4c470e057e04a3e8b2fefd0b74b6b16&topic=23123001&type=3
正确返回:
{
"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:00 |
unix | 消息发送的时间戳 |
获取设备所有分组
接口信息
请求方法:
GET
请求地址:
http://apis.bemfa.com/vb/api/v1/allGroup
参数 | 是否必须 | 说明 |
---|---|---|
openID | 是 | 用户私钥,巴法云控制台获取 |
type | 是 | 主题名,可在控制台创建 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
示例:http://apis.bemfa.com/vb/api/v1/allGroup?openID=00ad90fe27444dff9d5ee32b94c5ae08&type=3
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"data": [
{
"name": "未分组",
"num": 2
},
{
"name": "设备一",
"num": 5
},
{
"name": "设备二",
"num": 4
}
]
}
}
data字段说明:
字段 | 说明 |
---|---|
name | 分组名称 |
num | 分组内设备数量 |
通过分组获取设备
接口信息
请求方法:
GET
请求地址:
http://apis.bemfa.com/vb/api/v2/groupTopic
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
type | 是 | int整型 | 主题类型 |
group | 否 | 字符串类型 | 分组 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
示例:http://apis.bemfa.com/vb/api/v2/groupTopic?openID=00ad90fe27444dff9d5ee32b94c5ae08&type=1&group=未分组
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"data": [
{
"topic": "1245001",
"type": 1,
"share": false,
"time": "2024-06-27 10:50:32",
"unix": 1719456632,
"online": false,
"name": "插座",
"room": "",
"msg": "",
"pubOnline": false,
"deviceType": "outlet",
"group": "",
"createTime": "2024-06-27 10:50:32"
},
{
"topic": "2322006",
"type": 1,
"share": false,
"time": "2024-03-31 23:49:22",
"unix": 1711900162,
"online": false,
"name": "开关",
"room": "",
"msg": "off",
"pubOnline": false,
"deviceType": "switch",
"group": "",
"createTime": "2024-03-31 23:40:35"
}
]
}
}
data内字段说明:
字段 | 说明 |
---|---|
topic | 主题值 |
type | 协议类型 |
share | 是否是分享设备 |
time | 消息发送的时间,时区UTC/GMT+08:00 |
unix | 消息发送的时间戳 |
online | 是否在线 |
name | 主题名字 |
room | 房间名字 |
msg | 消息体 |
pubOnline | 推送者是否在线 |
deviceType | 设备类型 |
group | 分组 |
createTime | 主题创建时间 |
deviceType字段说明:
字段 | 说明 |
---|---|
outlet | 插座 |
light | 灯 |
fan | 风扇 |
sensor | 传感器 |
aircondition | 空调 |
switch | 开关 |
curtain | 窗帘 |
thermostat | 温控器 |
waterheater | 热水器 |
television | 电视 |
airpurifier | 空气净化器 |
获取设备所有房间
接口信息
请求方法:
GET
请求地址:
http://apis.bemfa.com/vb/api/v1/allRoom
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
type | 是 | int整型 | 主题类型 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
示例:http://apis.bemfa.com/vb/api/v1/allRoom?openID=00ad90fe27444dff9d5ee32b94c5ae08&type=3
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"data": [
{
"name": "未分组",
"num": 11
}
]
}
}
data字段说明:
字段 | 说明 |
---|---|
name | 名称 |
num | 设备数量 |
通过房间获取设备
接口信息
请求方法:
GET
请求地址:
http://apis.bemfa.com/vb/api/v2/roomTopic
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
type | 是 | int整型 | 主题类型 |
room | 否 | 字符串类型 | 房间 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
示例:http://apis.bemfa.com/vb/api/v2/roomTopic?openID=00ad90fe27444dff9d5ee32b94c5ae08&type=3&room=未分组
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"data": [
{
"topic": "0D4061002",
"type": 3,
"share": false,
"time": "2024-06-27 09:53:59",
"unix": 1719453239,
"online": false,
"name": "灯",
"room": "",
"msg": "on",
"pubOnline": false,
"deviceType": "light",
"group": "",
"createTime": "2024-06-21 16:06:38"
},
{
"topic": "xxsn2002",
"type": 3,
"share": false,
"time": "2024-09-11 11:28:13",
"unix": 1726025293,
"online": false,
"name": "灯",
"room": "",
"msg": "",
"pubOnline": false,
"deviceType": "light",
"group": "分组一",
"createTime": "2024-09-11 11:28:13"
}
]
}
}
data内字段说明:
字段 | 说明 |
---|---|
topic | 主题值 |
type | 协议类型 |
share | 是否是分享设备 |
time | 消息发送的时间,时区UTC/GMT+08:00 |
unix | 消息发送的时间戳 |
online | 是否在线 |
name | 主题名字 |
room | 房间名字 |
msg | 消息体 |
pubOnline | 推送者是否在线 |
deviceType | 设备类型 |
group | 分组 |
createTime | 主题创建时间 |
deviceType字段说明:
字段 | 说明 |
---|---|
outlet | 插座 |
light | 灯 |
fan | 风扇 |
sensor | 传感器 |
aircondition | 空调 |
switch | 开关 |
curtain | 窗帘 |
thermostat | 温控器 |
waterheater | 热水器 |
television | 电视 |
airpurifier | 空气净化器 |
获取所有主题信息
接口信息
请求方法:
GET
请求地址:
http://apis.bemfa.com/vb/api/v2/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 | 主题值 |
type | 协议类型 |
share | 是否是分享设备 |
time | 消息发送的时间,时区UTC/GMT+08:00 |
unix | 消息发送的时间戳 |
online | 是否在线 |
name | 主题名字 |
room | 房间名字 |
msg | 消息体 |
pubOnline | 推送者是否在线 |
deviceType | 设备类型 |
group | 分组 |
createTime | 主题创建时间 |
deviceType字段说明:
字段 | 说明 |
---|---|
outlet | 插座 |
light | 灯 |
fan | 风扇 |
sensor | 传感器 |
aircondition | 空调 |
switch | 开关 |
curtain | 窗帘 |
thermostat | 温控器 |
waterheater | 热水器 |
television | 电视 |
airpurifier | 空气净化器 |
示例:http://apis.bemfa.com/vb/api/v2/allTopic?openID=4d9ec352e0376f2110a0c601a2857225&type=3
获取单个主题信息
接口信息
请求方法:
GET
请求地址:
http://apis.bemfa.com/vb/api/v2/topicInfo
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
type | 是 | int整型 | 主题类型 |
topic | 是 | 字符串类型 | 主题 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"name": "客厅灯",
"msg": "on",
"online": true,
"onlineNum": 1,
"pubOnline": false,
"deviceType": "light",
"share": false,
"group": "",
"room": "客厅",
"time": "2025-07-30 16:40:13",
"unix": 1753864813,
"createTime": "2024-12-27 17:52:49"
}
}
data内字段说明:
参数 | 类型 | 说明 |
---|---|---|
name | 字符串 | 主题名称 |
msg | 字符串或json | 消息 |
online | bool | 订阅是否在线 |
onlineNum | 整形 | 订阅在线个数 |
pubOnline | bool | 发布者是否在线,半小时内是否有消息推送 |
deviceType | 设备类型 | |
share | 是否是分享设备 | |
group | 字符串 | 分组名,空是没有分组 |
room | 字符串 | 房间名,空是没有房间 |
time | 字符串 | 主题消息发送的时间,时区UTC/GMT+08:00 |
unix | 整形 | 消息发送的时间戳 |
createTime | 字符串 | 主题创建的时间,时区UTC/GMT+08:00 |
deviceType字段说明:
字段 | 说明 |
---|---|
outlet | 插座 |
light | 灯 |
fan | 风扇 |
sensor | 传感器 |
aircondition | 空调 |
switch | 开关 |
curtain | 窗帘 |
thermostat | 温控器 |
waterheater | 热水器 |
television | 电视 |
airpurifier | 空气净化器 |
获取设备在线
接口信息
请求方法:
GET
请求地址:
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
请求地址:
http://apis.bemfa.com/vb/api/v1/changeTopicRoom
请求参数:
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
topicIDs | 是 | 字符串数组 | 主题值,最少修改一个,最多一次可修改50个 |
room | 否 | 字符串类型 | 房间 ,空值表示清空房间 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
请求示例:
{
"openID":"00ad90fe27444dff9d5ee32b94c5ae08",
"topicIDs":["0D4061002"],
"type":3,
"rome":"客厅"
}
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"code": 0
}
}
data字段说明:
字段 | 说明 |
---|---|
code | 0成功 |
修改设备分组
接口信息
请求方法:
POST
请求地址:
http://apis.bemfa.com/vb/api/v1/changeTopicGroup
请求参数:
参数 | 是否必须 | 类型 | 说明 |
---|---|---|---|
openID | 是 | 字符串类型 | 用户私钥 |
topicIDs | 是 | 字符串数组 | 主题值,最少修改一个,最多一次可修改50个 |
group | 否 | 字符串类型 | 分组名 ,空值表示清空分组 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
请求示例:
{
"openID":"00ad90fe27444dff9d5ee32b94c5ae08",
"topicIDs":["sn01"],
"type":3,
"group":"分组2"
}
正确返回:
{
"code": 0,
"msg": "success",
"data": {
"code": 0
}
}
data字段说明:
字段 | 说明 |
---|---|
code | 0成功 |
修改主题昵称
修改设备昵称
接口信息
- 请求方法:
POST
- 请求地址:
https://apis.bemfa.com/va/modifyName
- Content-Type:
application/json; charset=utf-8
请求参数
参数 | 是否必须 | 说明 |
---|---|---|
uid | 是 | 用户私钥 |
topic | 是 | 主题名称,仅限字母、数字类型 |
type | 是 | 类型类型 |
name | 是 | 主题昵称 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
请求示例:
{
"uid":"00ad90fe27444dff9d5ee32b94c5ae08",
"topic":"sn001",
"type":3,
"name":"卧室灯"
}
请求正常响应:
{
"code": 0,
"message": "OK",
"data": 0
}
code 字段说明:
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
获取主题昵称
获取主题昵称
接口信息
- 请求方法:
GET
- 请求地址:
https://apis.bemfa.com/va/getName
请求参数
参数 | 是否必须 | 说明 |
---|---|---|
uid | 是 | 用户私钥 |
topic | 是 | 主题名称 |
type | 是 | 类型类型 |
type字段值说明
值 | 说明 |
---|---|
1 | MQTT协议设备 |
3 | TCP协议设备 |
5 | MQTT协议设备V2版本,内测中 |
7 | TCP协议设备V2版本,内测中 |
请求正常响应:
{
"code": 0,
"message": "OK",
"data": "传感器"
}
data 字段是获取的主题昵称。
code 字段说明:
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
40004 | 密钥或主题错误 |
获取时间
单片机使用建议使用http,端口80。https默认端口443。
接口信息
请求方法:
GET
请求地址:
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/json; charset=utf-8
请求地址:
https://apis.bemfa.com/va/shareDevice
参数 | 是否必须 | 说明 |
---|---|---|
uid | 是 | 用户私钥,巴法云控制台获取 |
topic | 是 | 主题名,可在控制台创建 |
type | 是 | 主题类型,当type=1时是MQTT协议,3是TCP协议 |
name | 是 | 设备昵称 |
是 | 接收人的邮箱 |
请求示例:
{
"uid":"00ad90fe27444dff9d5ee32b94c5ae08",
"topic":"sn001",
"type":3,
"name":"卧室灯",
"email":"133xxxxxxx@qq.com"
}
正确返回:
{
"code": 0,
"message": "OK",
"data": null
}
code 字段说明:
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
40004 | 私钥或主题错误 |
40005 | 接入人邮箱错误或不存在 |
40005 | 设备已存在 |
2、获取设备已分享列表
接口信息
请求方法:
GET
请求地址:
https://apis.bemfa.com/va/getShareList
参数 | 是否必须 | 说明 |
---|---|---|
uid | 是 | 用户私钥,巴法云控制台获取 |
topic | 是 | 主题名,可在控制台创建 |
type | 是 | 主题类型,当type=1时是MQTT协议,3是TCP协议 |
正确返回:
{
"code": 0,
"message": "OK",
"data": [
{
"email": "1217xxxxxx1@qq.com",
"time": "2022-08-04 10:45:57",
"unix": 1659581157
},
{
"email": "1217xxxxxx2@qq.com",
"time": "2022-08-04 10:45:59",
"unix": 1659581159
},
]
}
code 字段说明:
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
40004 | 私钥或主题错误 |
data内字段说明:
字段 | 说明 |
---|---|
接收者邮箱 | |
time | 消息发送的时间,时区UTC/GMT+08:00 |
unix | 消息发送的时间戳 |
3、删除分享
接口信息
请求方法:
POST
Content-Type:
application/json; charset=utf-8
请求地址:
https://apis.bemfa.com/va/deleteShare
参数 | 是否必须 | 说明 |
---|---|---|
uid | 是 | 用户私钥,巴法云控制台获取 |
topic | 是 | 主题名,可在控制台创建 |
type | 是 | 主题类型,当type=1时是MQTT协议,3是TCP协议 |
是 | 接收人的邮箱 |
请求示例:
{
"uid":"00ad90fe27444dff9d5ee32b94c5ae08",
"topic":"sn001",
"type":3,
"email":"133xxxxxxx@qq.com"
}
正确返回:
{
"code": 0,
"message": "OK",
"data": null
}
code 字段说明:
状态码 | 说明 |
---|---|
0 | 成功 |
10002 | 请求参数有误 |
40000 | 未知错误 |
40004 | 私钥或主题错误 |
40005 | 接入人邮箱错误或不存在 |