People and devices

Devices and registrations

Devices are the SIP registrations a user's calls ring on: desk phones, softphones and mobile apps. A user can have several. Registration fields tell you whether a device is online right now.

In the Key Admin this is the Devices and registrations switch. Read lets a key call the GET endpoints below. Write lets it call the ones that change data.

List devices

GET/domains/~/devices

Returns the devices on the account.

Read Key Admin switch: Devices and registrations, Read. Read only keys also work.

Example request

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

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/devices", {
  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/~/devices",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "device": "string",
    "user": "1001",
    "domain": "string",
    "device-sip-registration-uri": "string",
    "device-sip-registration-state": "registered",
    "device-sip-registration-password": "string",
    "caller-id-number-emergency": "[*]",
    "device-force-notify-new-voicemails-enabled": "yes",
    "...": "31 more fields"
  }
]

Response fields (39)

Field	Type	Notes
`device`	string	The device ID.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to. Max length 64
`device-sip-registration-uri`	string
`device-sip-registration-state`	string	One of: `registered`, `unregistered`
`device-sip-registration-password`	string (password)
`caller-id-number-emergency`	string	Number sent to 911 for callback. Default `[*]`
`device-force-notify-new-voicemails-enabled`	string	Turns device force notify new voicemails on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-level-call-recording-enabled`	string	Turns device level call recording on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-push-enabled`	string	Turns device push on or off (`yes` or `no`). One of: `yes`, `no` Default `yes`
`device-sip-registration-contact`	string
`device-sip-registration-core-server`	string (hostname)
`device-sip-registration-datetime`	string (date-time)	Device sip registration (date and time).
`device-sip-registration-expires-datetime`	string (date-time)	Device sip registration expires (date and time).
`device-sip-registration-expiry-seconds`	integer	Device sip registration expiry, in seconds. Default `60`
`device-sip-registration-ignore-for-presence-calculation`	string	One of: `yes`, `no` Default `no`
`device-sip-registration-ignore-report-enabled`	string	Turns device sip registration ignore report on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-registration-ip-address`	string (i)
`device-sip-registration-user-agent`	string
`device-sip-no-to-tag-in-cancel`	string	One of: `yes`, `no` Default `no`
`device-srtp-enabled`	string	Turns device srtp on or off (`yes` or `no`). One of: `yes`, `no`, `opportunistic` Default `no`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-allowed-user-agent`	string
`device-sip-nat-traversal-enabled`	string	Turns device sip nat traversal on or off (`yes` or `no`). One of: `automatic`, `none`, `never`, `fixed` Default `automatic`
`device-sip-latency-seconds-current`	number
`device-sip-latency-seconds-average`	number
`emergency-address-id`	string	ID of the emergency address.
`error-reading-from-endpoint-module`	string
`login-username`	string
`name-full-name`	string	Full name.
`device-models-model`	string
`device-provisioning-mac-address`	string
`device-provisioning-registration-core-server`	string
`device-provisioning-sip-transport-protocol`	string	One of: `udp`, `tcp`, `tls` Default `udp`
`device-provisioning-username`	string
`device-provisioning-password`	string
`device-provisioning-line`	integer
`device-provisioning-overrides`	string
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Count devices

GET/domains/~/devices/count

Returns how many devices there are on the account, as {"total": n}.

Read Key Admin switch: Devices and registrations, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`limit`	query	number (int)	Most results to return in one response. Default `100` Min 1 Max 1000
`start`	query	number (int)	How many results to skip. Use with limit to page through results. Default `0` Min 0

Example request

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

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/devices/count", {
  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/~/devices/count",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "total": 1
}

Response fields (1)

Field	Type	Notes
`total`	integer	How many items matched.

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

Check a device exists

GET/domains/~/devices/{device}/count

Returns a total of 1 when the device exists on the account.

Read Key Admin switch: Devices and registrations, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`device` required	path	string	The device ID (its SIP user, often the extension with a letter after it, like `1001a`).
`limit`	query	number (int)	Most results to return in one response. Default `100` Min 1 Max 1000
`start`	query	number (int)	How many results to skip. Use with limit to page through results. Default `0` Min 0

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/devices/1001a/count" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/devices/1001a/count", {
  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/~/devices/1001a/count",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "total": 1
}

Response fields (1)

Field	Type	Notes
`total`	integer	How many items matched.

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

List devices for a user

GET/domains/~/users/{user}/devices

Returns the devices for one user.

Read Key Admin switch: Devices and registrations, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Example request

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

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices", {
  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/~/users/1001/devices",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "device": "string",
    "user": "1001",
    "domain": "string",
    "device-sip-registration-uri": "string",
    "device-sip-registration-state": "registered",
    "device-sip-registration-password": "string",
    "caller-id-number-emergency": "[*]",
    "device-force-notify-new-voicemails-enabled": "yes",
    "...": "31 more fields"
  }
]

Response fields (39)

Field	Type	Notes
`device`	string	The device ID.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to. Max length 64
`device-sip-registration-uri`	string
`device-sip-registration-state`	string	One of: `registered`, `unregistered`
`device-sip-registration-password`	string (password)
`caller-id-number-emergency`	string	Number sent to 911 for callback. Default `[*]`
`device-force-notify-new-voicemails-enabled`	string	Turns device force notify new voicemails on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-level-call-recording-enabled`	string	Turns device level call recording on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-push-enabled`	string	Turns device push on or off (`yes` or `no`). One of: `yes`, `no` Default `yes`
`device-sip-registration-contact`	string
`device-sip-registration-core-server`	string (hostname)
`device-sip-registration-datetime`	string (date-time)	Device sip registration (date and time).
`device-sip-registration-expires-datetime`	string (date-time)	Device sip registration expires (date and time).
`device-sip-registration-expiry-seconds`	integer	Device sip registration expiry, in seconds. Default `60`
`device-sip-registration-ignore-for-presence-calculation`	string	One of: `yes`, `no` Default `no`
`device-sip-registration-ignore-report-enabled`	string	Turns device sip registration ignore report on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-registration-ip-address`	string (i)
`device-sip-registration-user-agent`	string
`device-sip-no-to-tag-in-cancel`	string	One of: `yes`, `no` Default `no`
`device-srtp-enabled`	string	Turns device srtp on or off (`yes` or `no`). One of: `yes`, `no`, `opportunistic` Default `no`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-allowed-user-agent`	string
`device-sip-nat-traversal-enabled`	string	Turns device sip nat traversal on or off (`yes` or `no`). One of: `automatic`, `none`, `never`, `fixed` Default `automatic`
`device-sip-latency-seconds-current`	number
`device-sip-latency-seconds-average`	number
`emergency-address-id`	string	ID of the emergency address.
`error-reading-from-endpoint-module`	string
`login-username`	string
`name-full-name`	string	Full name.
`device-models-model`	string
`device-provisioning-mac-address`	string
`device-provisioning-registration-core-server`	string
`device-provisioning-sip-transport-protocol`	string	One of: `udp`, `tcp`, `tls` Default `udp`
`device-provisioning-username`	string
`device-provisioning-password`	string
`device-provisioning-line`	integer
`device-provisioning-overrides`	string
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Count devices for a user

GET/domains/~/users/{user}/devices/count

Returns how many devices there are for one user, as {"total": n}.

Read Key Admin switch: Devices and registrations, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`limit`	query	number (int)	Most results to return in one response. Default `100` Min 1 Max 1000
`start`	query	number (int)	How many results to skip. Use with limit to page through results. Default `0` Min 0

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices/count" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices/count", {
  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/~/users/1001/devices/count",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "total": 1
}

Response fields (1)

Field	Type	Notes
`total`	integer	How many items matched.

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

Get a user's device

GET/domains/~/users/{user}/devices/{device}

Returns one of a user's devices.

Read Key Admin switch: Devices and registrations, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`device` required	path	string	The device ID (its SIP user, often the extension with a letter after it, like `1001a`).

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices/1001a" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices/1001a", {
  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/~/users/1001/devices/1001a",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "device": "string",
  "user": "1001",
  "domain": "string",
  "device-sip-registration-uri": "string",
  "device-sip-registration-state": "registered",
  "device-sip-registration-password": "string",
  "caller-id-number-emergency": "[*]",
  "device-force-notify-new-voicemails-enabled": "yes",
  "...": "31 more fields"
}

Response fields (39)

Field	Type	Notes
`device`	string	The device ID.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to. Max length 64
`device-sip-registration-uri`	string
`device-sip-registration-state`	string	One of: `registered`, `unregistered`
`device-sip-registration-password`	string (password)
`caller-id-number-emergency`	string	Number sent to 911 for callback. Default `[*]`
`device-force-notify-new-voicemails-enabled`	string	Turns device force notify new voicemails on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-level-call-recording-enabled`	string	Turns device level call recording on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-push-enabled`	string	Turns device push on or off (`yes` or `no`). One of: `yes`, `no` Default `yes`
`device-sip-registration-contact`	string
`device-sip-registration-core-server`	string (hostname)
`device-sip-registration-datetime`	string (date-time)	Device sip registration (date and time).
`device-sip-registration-expires-datetime`	string (date-time)	Device sip registration expires (date and time).
`device-sip-registration-expiry-seconds`	integer	Device sip registration expiry, in seconds. Default `60`
`device-sip-registration-ignore-for-presence-calculation`	string	One of: `yes`, `no` Default `no`
`device-sip-registration-ignore-report-enabled`	string	Turns device sip registration ignore report on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-registration-ip-address`	string (i)
`device-sip-registration-user-agent`	string
`device-sip-no-to-tag-in-cancel`	string	One of: `yes`, `no` Default `no`
`device-srtp-enabled`	string	Turns device srtp on or off (`yes` or `no`). One of: `yes`, `no`, `opportunistic` Default `no`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-allowed-user-agent`	string
`device-sip-nat-traversal-enabled`	string	Turns device sip nat traversal on or off (`yes` or `no`). One of: `automatic`, `none`, `never`, `fixed` Default `automatic`
`device-sip-latency-seconds-current`	number
`device-sip-latency-seconds-average`	number
`emergency-address-id`	string	ID of the emergency address.
`error-reading-from-endpoint-module`	string
`login-username`	string
`name-full-name`	string	Full name.
`device-models-model`	string
`device-provisioning-mac-address`	string
`device-provisioning-registration-core-server`	string
`device-provisioning-sip-transport-protocol`	string	One of: `udp`, `tcp`, `tls` Default `udp`
`device-provisioning-username`	string
`device-provisioning-password`	string
`device-provisioning-line`	integer
`device-provisioning-overrides`	string
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Create a device for a user

POST/domains/~/users/{user}/devices

Adds a new device for one user.

Write Key Admin switch: Devices and registrations, Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16

Request body application/json

Field	Type	Notes
`synchronous`	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`device` required	string	The device ID.
`device-sip-registration-uri`	string
`device-sip-registration-state`	string	One of: `registered`, `unregistered`
`device-sip-registration-password`	string (password)
`caller-id-number-emergency`	string	Number sent to 911 for callback. Default `[*]`
`device-force-notify-new-voicemails-enabled`	string	Turns device force notify new voicemails on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-level-call-recording-enabled`	string	Turns device level call recording on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-push-enabled`	string	Turns device push on or off (`yes` or `no`). One of: `yes`, `no` Default `yes`
`device-sip-registration-contact`	string
`device-sip-registration-core-server`	string (hostname)
`device-sip-registration-datetime`	string (date-time)	Device sip registration (date and time).
`device-sip-registration-expires-datetime`	string (date-time)	Device sip registration expires (date and time).
`device-sip-registration-expiry-seconds`	integer	Device sip registration expiry, in seconds. Default `60`
`device-sip-registration-ignore-for-presence-calculation`	string	One of: `yes`, `no` Default `no`
`device-sip-registration-ignore-report-enabled`	string	Turns device sip registration ignore report on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-registration-ip-address`	string (i)
`device-sip-registration-user-agent`	string
`device-sip-no-to-tag-in-cancel`	string	One of: `yes`, `no` Default `no`
`device-srtp-enabled`	string	Turns device srtp on or off (`yes` or `no`). One of: `yes`, `no`, `opportunistic` Default `no`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-allowed-user-agent`	string
`device-sip-nat-traversal-enabled`	string	Turns device sip nat traversal on or off (`yes` or `no`). One of: `automatic`, `none`, `never`, `fixed` Default `automatic`
`device-sip-latency-seconds-current`	number
`device-sip-latency-seconds-average`	number
`emergency-address-id`	string	ID of the emergency address.
`error-reading-from-endpoint-module`	string
`login-username`	string
`name-full-name`	string	Full name.
`device-models-model`	string
`device-provisioning-mac-address`	string
`device-provisioning-registration-core-server`	string
`device-provisioning-sip-transport-protocol`	string	One of: `udp`, `tcp`, `tls` Default `udp`
`device-provisioning-username`	string
`device-provisioning-password`	string
`device-provisioning-line`	integer
`device-provisioning-overrides`	string
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "device": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "device": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "device": "string"
    },
)
print(r.status_code, r.json())

Response 200

{
  "device": "string",
  "user": "1001",
  "domain": "string",
  "device-sip-registration-uri": "string",
  "device-sip-registration-state": "registered",
  "device-sip-registration-password": "string",
  "caller-id-number-emergency": "[*]",
  "device-force-notify-new-voicemails-enabled": "yes",
  "...": "31 more fields"
}

Response fields (39)

Field	Type	Notes
`device`	string	The device ID.
`user`	string	The user ID (extension).
`domain`	string	The account the item belongs to. Max length 64
`device-sip-registration-uri`	string
`device-sip-registration-state`	string	One of: `registered`, `unregistered`
`device-sip-registration-password`	string (password)
`caller-id-number-emergency`	string	Number sent to 911 for callback. Default `[*]`
`device-force-notify-new-voicemails-enabled`	string	Turns device force notify new voicemails on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-level-call-recording-enabled`	string	Turns device level call recording on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-push-enabled`	string	Turns device push on or off (`yes` or `no`). One of: `yes`, `no` Default `yes`
`device-sip-registration-contact`	string
`device-sip-registration-core-server`	string (hostname)
`device-sip-registration-datetime`	string (date-time)	Device sip registration (date and time).
`device-sip-registration-expires-datetime`	string (date-time)	Device sip registration expires (date and time).
`device-sip-registration-expiry-seconds`	integer	Device sip registration expiry, in seconds. Default `60`
`device-sip-registration-ignore-for-presence-calculation`	string	One of: `yes`, `no` Default `no`
`device-sip-registration-ignore-report-enabled`	string	Turns device sip registration ignore report on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-registration-ip-address`	string (i)
`device-sip-registration-user-agent`	string
`device-sip-no-to-tag-in-cancel`	string	One of: `yes`, `no` Default `no`
`device-srtp-enabled`	string	Turns device srtp on or off (`yes` or `no`). One of: `yes`, `no`, `opportunistic` Default `no`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-allowed-user-agent`	string
`device-sip-nat-traversal-enabled`	string	Turns device sip nat traversal on or off (`yes` or `no`). One of: `automatic`, `none`, `never`, `fixed` Default `automatic`
`device-sip-latency-seconds-current`	number
`device-sip-latency-seconds-average`	number
`emergency-address-id`	string	ID of the emergency address.
`error-reading-from-endpoint-module`	string
`login-username`	string
`name-full-name`	string	Full name.
`device-models-model`	string
`device-provisioning-mac-address`	string
`device-provisioning-registration-core-server`	string
`device-provisioning-sip-transport-protocol`	string	One of: `udp`, `tcp`, `tls` Default `udp`
`device-provisioning-username`	string
`device-provisioning-password`	string
`device-provisioning-line`	integer
`device-provisioning-overrides`	string
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Update a user's device

PUT/domains/~/users/{user}/devices/{device}

Changes one of a user's devices.

Write Key Admin switch: Devices and registrations, Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`device` required	path	string	The device ID (its SIP user, often the extension with a letter after it, like `1001a`).

Request body application/json

Field	Type	Notes
`device-sip-registration-uri`	string
`device-sip-registration-state`	string	One of: `registered`, `unregistered`
`device-sip-registration-password`	string (password)
`caller-id-number-emergency`	string	Number sent to 911 for callback. Default `[*]`
`device-force-notify-new-voicemails-enabled`	string	Turns device force notify new voicemails on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-level-call-recording-enabled`	string	Turns device level call recording on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-push-enabled`	string	Turns device push on or off (`yes` or `no`). One of: `yes`, `no` Default `yes`
`device-sip-registration-contact`	string
`device-sip-registration-core-server`	string (hostname)
`device-sip-registration-datetime`	string (date-time)	Device sip registration (date and time).
`device-sip-registration-expires-datetime`	string (date-time)	Device sip registration expires (date and time).
`device-sip-registration-expiry-seconds`	integer	Device sip registration expiry, in seconds. Default `60`
`device-sip-registration-ignore-for-presence-calculation`	string	One of: `yes`, `no` Default `no`
`device-sip-registration-ignore-report-enabled`	string	Turns device sip registration ignore report on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-registration-ip-address`	string (i)
`device-sip-registration-user-agent`	string
`device-sip-no-to-tag-in-cancel`	string	One of: `yes`, `no` Default `no`
`device-srtp-enabled`	string	Turns device srtp on or off (`yes` or `no`). One of: `yes`, `no`, `opportunistic` Default `no`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`device-sip-allowed-user-agent`	string
`device-sip-nat-traversal-enabled`	string	Turns device sip nat traversal on or off (`yes` or `no`). One of: `automatic`, `none`, `never`, `fixed` Default `automatic`
`device-sip-latency-seconds-current`	number
`device-sip-latency-seconds-average`	number
`emergency-address-id`	string	ID of the emergency address.
`error-reading-from-endpoint-module`	string
`login-username`	string
`name-full-name`	string	Full name.
`device-models-model`	string
`device-provisioning-mac-address`	string
`device-provisioning-registration-core-server`	string
`device-provisioning-sip-transport-protocol`	string	One of: `udp`, `tcp`, `tls` Default `udp`
`device-provisioning-username`	string
`device-provisioning-password`	string
`device-provisioning-line`	integer
`device-provisioning-overrides`	string
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices/1001a" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "device-sip-registration-uri": "string",
    "device-sip-registration-state": "registered",
    "device-sip-registration-password": "string",
    "caller-id-number-emergency": "[*]",
    "device-force-notify-new-voicemails-enabled": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices/1001a", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "device-sip-registration-uri": "string",
    "device-sip-registration-state": "registered",
    "device-sip-registration-password": "string",
    "caller-id-number-emergency": "[*]",
    "device-force-notify-new-voicemails-enabled": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices/1001a",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "device-sip-registration-uri": "string",
        "device-sip-registration-state": "registered",
        "device-sip-registration-password": "string",
        "caller-id-number-emergency": "[*]",
        "device-force-notify-new-voicemails-enabled": "yes"
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Delete a user's device

DELETE/domains/~/users/{user}/devices/{device}

Removes one of a user's devices. This can't be undone.

Write Key Admin switch: Devices and registrations, Write.

Parameters

Name	In	Type	Notes
`user` required	path	string	The user ID, usually their extension number, like `1001`. Default `~` Min length 0 Max length 16
`device` required	path	string	The device ID (its SIP user, often the extension with a letter after it, like `1001a`).

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/devices/1001a" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

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

import os, requests

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

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.