People and devices

Presence

Presence tells you who is available, busy, on a call or offline. Read only.

In the Key Admin this is the Presence switch. Read lets a key call the GET endpoints below. This feature is read only.

Get presence for all users

GET/domains/~/presence/list

Returns who is available, busy, on a call or offline, for every user on the account.

Read Key Admin switch: Presence, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`last_update`	query	string	Only return items changed since this date and time.
`limit`	query	number (int)	Most results to return in one response. Default `100` Min 1 Max 1000
`order`	query	string	Sort order for the results.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/presence/list" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/presence/list", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/presence/list",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "user": "1001",
    "uid": "string",
    "domain": "string",
    "site": "string",
    "name-first-name": "Front Desk",
    "name-last-name": "Front Desk",
    "department": "string",
    "user-presence-status": "string",
    "...": "1 more fields"
  }
]

Response fields (9)

Field	Type	Notes
`user`	string	The user ID (extension).
`uid`	string
`domain`	string	The account the item belongs to.
`site`	string	The site name.
`name-first-name`	string	First name.
`name-last-name`	string	Last name.
`department`	string	The department name.
`user-presence-status`	string
`email-address`	string	Email address.

Other responses: 400, 401, 403, 404. See errors.