Version: V4.0

Notice Callback API

Account Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Account-Id	String	Header	Yes	Account ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, update
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
account_id	String	Body	Yes	Account ID
account_name	String	Body	No	Account name
first_name	String	Body	No	First name
last_name	String	Body	No	Last name
email	String	Body	No	Email

Return Parameter

Null

Request Example

POST Notice URL

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"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Family Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Residence-Id	String	Header	Yes	Residence ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, update or delete
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
family_name	String	Body	No	Family name
online	Boolean	Body	No	Whether the family is online or not? true: online false: offline
installed	Boolean	Body	No	Whether the family is installed or not? true: installed false: yet to be installed
accounts	Object<account>	Body	No	Account information

account description

Parameter Name	Type	Location	Required	Description
account_id	String	Body	No	Account ID
account_name	String	Body	No	Account name
first_name	String	Body	No	First name
last_name	String	Body	No	Last name
email	String	Body	No	Email
auth	String	Body	No	Account authorization admin: owner, the top administrator user: family administrator guest: family ordinary user

Return Parameter

Null

Request Example

POST Notice URL

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"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Device Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Residence-Id	String	Header	Yes	Residence ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, sync
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object	Body	Yes	Notice parameter

Return Parameter

Null

Request Example

POST Notice URL

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

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

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Space Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Residence-Id	String	Header	Yes	Residence ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, create or update or delete
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	[]Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
space_id	String	Body	Yes	Space ID
space_name	String	Body	No	Space name
parent_space_id	String	Body	No	Parent space ID

Return Parameter

Null

Request Example

POST Notice URL

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"
    }
  ]
}

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Scene Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Residence-Id	String	Header	Yes	Residence ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, sync or perform
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
scene_id	String	Body	No	Scene ID

Return Parameter

Null

Request Example

POST Notice URL

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

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

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Communication Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Residence-Id	String	Header	Yes	Residence ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, create
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
communicate_id	String	Body	Yes	Communicate ID
timestamp	Integer	Body	Yes	Timestamp
from	String	Body	Yes	Sender ID, account ID or device ID
to	String	Body	Yes	Receiver ID, residence ID or account ID
format	String	Body	Yes	Format, text or voice or call_failed or lock_call or call_cancelled
call_from	String	Body	No	Call from
content	String	Body	No	Content, text context or voice filename
duration	Integer	Body	No	Voice duration time (s)
call_id	String	Body	No	Call ID

Return Parameter

Null

Request Example

POST Notice URL

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"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Maintenance Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Project-Id	String	Header	Yes	Project ID
Residence-Id	String	Header	Yes	Residence ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, create or update or delete
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
maintenance_id	String	Body	Yes	Maintenance ID
state	String	Body	No	State, wait for confirmation or in progress or completed
feedback	String	Body	No	Feedback

Return Parameter

Null

Request Example

POST Notice URL

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"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Booking Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Project-Id	String	Header	Yes	Project ID
Residence-Id	String	Header	Yes	Residence ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, create or update or delete
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
booking_id	String	Body	Yes	Booking ID
state	String	Body	No	State, rejected or success
pin_code	String	Body	No	PIN code
qr_code_url	String	Body	No	QR code URL

Return Parameter

Null

Request Example

POST Notice URL

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"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Message Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Project-Id	String	Header	Yes	Project ID
Residence-Id	String	Header	Yes	Residence ID
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, create
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
message_id	String	Body	Yes	Message ID
message_title	String	Body	Yes	Message title
message_content	String	Body	Yes	Message content

Return Parameter

Null

Request Example

POST Notice URL

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"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

General Device Listen Notice

Request URL

POST Notice URL

See Notice Service API to configure notice URL

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
notice	String	Body	Yes	Notice name
action	String	Body	Yes	Action, create or update or delete or trigger
id	String	Body	Yes	Notice ID
timestamp	Integer	Body	Yes	Notice time
param	Object<param>	Body	Yes	Notice parameter

param description

Parameter Name	Type	Location	Required	Description
device_id	String	Body	Yes	Device ID
online	Boolean	Body	No	Whether the device is online or not? true: online false: offline
data	Object	Body	No	Data

Return Parameter

Null

Request Example

POST Notice URL

Content-Type: application/json

Accept: application/json

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

Success Return Example

Status Code: 200

Content-Type: application/json

Failure Return Example

Null

Account Listen Notice​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Family Listen Notice​

Request URL​

Request Parameter​

param description​

account description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Device Listen Notice​

Request URL​

Request Parameter​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Space Listen Notice​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Scene Listen Notice​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Communication Listen Notice​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Maintenance Listen Notice​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Booking Listen Notice​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Message Listen Notice​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

General Device Listen Notice​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Account Listen Notice

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Family Listen Notice

Request URL

Request Parameter

param description

account description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Device Listen Notice

Request URL

Request Parameter

Return Parameter

Request Example

Success Return Example

Failure Return Example

Space Listen Notice

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Scene Listen Notice

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Communication Listen Notice

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Maintenance Listen Notice

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Booking Listen Notice

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Message Listen Notice

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

General Device Listen Notice

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example