Account

Emergency (E911) addresses

Emergency (E911) addresses are the street addresses sent to 911 when someone calls from a user or device. Validate an address before saving it.

In the Key Admin this is the Emergency (E911) addresses switch. Read lets a key call the GET endpoints below. Write lets it call the ones that change data.

List emergency addresses

GET/domains/~/addresses

Returns the emergency addresses on the account.

Read Key Admin switch: Emergency (E911) addresses, Read. Read only keys also work.

Example request

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

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

Response 200

[
  {
    "emergency-address-id": "string",
    "domain": "string",
    "user": "1001",
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-line-2": "string",
    "address-city": "string",
    "...": "10 more fields"
  }
]

Response fields (18)

Field	Type	Notes
`emergency-address-id`	string	ID of the emergency address.
`domain`	string	The account the item belongs to. Max length 64
`user`	string	The user ID (extension).
`address-name`	string	Name of the address.
`caller-name`	string	Name of the caller.
`address-line-1`	string
`address-line-2`	string
`address-city`	string
`address-state-province-abbreviation`	string
`address-postal-code`	string
`address-country-abbreviation`	string
`address-location-description`	string
`ip-address-public`	string
`address-formatted-pidflo`	string
`carrier`	string
`count-users-configured`	integer
`address-formatted-pretty`	string
`address-is-default-for-site`	boolean

Count emergency addresses

GET/domains/~/addresses/count

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

Read Key Admin switch: Emergency (E911) addresses, Read. Read only keys also work.

Example request

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

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/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/~/addresses/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.

List emergency address endpoints

GET/domains/~/addresses/endpoints

Returns the devices and numbers linked to emergency addresses.

Read Key Admin switch: Emergency (E911) addresses, 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

Example request

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

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

Response 200

[
  {
    "emergency-address-id": "string",
    "domain": "string",
    "user": "1001",
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-line-2": "string",
    "address-city": "string",
    "...": "10 more fields"
  }
]

Response fields (18)

Field	Type	Notes
`emergency-address-id`	string	ID of the emergency address.
`domain`	string	The account the item belongs to. Max length 64
`user`	string	The user ID (extension).
`address-name`	string	Name of the address.
`caller-name`	string	Name of the caller.
`address-line-1`	string
`address-line-2`	string
`address-city`	string
`address-state-province-abbreviation`	string
`address-postal-code`	string
`address-country-abbreviation`	string
`address-location-description`	string
`ip-address-public`	string
`address-formatted-pidflo`	string
`carrier`	string
`count-users-configured`	integer
`address-formatted-pretty`	string
`address-is-default-for-site`	boolean

Create an emergency address

POST/domains/~/addresses

Adds a new emergency address on the account.

Write Key Admin switch: Emergency (E911) addresses, Write.

Request body application/json

Field	Type	Notes
`emergency-address-id` required	string	ID of the emergency address.
`address-name` required	string	Name of the address.
`caller-name` required	string	Name of the caller.
`address-line-1` required	string
`address-line-2`	string
`address-city` required	string
`address-state-province-abbreviation` required	string
`address-postal-code` required	string
`address-country-abbreviation` required	string
`address-location-description`	string
`ip-address-public`	string
`address-formatted-pidflo` required	string
`carrier`	string

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "emergency-address-id": "string",
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-formatted-pidflo": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/addresses", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "emergency-address-id": "string",
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-formatted-pidflo": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "emergency-address-id": "string",
        "address-name": "Front Desk",
        "caller-name": "Front Desk",
        "address-line-1": "string",
        "address-city": "string",
        "address-state-province-abbreviation": "string",
        "address-postal-code": "string",
        "address-country-abbreviation": "string",
        "address-formatted-pidflo": "string"
    },
)
print(r.status_code, r.json())

Response 200

{
  "address-formatted-pidflo": {},
  "object": "string",
  "domain": "string",
  "user": "1001",
  "address_id": "string",
  "address_name": "string",
  "callid_nmbr": "string",
  "address_line_1": "string",
  "...": "13 more fields"
}

Response fields (21)

Field	Type	Notes
`address-formatted-pidflo`	object
`object`	string
`domain`	string	The account the item belongs to.
`user`	string	The user ID (extension).
`address_id`	string
`address_name`	string
`callid_nmbr`	string
`address_line_1`	string
`address_line_2`	string
`city`	string
`state_code`	string
`zip`	string
`country_code`	string
`location`	string
`carrier`	string
`public_ip`	string
`action`	string
`singular`	integer
`controller`	string
`format`	string
`apiVer`	string

Other responses: 409. See errors.

Link an emergency address

POST/domains/~/addresses/endpoints

Links an emergency address to a device or number.

Write Key Admin switch: Emergency (E911) addresses, Write.

Request body application/json

Field	Type	Notes
`address-callback-number`	any	Address callback number.
`address-name` required	string	Name of the address.
`caller-name` required	string	Name of the caller.
`address-line-1`	string
`address-line-2`	string
`address-city`	string
`address-state-province-abbreviation`	string
`address-postal-code`	string
`address-country-abbreviation`	string
`address-location-description`	string
`address-formatted-pidflo`	object
`carrier`	string
`location-id`	string	ID of the location.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/endpoints" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address-name": "Front Desk",
    "caller-name": "Front Desk"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/endpoints", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "address-name": "Front Desk",
    "caller-name": "Front Desk"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/endpoints",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "address-name": "Front Desk",
        "caller-name": "Front Desk"
    },
)
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.

Validate an emergency address

POST/domains/~/addresses/validate

Checks an address with the emergency address service before you save it.

Write Key Admin switch: Emergency (E911) addresses, Write.

Request body application/json

Field	Type	Notes
`emergency-address-id`	string	ID of the emergency address.
`address-name` required	string	Name of the address.
`caller-name` required	string	Name of the caller.
`address-line-1` required	string
`address-line-2`	string
`address-country-abbreviation` required	string
`address-state-province-abbreviation` required	string
`address-city` required	string
`address-postal-code` required	string
`address-location-description` required	string

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/validate" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address-line-1": "string",
    "address-country-abbreviation": "string",
    "address-state-province-abbreviation": "string",
    "address-city": "string",
    "address-postal-code": "string",
    "address-location-description": "string",
    "address-name": "Front Desk",
    "caller-name": "Front Desk"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/validate", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "address-line-1": "string",
    "address-country-abbreviation": "string",
    "address-state-province-abbreviation": "string",
    "address-city": "string",
    "address-postal-code": "string",
    "address-location-description": "string",
    "address-name": "Front Desk",
    "caller-name": "Front Desk"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/validate",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "address-line-1": "string",
        "address-country-abbreviation": "string",
        "address-state-province-abbreviation": "string",
        "address-city": "string",
        "address-postal-code": "string",
        "address-location-description": "string",
        "address-name": "Front Desk",
        "caller-name": "Front Desk"
    },
)
print(r.status_code, r.json())

Response 200

{
  "domain": "string",
  "object": "string",
  "emergency-address-id": "string",
  "address-formatted-pidflo": {},
  "address-name": "Front Desk",
  "caller-name": "Front Desk",
  "address-line-1": "string",
  "address-line-2": "string",
  "...": "5 more fields"
}

Response fields (13)

Field	Type	Notes
`domain`	string	The account the item belongs to.
`object`	string
`emergency-address-id`	string	ID of the emergency address.
`address-formatted-pidflo`	object
`address-name`	string	Name of the address.
`caller-name`	string	Name of the caller.
`address-line-1`	string
`address-line-2`	string
`address-country-abbreviation`	string
`address-state-province-abbreviation`	string
`address-city`	string
`address-postal-code`	string
`carrier`	string

Update an emergency address endpoint

PUT/domains/~/addresses/endpoints/{endpoint}

Changes an existing emergency address endpoint. Send the fields you want to set in the body.

Write Key Admin switch: Emergency (E911) addresses, Write.

Parameters

Name	In	Type	Notes
`endpoint` required	path	string	The emergency address endpoint ID.

Request body application/json

Field	Type	Notes
`address-name` required	string	Name of the address.
`caller-name` required	string	Name of the caller.
`address-line-1`	string
`address-line-2`	string
`address-city`	string
`address-state-province-abbreviation`	string
`address-postal-code`	string
`address-country-abbreviation`	string
`address-location-description`	string
`address-formatted-pidflo`	object
`carrier`	string
`location-id`	string	ID of the location.

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/endpoints/{endpoint_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address-name": "Front Desk",
    "caller-name": "Front Desk"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/endpoints/{endpoint_id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "address-name": "Front Desk",
    "caller-name": "Front Desk"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/endpoints/{endpoint_id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "address-name": "Front Desk",
        "caller-name": "Front Desk"
    },
)
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.

Update an emergency address

PUT/domains/~/addresses/{emergency-address-id}

Changes an existing emergency address. Send the fields you want to set in the body.

Write Key Admin switch: Emergency (E911) addresses, Write.

Parameters

Name	In	Type	Notes
`emergency-address-id` required	path	string	The emergency address ID.

Request body application/json

Field	Type	Notes
`address-name` required	string	Name of the address.
`caller-name` required	string	Name of the caller.
`address-line-1` required	string
`address-line-2`	string
`address-city` required	string
`address-state-province-abbreviation` required	string
`address-postal-code` required	string
`address-country-abbreviation` required	string
`address-location-description`	string
`ip-address-public`	string
`address-formatted-pidflo` required	string
`carrier`	string

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/{address_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-formatted-pidflo": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/{address_id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-formatted-pidflo": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/{address_id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "address-name": "Front Desk",
        "caller-name": "Front Desk",
        "address-line-1": "string",
        "address-city": "string",
        "address-state-province-abbreviation": "string",
        "address-postal-code": "string",
        "address-country-abbreviation": "string",
        "address-formatted-pidflo": "string"
    },
)
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 an emergency address endpoint

DELETE/domains/~/addresses/endpoints/{endpoint}

Removes an emergency address endpoint. This can't be undone.

Write Key Admin switch: Emergency (E911) addresses, Write.

Parameters

Name	In	Type	Notes
`endpoint` required	path	string	The emergency address endpoint ID.

Request body application/json

Field	Type	Notes
`carrier` required	string

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/endpoints/{endpoint_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "carrier": "string"
  }'

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

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/endpoints/{endpoint_id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "carrier": "string"
    },
)
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 an emergency address

DELETE/domains/~/addresses/{emergency-address-id}

Removes an emergency address. This can't be undone.

Write Key Admin switch: Emergency (E911) addresses, Write.

Parameters

Name	In	Type	Notes
`emergency-address-id` required	path	string	The emergency address ID.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/{address_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/addresses/{address_id}", {
  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/~/addresses/{address_id}",
    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.

List emergency addresses for a user

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

Returns the emergency addresses for one user.

Read Key Admin switch: Emergency (E911) addresses, 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
`show_all_personal`	query	string	Set to `yes` to include every user's personal contacts.
`show_only_personal`	query	string	Set to `yes` to return only personal contacts.

Example request

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

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

Response 200

[
  {
    "emergency-address-id": "string",
    "domain": "string",
    "user": "1001",
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-line-2": "string",
    "address-city": "string",
    "...": "10 more fields"
  }
]

Response fields (18)

Field	Type	Notes
`emergency-address-id`	string	ID of the emergency address.
`domain`	string	The account the item belongs to. Max length 64
`user`	string	The user ID (extension).
`address-name`	string	Name of the address.
`caller-name`	string	Name of the caller.
`address-line-1`	string
`address-line-2`	string
`address-city`	string
`address-state-province-abbreviation`	string
`address-postal-code`	string
`address-country-abbreviation`	string
`address-location-description`	string
`ip-address-public`	string
`address-formatted-pidflo`	string
`carrier`	string
`count-users-configured`	integer
`address-formatted-pretty`	string
`address-is-default-for-site`	boolean

Get a user's emergency address

GET/domains/~/users/{user}/addresses/{emergency-address-id}

Returns one of a user's emergency addresses.

Read Key Admin switch: Emergency (E911) addresses, 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
`emergency-address-id` required	path	string	The emergency address ID.

Example request

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

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

Response 200

{
  "emergency-address-id": "string",
  "domain": "string",
  "user": "1001",
  "address-name": "Front Desk",
  "caller-name": "Front Desk",
  "address-line-1": "string",
  "address-line-2": "string",
  "address-city": "string",
  "...": "10 more fields"
}

Response fields (18)

Field	Type	Notes
`emergency-address-id`	string	ID of the emergency address.
`domain`	string	The account the item belongs to. Max length 64
`user`	string	The user ID (extension).
`address-name`	string	Name of the address.
`caller-name`	string	Name of the caller.
`address-line-1`	string
`address-line-2`	string
`address-city`	string
`address-state-province-abbreviation`	string
`address-postal-code`	string
`address-country-abbreviation`	string
`address-location-description`	string
`ip-address-public`	string
`address-formatted-pidflo`	string
`carrier`	string
`count-users-configured`	integer
`address-formatted-pretty`	string
`address-is-default-for-site`	boolean

Create an emergency address for a user

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

Adds a new emergency address for one user.

Write Key Admin switch: Emergency (E911) addresses, 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
`emergency-address-id` required	string	ID of the emergency address.
`address-name` required	string	Name of the address.
`caller-name` required	string	Name of the caller.
`address-line-1` required	string
`address-line-2`	string
`address-city` required	string
`address-state-province-abbreviation` required	string
`address-postal-code` required	string
`address-country-abbreviation` required	string
`address-location-description`	string
`ip-address-public`	string
`address-formatted-pidflo` required	string
`carrier`	string

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/addresses" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "emergency-address-id": "string",
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-formatted-pidflo": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/addresses", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "emergency-address-id": "string",
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-formatted-pidflo": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/addresses",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "emergency-address-id": "string",
        "address-name": "Front Desk",
        "caller-name": "Front Desk",
        "address-line-1": "string",
        "address-city": "string",
        "address-state-province-abbreviation": "string",
        "address-postal-code": "string",
        "address-country-abbreviation": "string",
        "address-formatted-pidflo": "string"
    },
)
print(r.status_code, r.json())

Response 200

{
  "address-formatted-pidflo": {},
  "object": "string",
  "domain": "string",
  "user": "1001",
  "address_id": "string",
  "address_name": "string",
  "callid_nmbr": "string",
  "address_line_1": "string",
  "...": "13 more fields"
}

Response fields (21)

Field	Type	Notes
`address-formatted-pidflo`	object
`object`	string
`domain`	string	The account the item belongs to.
`user`	string	The user ID (extension).
`address_id`	string
`address_name`	string
`callid_nmbr`	string
`address_line_1`	string
`address_line_2`	string
`city`	string
`state_code`	string
`zip`	string
`country_code`	string
`location`	string
`carrier`	string
`public_ip`	string
`action`	string
`singular`	integer
`controller`	string
`format`	string
`apiVer`	string

Update a user's emergency address

PUT/domains/~/users/{user}/addresses/{emergency-address-id}

Changes one of a user's emergency addresses.

Write Key Admin switch: Emergency (E911) addresses, 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
`emergency-address-id` required	path	string	The emergency address ID.

Request body application/json

Field	Type	Notes
`address-name` required	string	Name of the address.
`caller-name` required	string	Name of the caller.
`address-line-1` required	string
`address-line-2`	string
`address-city` required	string
`address-state-province-abbreviation` required	string
`address-postal-code` required	string
`address-country-abbreviation` required	string
`address-location-description`	string
`ip-address-public`	string
`address-formatted-pidflo` required	string
`carrier`	string

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/addresses/{address_id}" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-formatted-pidflo": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/addresses/{address_id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "address-name": "Front Desk",
    "caller-name": "Front Desk",
    "address-line-1": "string",
    "address-city": "string",
    "address-state-province-abbreviation": "string",
    "address-postal-code": "string",
    "address-country-abbreviation": "string",
    "address-formatted-pidflo": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/addresses/{address_id}",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "address-name": "Front Desk",
        "caller-name": "Front Desk",
        "address-line-1": "string",
        "address-city": "string",
        "address-state-province-abbreviation": "string",
        "address-postal-code": "string",
        "address-country-abbreviation": "string",
        "address-formatted-pidflo": "string"
    },
)
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 emergency address

DELETE/domains/~/users/{user}/addresses/{address_id}

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

Write Key Admin switch: Emergency (E911) addresses, 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
`address_id` required	path	string	The emergency address ID.

Example request

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

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/users/1001/addresses/{address_id}", {
  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/addresses/{address_id}",
    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.