Account

Account settings

The account record holds account-wide settings: name, default caller ID, time zone, language and limits.

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

Get the account

GET/domains/~

Returns the account record: its name, caller ID defaults, time zone, limits and other settings.

Read Key Admin switch: Account settings, Read. Read only keys also work.

Example request

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

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

Response 200

{
  "domain": "string",
  "reseller": "string",
  "description": "string",
  "music-on-hold-enabled": "yes",
  "music-on-ring-enabled": "yes",
  "music-on-hold-randomized-enabled": "yes",
  "domain-type": "Standard",
  "dial-plan": "string",
  "...": "34 more fields"
}

Response fields (42)

Field	Type	Notes
`domain`	string	The account the item belongs to. Max length 64
`reseller`	string	The parent account group. Set by the platform.
`description`	string	A note about the item.
`music-on-hold-enabled`	string	Turns music on hold on or off (`yes` or `no`). One of: `yes`, `no`
`music-on-ring-enabled`	string	Turns music on ring on or off (`yes` or `no`). One of: `yes`, `no`
`music-on-hold-randomized-enabled`	string	Turns music on hold randomized on or off (`yes` or `no`). One of: `yes`, `no`
`domain-type`	string	One of: `Standard`, `Residential`, `Hospitality`
`dial-plan`	string	The dial plan the item uses.
`dial-policy`	string	The dial policy the item uses.
`email-send-from-address`	string
`single-sign-on-enabled`	string	Turns single sign on on or off (`yes` or `no`). One of: `yes`, `no`
`area-code`	number	Min 100 Max 999
`caller-id-name`	string	Name shown to people you call.
`caller-id-number`	string	Number shown to people you call.
`caller-id-number-emergency`	string	Number sent to 911 for callback.
`limits-max-subcriber-resources-total`	integer
`limits-max-active-calls-total`	integer
`limits-max-active-calls-offnet`	integer
`limits-max-call-queues`	integer
`limits-max-auto-attendants`	integer
`limits-max-conferences`	integer
`limits-max-departments`	integer
`limits-max-users`	integer
`limits-max-sites`	integer
`limits-max-fax-accounts`	integer
`time-zone`	string	Time zone name, like `America/New_York`. One of: `US/Alaska`, `US/Central`, `US/Eastern`, `US/Hawaii`, `US/Mountain`, `US/Pacific`, `Africa/Addis_Ababa`, `Africa/Algiers`, `Africa/Brazzaville`, `Africa/Cairo`, `Africa/Casablanca`, `Africa/Dakar`, `Africa/Dar_es_Salaam`, `Africa/Djibouti`, `Africa/Johannesburg`, `Africa/Khartoum`, `Africa/Kigali`, `Africa/Kinshasa`, `Africa/Lagos`, `Africa/Nairobi`, `Africa/Timbuktu`, `Africa/Tripoli`, `Africa/Tunis`, `America/Antigua`, `America/Aruba`, `America/Belize`, `America/Bogota`, `America/Buenos_Aires`, `America/Cancun`, `America/Caracas`, `America/Cayman`, `America/Chihuahua`, `America/Costa_Rica`, `America/Denver`, `America/Detroit`, `America/Edmonton`, `America/El_Salvador`, `America/Ensenada`, `America/Grenada`, `America/Guadeloupe` ...
`email-send-smtp-hostname`	string (hostname)
`email-send-smtp-port`	string
`email-send-smtp-username`	string
`email-send-smtp-password`	string (pass)
`active-calls-total-current`	integer
`active-calls-against-license-count`	integer	Number of active calls against license.
`active-calls-offnet-current`	integer
`count-subcriber-resources-total`	integer
`emergency-address-id`	string	ID of the emergency address.
`voicemail-enabled`	string	Turns voicemail on or off (`yes` or `no`). One of: `yes`, `no`
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`
`voicemail-transcription-enabled`	string	Turns voicemail transcription on or off (`yes` or `no`). One of: `no`, `deepgram`, `google`, `mutare`, `voicebase` Default `no`
`language-token`	string	Language for prompts and voicemail, like `en_US`. Default `en_US`
`is-domain-locked`	string	One of: `yes`, `no`
`is-stir-enabled`	string	Turns is stir on or off (`yes` or `no`). One of: `yes`, `no`
`is-ivr-forward-change-blocked`	string	One of: `yes`, `no`

Other responses: 404. See errors.

Check the account exists

GET/domains/~/count

Returns a total of 1 when the account is visible to your key. Handy as a quick connection test.

Read Key Admin switch: Account settings, Read. Read only keys also work.

Example request

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

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

Update the account

PUT/domains/~

Changes settings on the account record, such as the default caller ID, time zone or language.

Write Key Admin switch: Account settings, Write.

Request body application/json

Field	Type	Notes
`reseller`	string	The parent account group. Set by the platform.
`description`	string	A note about the item.
`music-on-hold-enabled`	string	Turns music on hold on or off (`yes` or `no`). One of: `yes`, `no`
`music-on-ring-enabled`	string	Turns music on ring on or off (`yes` or `no`). One of: `yes`, `no`
`music-on-hold-randomized-enabled`	string	Turns music on hold randomized on or off (`yes` or `no`). One of: `yes`, `no`
`domain-type`	string	One of: `Standard`, `Residential`, `Hospitality`
`dial-plan`	string	The dial plan the item uses.
`dial-policy`	string	The dial policy the item uses.
`email-send-from-address`	string
`single-sign-on-enabled`	string	Turns single sign on on or off (`yes` or `no`). One of: `yes`, `no`
`area-code`	number	Min 100 Max 999
`caller-id-name`	string	Name shown to people you call.
`caller-id-number`	string	Number shown to people you call.
`caller-id-number-emergency`	string	Number sent to 911 for callback.
`limits-max-subcriber-resources-total`	integer
`limits-max-active-calls-total`	integer
`limits-max-active-calls-offnet`	integer
`limits-max-call-queues`	integer
`limits-max-auto-attendants`	integer
`limits-max-conferences`	integer
`limits-max-departments`	integer
`limits-max-users`	integer
`limits-max-sites`	integer
`limits-max-fax-accounts`	integer
`time-zone`	string	Time zone name, like `America/New_York`. One of: `US/Alaska`, `US/Central`, `US/Eastern`, `US/Hawaii`, `US/Mountain`, `US/Pacific`, `Africa/Addis_Ababa`, `Africa/Algiers`, `Africa/Brazzaville`, `Africa/Cairo`, `Africa/Casablanca`, `Africa/Dakar`, `Africa/Dar_es_Salaam`, `Africa/Djibouti`, `Africa/Johannesburg`, `Africa/Khartoum`, `Africa/Kigali`, `Africa/Kinshasa`, `Africa/Lagos`, `Africa/Nairobi`, `Africa/Timbuktu`, `Africa/Tripoli`, `Africa/Tunis`, `America/Antigua`, `America/Aruba`, `America/Belize`, `America/Bogota`, `America/Buenos_Aires`, `America/Cancun`, `America/Caracas`, `America/Cayman`, `America/Chihuahua`, `America/Costa_Rica`, `America/Denver`, `America/Detroit`, `America/Edmonton`, `America/El_Salvador`, `America/Ensenada`, `America/Grenada`, `America/Guadeloupe` ...
`email-send-smtp-hostname`	string (hostname)
`email-send-smtp-port`	string
`email-send-smtp-username`	string
`email-send-smtp-password`	string (pass)
`active-calls-total-current`	integer
`active-calls-against-license-count`	integer	Number of active calls against license.
`active-calls-offnet-current`	integer
`count-subcriber-resources-total`	integer
`emergency-address-id`	string	ID of the emergency address.
`voicemail-enabled`	string	Turns voicemail on or off (`yes` or `no`). One of: `yes`, `no`
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`
`voicemail-transcription-enabled`	string	Turns voicemail transcription on or off (`yes` or `no`). One of: `no`, `Deepgram`, `Google`, `Mutare`, `Voicebase` Default `no`
`language-token`	string	Language for prompts and voicemail, like `en_US`. Default `en_US`
`is-domain-locked`	string	One of: `yes`, `no`
`is-stir-enabled`	string	Turns is stir on or off (`yes` or `no`). One of: `yes`, `no`
`is-ivr-forward-change-blocked`	string	One of: `yes`, `no`

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reseller": "string",
    "description": "string",
    "music-on-hold-enabled": "yes",
    "music-on-ring-enabled": "yes",
    "music-on-hold-randomized-enabled": "yes"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reseller": "string",
    "description": "string",
    "music-on-hold-enabled": "yes",
    "music-on-ring-enabled": "yes",
    "music-on-hold-randomized-enabled": "yes"
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "reseller": "string",
        "description": "string",
        "music-on-hold-enabled": "yes",
        "music-on-ring-enabled": "yes",
        "music-on-hold-randomized-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.

Other responses: 404. See errors.