People and devices
Sites and departments
Sites group users by office location. Departments group them by team. Both are handy for filtering reports and presence.
In the Key Admin this is the Sites and departments switch. Read lets a key call the GET endpoints below. Write lets it call the ones that change data.
List departments
GET
/domains/~/departments/listReturns the department names used to group users on the account.
Read Key Admin switch: Sites and departments, Read. Read only keys also work.
Example request
curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/departments/list" \
-H "Authorization: Bearer $NOODLEVOICE_KEY"const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/departments/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/~/departments/list",
headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())Response 200
Returns a status code with a short JSON message.
Other responses: 400, 401, 403, 404. See errors.
Get presence for a department
GET
/domains/~/departments/{department}/presence/listReturns the availability of every user in one department.
Read Key Admin switch: Sites and departments, Read. Read only keys also work.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
department required | path | string | The department name. |
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/~/departments/Sales/presence/list" \
-H "Authorization: Bearer $NOODLEVOICE_KEY"const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/departments/Sales/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/~/departments/Sales/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.
List sites
GET
/domains/~/sitesReturns the sites on the account.
Read Key Admin switch: Sites and departments, Read. Read only keys also work.
Example request
curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/sites" \
-H "Authorization: Bearer $NOODLEVOICE_KEY"const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/sites", {
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/~/sites",
headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())Response 200
[
{
"synchronous": "yes",
"site": "string",
"login-username": "string",
"email": "jane@example.com",
"time-zone": "US/Alaska",
"dial-plan": "string",
"dial-policy": "string",
"voicemail-user-control-enabled": "yes",
"...": "24 more fields"
}
]Response fields (32)
| 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 |
site | string | The site name. |
login-username | string | |
email | string (email) | Email address. Separate more than one with commas. |
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 ... |
dial-plan | string | The dial plan the item uses. |
dial-policy | string | The dial policy the item uses. |
voicemail-user-control-enabled | string | Turns voicemail user control on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-allow-enabled | string | Turns phone numbers to allow on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-reject-enabled | string | Turns phone numbers to reject on or off (yes or no). One of: yes, no Default yes |
call-screening-enabled | string | Turns call screening on or off (yes or no). One of: yes, no Default yes |
language-token | string | Language for prompts and voicemail, like en_US. Default en_US |
limits-max-data-storage-kilobytes | integer | Min 0 |
limits-max-active-calls-total | integer | Min 0 Max 3600 |
directory-announce-in-dial-by-name-enabled | string | Turns directory announce in dial by name on or off (yes or no). One of: yes, no Default yes |
voicemail-enabled | string | Turns voicemail on or off (yes or no). One of: yes, no Default yes |
voicemail-receive-broadcast-enabled | string | Turns voicemail receive broadcast on or off (yes or no). One of: yes, no Default yes |
reject-anonymous-calls-enabled | string | Turns reject anonymous calls on or off (yes or no). One of: yes, no Default no |
voicemail-playback-announce-datetime-received | string | One of: yes, no Default no |
voicemail-playback-announce-caller-id | string | ID of the voicemail playback announce caller. One of: yes, no Default no |
voicemail-playback-sort-newest-to-oldest | string | One of: yes, no Default yes |
caller-id-number | string (phonenumber) | Number shown to people you call. |
caller-id-name | string | Name shown to people you call. |
caller-id-number-emergency | any | Number sent to 911 for callback. |
area-code | integer | Min 100 Max 999 |
directory-name-visible-in-list-enabled | string | Turns directory name visible in list on or off (yes or no). One of: yes, no Default yes |
emergency-address-id | string | ID of the emergency address. |
music-on-hold-randomized-enabled | string | Turns music on hold randomized on or off (yes or no). One of: yes, no Default no |
active-calls-total-current | integer | |
created-datetime | string (date-time) | Created (date and time). |
last-modified-datetime | string (date-time) | Last modified (date and time). |
recording-configuration | string | One of: yes, yes-with-transcription, yes-with-transcription-and-sentiment, no Default no |
Count sites
GET
/domains/~/sites/countReturns how many sites there are on the account, as {"total": n}.
Read Key Admin switch: Sites and departments, Read. Read only keys also work.
Example request
curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/sites/count" \
-H "Authorization: Bearer $NOODLEVOICE_KEY"const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/sites/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/~/sites/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 sites (short form)
GET
/domains/~/sites/listReturns just the names of the sites on the account.
Read Key Admin switch: Sites and departments, Read. Read only keys also work.
Example request
curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/sites/list" \
-H "Authorization: Bearer $NOODLEVOICE_KEY"const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/sites/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/~/sites/list",
headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())Response 200
[
{
"synchronous": "yes",
"site": "string",
"login-username": "string",
"email": "jane@example.com",
"time-zone": "US/Alaska",
"dial-plan": "string",
"dial-policy": "string",
"voicemail-user-control-enabled": "yes",
"...": "24 more fields"
}
]Response fields (32)
| 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 |
site | string | The site name. |
login-username | string | |
email | string (email) | Email address. Separate more than one with commas. |
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 ... |
dial-plan | string | The dial plan the item uses. |
dial-policy | string | The dial policy the item uses. |
voicemail-user-control-enabled | string | Turns voicemail user control on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-allow-enabled | string | Turns phone numbers to allow on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-reject-enabled | string | Turns phone numbers to reject on or off (yes or no). One of: yes, no Default yes |
call-screening-enabled | string | Turns call screening on or off (yes or no). One of: yes, no Default yes |
language-token | string | Language for prompts and voicemail, like en_US. Default en_US |
limits-max-data-storage-kilobytes | integer | Min 0 |
limits-max-active-calls-total | integer | Min 0 Max 3600 |
directory-announce-in-dial-by-name-enabled | string | Turns directory announce in dial by name on or off (yes or no). One of: yes, no Default yes |
voicemail-enabled | string | Turns voicemail on or off (yes or no). One of: yes, no Default yes |
voicemail-receive-broadcast-enabled | string | Turns voicemail receive broadcast on or off (yes or no). One of: yes, no Default yes |
reject-anonymous-calls-enabled | string | Turns reject anonymous calls on or off (yes or no). One of: yes, no Default no |
voicemail-playback-announce-datetime-received | string | One of: yes, no Default no |
voicemail-playback-announce-caller-id | string | ID of the voicemail playback announce caller. One of: yes, no Default no |
voicemail-playback-sort-newest-to-oldest | string | One of: yes, no Default yes |
caller-id-number | string (phonenumber) | Number shown to people you call. |
caller-id-name | string | Name shown to people you call. |
caller-id-number-emergency | any | Number sent to 911 for callback. |
area-code | integer | Min 100 Max 999 |
directory-name-visible-in-list-enabled | string | Turns directory name visible in list on or off (yes or no). One of: yes, no Default yes |
emergency-address-id | string | ID of the emergency address. |
music-on-hold-randomized-enabled | string | Turns music on hold randomized on or off (yes or no). One of: yes, no Default no |
active-calls-total-current | integer | |
created-datetime | string (date-time) | Created (date and time). |
last-modified-datetime | string (date-time) | Last modified (date and time). |
recording-configuration | string | One of: yes, yes-with-transcription, yes-with-transcription-and-sentiment, no Default no |
Other responses: 400, 401, 403, 404. See errors.
Get a site
GET
/domains/~/sites/{site}Returns one site by its ID.
Read Key Admin switch: Sites and departments, Read. Read only keys also work.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
site required | path | string | The site name. |
Example request
curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/sites/Main" \
-H "Authorization: Bearer $NOODLEVOICE_KEY"const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/sites/Main", {
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/~/sites/Main",
headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())Response 200
{
"synchronous": "yes",
"site": "string",
"login-username": "string",
"email": "jane@example.com",
"time-zone": "US/Alaska",
"dial-plan": "string",
"dial-policy": "string",
"voicemail-user-control-enabled": "yes",
"...": "24 more fields"
}Response fields (32)
| 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 |
site | string | The site name. |
login-username | string | |
email | string (email) | Email address. Separate more than one with commas. |
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 ... |
dial-plan | string | The dial plan the item uses. |
dial-policy | string | The dial policy the item uses. |
voicemail-user-control-enabled | string | Turns voicemail user control on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-allow-enabled | string | Turns phone numbers to allow on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-reject-enabled | string | Turns phone numbers to reject on or off (yes or no). One of: yes, no Default yes |
call-screening-enabled | string | Turns call screening on or off (yes or no). One of: yes, no Default yes |
language-token | string | Language for prompts and voicemail, like en_US. Default en_US |
limits-max-data-storage-kilobytes | integer | Min 0 |
limits-max-active-calls-total | integer | Min 0 Max 3600 |
directory-announce-in-dial-by-name-enabled | string | Turns directory announce in dial by name on or off (yes or no). One of: yes, no Default yes |
voicemail-enabled | string | Turns voicemail on or off (yes or no). One of: yes, no Default yes |
voicemail-receive-broadcast-enabled | string | Turns voicemail receive broadcast on or off (yes or no). One of: yes, no Default yes |
reject-anonymous-calls-enabled | string | Turns reject anonymous calls on or off (yes or no). One of: yes, no Default no |
voicemail-playback-announce-datetime-received | string | One of: yes, no Default no |
voicemail-playback-announce-caller-id | string | ID of the voicemail playback announce caller. One of: yes, no Default no |
voicemail-playback-sort-newest-to-oldest | string | One of: yes, no Default yes |
caller-id-number | string (phonenumber) | Number shown to people you call. |
caller-id-name | string | Name shown to people you call. |
caller-id-number-emergency | any | Number sent to 911 for callback. |
area-code | integer | Min 100 Max 999 |
directory-name-visible-in-list-enabled | string | Turns directory name visible in list on or off (yes or no). One of: yes, no Default yes |
emergency-address-id | string | ID of the emergency address. |
music-on-hold-randomized-enabled | string | Turns music on hold randomized on or off (yes or no). One of: yes, no Default no |
active-calls-total-current | integer | |
created-datetime | string (date-time) | Created (date and time). |
last-modified-datetime | string (date-time) | Last modified (date and time). |
recording-configuration | string | One of: yes, yes-with-transcription, yes-with-transcription-and-sentiment, no Default no |
Create a site
POST
/domains/~/sitesAdds a new site on the account.
Write Key Admin switch: Sites and departments, Write.
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 |
site required | string | The site name. |
login-username | string | |
email required | string (email) | Email address. Separate more than one with commas. |
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 ... |
dial-plan | string | The dial plan the item uses. |
dial-policy | string | The dial policy the item uses. |
voicemail-user-control-enabled | string | Turns voicemail user control on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-allow-enabled | string | Turns phone numbers to allow on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-reject-enabled | string | Turns phone numbers to reject on or off (yes or no). One of: yes, no Default yes |
call-screening-enabled | string | Turns call screening on or off (yes or no). One of: yes, no Default yes |
language-token | string | Language for prompts and voicemail, like en_US. Default en_US |
limits-max-data-storage-kilobytes | integer | Min 0 |
limits-max-active-calls-total | integer | Min 0 Max 3600 |
directory-announce-in-dial-by-name-enabled | string | Turns directory announce in dial by name on or off (yes or no). One of: yes, no Default yes |
voicemail-enabled | string | Turns voicemail on or off (yes or no). One of: yes, no Default yes |
voicemail-receive-broadcast-enabled | string | Turns voicemail receive broadcast on or off (yes or no). One of: yes, no Default yes |
reject-anonymous-calls-enabled | string | Turns reject anonymous calls on or off (yes or no). One of: yes, no Default no |
voicemail-playback-announce-datetime-received | string | One of: yes, no Default no |
voicemail-playback-announce-caller-id | string | ID of the voicemail playback announce caller. One of: yes, no Default no |
voicemail-playback-sort-newest-to-oldest | string | One of: yes, no Default yes |
caller-id-number | string (phonenumber) | Number shown to people you call. |
caller-id-name | string | Name shown to people you call. |
caller-id-number-emergency | any | Number sent to 911 for callback. |
area-code | integer | Min 100 Max 999 |
directory-name-visible-in-list-enabled | string | Turns directory name visible in list on or off (yes or no). One of: yes, no Default yes |
emergency-address-id | string | ID of the emergency address. |
music-on-hold-randomized-enabled | string | Turns music on hold randomized on or off (yes or no). One of: yes, no Default no |
active-calls-total-current | integer | |
created-datetime | string (date-time) | Created (date and time). |
last-modified-datetime | string (date-time) | Last modified (date and time). |
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/~/sites" \
-H "Authorization: Bearer $NOODLEVOICE_KEY" \
-H "Content-Type: application/json" \
-d '{
"site": "string",
"email": "jane@example.com"
}'const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/sites", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"site": "string",
"email": "jane@example.com"
}),
});
const data = await res.json();import os, requests
r = requests.post(
"https://api.noodlevoice.com/ns-api/v2/domains/~/sites",
headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
json={
"site": "string",
"email": "jane@example.com"
},
)
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: 409. See errors.
Update a site
PUT
/domains/~/sites/{site}Changes an existing site. Send the fields you want to set in the body.
Write Key Admin switch: Sites and departments, Write.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
site required | path | string | The site name. |
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 |
login-username | string | |
email required | string (email) | Email address. Separate more than one with commas. |
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 ... |
dial-plan | string | The dial plan the item uses. |
dial-policy | string | The dial policy the item uses. |
voicemail-user-control-enabled | string | Turns voicemail user control on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-allow-enabled | string | Turns phone numbers to allow on or off (yes or no). One of: yes, no Default yes |
phone-numbers-to-reject-enabled | string | Turns phone numbers to reject on or off (yes or no). One of: yes, no Default yes |
call-screening-enabled | string | Turns call screening on or off (yes or no). One of: yes, no Default yes |
language-token | string | Language for prompts and voicemail, like en_US. Default en_US |
limits-max-data-storage-kilobytes | integer | Min 0 |
limits-max-active-calls-total | integer | Min 0 Max 3600 |
directory-announce-in-dial-by-name-enabled | string | Turns directory announce in dial by name on or off (yes or no). One of: yes, no Default yes |
voicemail-enabled | string | Turns voicemail on or off (yes or no). One of: yes, no Default yes |
voicemail-receive-broadcast-enabled | string | Turns voicemail receive broadcast on or off (yes or no). One of: yes, no Default yes |
reject-anonymous-calls-enabled | string | Turns reject anonymous calls on or off (yes or no). One of: yes, no Default no |
voicemail-playback-announce-datetime-received | string | One of: yes, no Default no |
voicemail-playback-announce-caller-id | string | ID of the voicemail playback announce caller. One of: yes, no Default no |
voicemail-playback-sort-newest-to-oldest | string | One of: yes, no Default yes |
caller-id-number | string (phonenumber) | Number shown to people you call. |
caller-id-name | string | Name shown to people you call. |
caller-id-number-emergency | any | Number sent to 911 for callback. |
area-code | integer | Min 100 Max 999 |
directory-name-visible-in-list-enabled | string | Turns directory name visible in list on or off (yes or no). One of: yes, no Default yes |
emergency-address-id | string | ID of the emergency address. |
music-on-hold-randomized-enabled | string | Turns music on hold randomized on or off (yes or no). One of: yes, no Default no |
active-calls-total-current | integer | |
created-datetime | string (date-time) | Created (date and time). |
last-modified-datetime | string (date-time) | Last modified (date and time). |
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/~/sites/Main" \
-H "Authorization: Bearer $NOODLEVOICE_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "jane@example.com"
}'const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/sites/Main", {
method: "PUT",
headers: {
Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"email": "jane@example.com"
}),
});
const data = await res.json();import os, requests
r = requests.put(
"https://api.noodlevoice.com/ns-api/v2/domains/~/sites/Main",
headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
json={
"email": "jane@example.com"
},
)
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. |