Webportal v2

embedded apps

API Reference - profile.smartdevice

Required Privacy: Always available
Plateforme Compatibility:
Operations:

This API allows to retrieve the list of smartdevices paired with the current profile.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
data[n]
 .id

Unique identifier of the phone (for phone object number ā€˜nā€™ of the data array). Could be used to identify the cell phone.

string

n/a

ID
data[n]
 .name

Name of the phone paired.

string

n/a

Alice Phone's
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
    /* api name */
    "profile.smartdevice",
    /* parameters */
     null
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })
1
2
3
4
5
6
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "GET", 
  "api": "profile.smartdevice",
  "params":  null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "profile.smartdevice",
  "status": 200,
  "statusText": "OK", 
  "data": [
    {'id': 'ID', 'name': 'Phone 1'}, 
    {'id': 'ID', 'name': 'Phone 2'}
  ] 
}

false

This API allows to retrieve the list of smartdevices paired with the current profile.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
action

Action triggering the subscribe notification.

string

- added

- deleted
added
smartdevice
 .id

Identifier of the phone triggering the notification.

string

n/a

smartdevice
 .name

Name of the phone triggering the notification.

string

n/a

Alice Phone's
pairedDeviceCount

New count of paired smartdevices.

int

n/a

1
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
webportal.subscribe(
    /* api name */
    "profile.smartdevice",
    /* parameters */
     null,
    /* callback for `NOTIFY` messages */
    async (notifyMessage) => {
      if (notifyMessage.status === 200) {
        /* handle `NOTIFY` response */
      }
      else { /*  handle `NOTIFY` error  */ }
    }
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })
1
2
3
4
5
6
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "SUBSCRIBE", 
  "api": "profile.smartdevice",
  "params":  null
}
1
2
3
4
5
6
7
8
9
10
11
// --- format of the `REPLY` message ---
// type: acknowledge the status of the subscription
// reception: only once after the subscription request
// contains outputed data: no
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "status": 200,
  "statusText": "OK"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// --- format of the `NOTIFY` message ---
// type: event message about the subscription
// reception: each time the conditions of the subscription are met
// contains outputed data: yes
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "NOTIFY",
  "api": "profile.smartdevice",
  "status": 200,
  "statusText": "OK", 
  "data": {
    'action': 'added',
    'smartdevice': {'id': 'ID', 'name': 'Phone 1'},
    'pairedDeviceCount': 1 
  } 
}