版本：V4.0

通知回调API

账号监听通知

接口地址

POST 通知回调地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Account-Id	String	Header	是	账号ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 update：更新
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
account_id	String	Body	是	账号ID
account_name	String	Body	否	账号名称
first_name	String	Body	否	名
last_name	String	Body	否	姓
email	String	Body	否	邮箱

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Account-Id: ar58fa9ac8b6a2401bba0828fab548850

{
  "notice": "account_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
    "account_name": "good",
    "first_name": "tom",
    "last_name": "fly",
    "email": "demo@akubela.com"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

家庭监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 update：更新 delete：删除
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
family_name	String	Body	否	家庭名称
online	Boolean	Body	否	判断家庭在离线状态 true：在线 false：离线
installed	Boolean	Body	否	判断家庭安装状态 true：安装完成 false：未安装完成
accounts	Object<account>	Body	否	账号信息

account说明

参数名	类型	位置	必填	说明
account_id	String	Body	否	账号ID
account_name	String	Body	否	账号名称
first_name	String	Body	否	名
last_name	String	Body	否	姓
email	String	Body	否	邮箱
auth	String	Body	否	账号权限 admin：拥有者，最高管理员 user：家庭管理员用户 guest：家庭普通用户

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "family_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "family_name": "my home",
    "online": true,
    "installed": true,
    "accounts": [
      {
        "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
        "account_name": "good",
        "first_name": "tom",
        "last_name": "fly",
        "email": "demo@akubela.com",
        "auth": "admin"
      }
    ]
  }
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

设备监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 sync：同步
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object	Body	是	通知参数

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "device_listen_notice",
  "action": "sync",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {}
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

空间监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 create：创建 update：更新 delete：删除
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	[]Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
space_id	String	Body	是	空间ID
space_name	String	Body	否	空间名称
parent_space_id	String	Body	否	父空间ID

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "space_listen_notice",
  "action": "create",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": [
    {
      "parent_space_id": "f8b5a73f8dd84abaa94dcs248be49b0db",
      "space_id": "r8b5a73f8dd84abaa94dcs248be49b0db",
      "space_name": "my room"
    }
  ]
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

场景监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 sync：同步 perform：执行
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
scene_id	String	Body	否	场景ID

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "scene_listen_notice",
  "action": "perform",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0dv"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

沟通监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 create：创建
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
communicate_id	String	Body	是	沟通ID
timestamp	Integer	Body	是	时间戳
from	String	Body	是	发送方ID 账号ID：发送方为用户设备ID：发送方为设备
to	String	Body	是	接收方ID 住宅ID：对家庭下的用户与设备群发账号ID：接收方为用户
format	String	Body	是	消息格式 text：文本 voice：语音 call_failed：呼叫失败 lock_call：锁呼叫 call_cancelled：呼叫取消
call_from	String	Body	否	呼叫方
content	String	Body	否	消息内容 text：文本内容 voice：语音文件名
duration	Integer	Body	否	语音时长，单位：秒
call_id	String	Body	否	呼叫ID

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "communication_listen_notice",
  "action": "create",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "communicate_id": "c6e3861d5d4ca4dcd8e76d84f1ecd49b4",
    "timestamp": 193239428275,
    "from": "a1d54e460365949109ec306dc6e37679b",
    "to": "r42bdd7f6cb5ad478f3471539c2547b4e",
    "format": "text",
    "content": "hello"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

报修监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Project-Id	String	Header	是	项目ID
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 create：创建 update：更新 delete：删除
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
maintenance_id	String	Body	是	报修ID
state	String	Body	否	状态 wait for confirmation：待确认 in progress：进行中 completed：已完成
feedback	String	Body	否	反馈

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Project-Id: prn45e846ca23ab42c9ae469d988ae129

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "maintenance_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "maintenance_id": "m8b5a73f8dd84abaa94dcs248be49b0d1",
    "state": "completed"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

预约监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Project-Id	String	Header	是	项目ID
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 create：创建 update：更新 delete：删除
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
booking_id	String	Body	是	预约ID
state	String	Body	否	状态 rejected：已拒绝 success：成功
pin_code	String	Body	否	PIN码
qr_code_url	String	Body	否	二维码地址

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Project-Id: prn45e846ca23ab42c9ae469d988ae129

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "booking_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "booking_id": "b8b5a73f8dd84abaa94dcs248be49b0d1",
    "state": "success",
    "pin_code": "123456",
    "qr_code_url": "https://test.akubela.com/h.png"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

消息监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Project-Id	String	Header	是	项目ID
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 create：创建
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
message_id	String	Body	是	消息ID
message_title	String	Body	是	消息标题
message_content	String	Body	是	消息内容

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

Project-Id: prn45e846ca23ab42c9ae469d988ae129

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "message_listen_notice",
  "action": "create",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "message_id": "mbafa332e258aae1badbb27d31128f446",
    "message_title": "test",
    "message_content": "test"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

通用设备监听通知

接口地址

POST 通知回调地址

见通知服务API 配置通知地址

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
notice	String	Body	是	通知名称
action	String	Body	是	操作类型 create：创建 update：更新 delete：删除 trigger：触发
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知时间
param	Object<param>	Body	是	通知参数

param说明

参数名	类型	位置	必填	说明
device_id	String	Body	是	设备ID
online	Boolean	Body	否	判断设备在离线状态 true：在线 false：离线
data	Object	Body	否	数据

返回参数

无

请求示例

POST 通知回调地址

Content-Type: application/json

Accept: application/json

{
  "notice": "general_device_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "device_id": "d8b5a73f8dd84abaa94dcs248be49b0d4",
    "online": true
  }
}

成功返回示例

状态码：200

Content-Type: application/json

失败返回示例

无

账号监听通知​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

家庭监听通知​

接口地址​

请求参数​

param说明​

account说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

设备监听通知​

接口地址​

请求参数​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

空间监听通知​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

场景监听通知​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

沟通监听通知​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

报修监听通知​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

预约监听通知​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

消息监听通知​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

通用设备监听通知​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

账号监听通知

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

家庭监听通知

接口地址

请求参数

param说明

account说明

返回参数

请求示例

成功返回示例

失败返回示例

设备监听通知

接口地址

请求参数

返回参数

请求示例

成功返回示例

失败返回示例

空间监听通知

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

场景监听通知

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

沟通监听通知

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

报修监听通知

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

预约监听通知

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

消息监听通知

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

通用设备监听通知

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例