Numbers and call routing
Auto attendants
Auto attendants are the menus callers hear ("press 1 for sales"). Each menu has a greeting and an action for each key.
In the Key Admin this is the Auto attendants switch. Read lets a key call the GET endpoints below. Write lets it call the ones that change data.
List auto attendants
GET
/domains/~/autoattendantsReturns the auto attendants on the account.
Read Key Admin switch: Auto attendants, Read. Read only keys also work.
Example request
curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/autoattendants" \
-H "Authorization: Bearer $NOODLEVOICE_KEY"const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/autoattendants", {
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/~/autoattendants",
headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())Response 200
[
{
"attendant-name": "Front Desk",
"user": "1001",
"time-frame": "string",
"starting-prompt": "string",
"read-path": "string",
"auto-attendant": {
"intro-greetings": "string",
"audio": {},
"unassigned-key-press": "repeat"
}
}
]Response fields (109)
| Field | Type | Notes |
|---|---|---|
attendant-name | string | Name of the attendant. |
user | string | The user ID (extension). |
time-frame | string | |
starting-prompt | string | |
read-path | string | |
auto-attendant | object | |
auto-attendant.intro-greetings | string | |
auto-attendant.audio | object | |
auto-attendant.audio.filename | string | |
auto-attendant.audio.ordinal-order | integer | |
auto-attendant.audio.file-duration-seconds | integer | File duration, in seconds. |
auto-attendant.audio.file-size-kilobytes | string | |
auto-attendant.audio.file-access-url | string | |
auto-attendant.audio.file-script-text | string | |
auto-attendant.audio.text-to-speech-voice-id | string | ID of the text to speech voice. Default en-US-Wavenet-C |
auto-attendant.audio.text-to-speech-language | string | Default en_US |
auto-attendant.unassigned-key-press | string | One of: repeat, hangup, option-1, option-2, option-3, option-4, option-5, option-6, option-7, option-8, option-9, option-0, option-*, option-# Default repeat |
auto-attendant.no-key-press | string | One of: repeat, hangup, option-1, option-2, option-3, option-4, option-5, option-6, option-7, option-8, option-9, option-0, option-*, option-# Default repeat |
auto-attendant.3-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.4-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.5-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.option-1 | object | |
auto-attendant.option-1.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-1.destination-user | string | |
auto-attendant.option-1.caller-name-translation | string | Default [*] |
auto-attendant.option-1.description | string | A note about the item. |
auto-attendant.option-1.call-to-record | string | |
auto-attendant.option-1.auto-attendant | object | |
auto-attendant.option-1.remove | any | |
auto-attendant.option-2 | object | |
auto-attendant.option-2.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-2.destination-user | string | |
auto-attendant.option-2.caller-name-translation | string | Default [*] |
auto-attendant.option-2.description | string | A note about the item. |
auto-attendant.option-2.call-to-record | string | |
auto-attendant.option-2.auto-attendant | object | |
auto-attendant.option-2.remove | any | |
auto-attendant.option-3 | object | |
auto-attendant.option-3.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-3.destination-user | string | |
auto-attendant.option-3.caller-name-translation | string | Default [*] |
auto-attendant.option-3.description | string | A note about the item. |
auto-attendant.option-3.call-to-record | string | |
auto-attendant.option-3.auto-attendant | object | |
auto-attendant.option-3.remove | any | |
auto-attendant.option-4 | object | |
auto-attendant.option-4.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-4.destination-user | string | |
auto-attendant.option-4.caller-name-translation | string | Default [*] |
auto-attendant.option-4.description | string | A note about the item. |
auto-attendant.option-4.call-to-record | string | |
auto-attendant.option-4.auto-attendant | object | |
auto-attendant.option-4.remove | any | |
auto-attendant.option-5 | object | |
auto-attendant.option-5.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-5.destination-user | string | |
auto-attendant.option-5.caller-name-translation | string | Default [*] |
auto-attendant.option-5.description | string | A note about the item. |
auto-attendant.option-5.call-to-record | string | |
auto-attendant.option-5.auto-attendant | object | |
auto-attendant.option-5.remove | any | |
auto-attendant.option-6 | object | |
auto-attendant.option-6.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-6.destination-user | string | |
auto-attendant.option-6.caller-name-translation | string | Default [*] |
auto-attendant.option-6.description | string | A note about the item. |
auto-attendant.option-6.call-to-record | string | |
auto-attendant.option-6.auto-attendant | object | |
auto-attendant.option-6.remove | any | |
auto-attendant.option-7 | object | |
auto-attendant.option-7.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-7.destination-user | string | |
auto-attendant.option-7.caller-name-translation | string | Default [*] |
auto-attendant.option-7.description | string | A note about the item. |
auto-attendant.option-7.call-to-record | string | |
auto-attendant.option-7.auto-attendant | object | |
auto-attendant.option-7.remove | any | |
auto-attendant.option-8 | object | |
auto-attendant.option-8.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-8.destination-user | string | |
auto-attendant.option-8.caller-name-translation | string | Default [*] |
auto-attendant.option-8.description | string | A note about the item. |
auto-attendant.option-8.call-to-record | string | |
auto-attendant.option-8.auto-attendant | object | |
auto-attendant.option-8.remove | any | |
auto-attendant.option-9 | object | |
auto-attendant.option-9.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-9.destination-user | string | |
auto-attendant.option-9.caller-name-translation | string | Default [*] |
auto-attendant.option-9.description | string | A note about the item. |
auto-attendant.option-9.call-to-record | string | |
auto-attendant.option-9.auto-attendant | object | |
auto-attendant.option-9.remove | any | |
auto-attendant.option-0 | object | |
auto-attendant.option-0.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-0.destination-user | string | |
auto-attendant.option-0.caller-name-translation | string | Default [*] |
auto-attendant.option-0.description | string | A note about the item. |
auto-attendant.option-0.call-to-record | string | |
auto-attendant.option-0.auto-attendant | object | |
auto-attendant.option-0.remove | any | |
auto-attendant.option-* | object | |
auto-attendant.option-*.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-*.destination-user | string | |
auto-attendant.option-*.caller-name-translation | string | Default [*] |
auto-attendant.option-*.description | string | A note about the item. |
auto-attendant.option-*.call-to-record | string | |
auto-attendant.option-*.auto-attendant | object | |
auto-attendant.option-*.remove | any |
Create an auto attendant
POST
/domains/~/autoattendantsAdds a new auto attendant on the account.
Write Key Admin switch: Auto attendants, Write.
Request body application/json
| Field | Type | Notes |
|---|---|---|
attendant-name required | string | Name of the attendant. |
user required | string | The user ID (extension). |
time-frame | string | |
auto-attendant | object | |
auto-attendant.intro-greetings | string | |
auto-attendant.audio | object | |
auto-attendant.audio.filename | string | |
auto-attendant.audio.ordinal-order | integer | |
auto-attendant.audio.file-duration-seconds | integer | File duration, in seconds. |
auto-attendant.audio.file-size-kilobytes | string | |
auto-attendant.audio.file-access-url | string | |
auto-attendant.audio.file-script-text | string | |
auto-attendant.audio.text-to-speech-voice-id | string | ID of the text to speech voice. Default en-US-Wavenet-C |
auto-attendant.audio.text-to-speech-language | string | Default en_US |
auto-attendant.unassigned-key-press | string | One of: repeat, hangup, option-1, option-2, option-3, option-4, option-5, option-6, option-7, option-8, option-9, option-0, option-*, option-# Default repeat |
auto-attendant.no-key-press | string | One of: repeat, hangup, option-1, option-2, option-3, option-4, option-5, option-6, option-7, option-8, option-9, option-0, option-*, option-# Default repeat |
auto-attendant.3-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.4-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.5-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.option-1 | object | |
auto-attendant.option-1.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-1.destination-user | string | |
auto-attendant.option-1.caller-name-translation | string | Default [*] |
auto-attendant.option-1.description | string | A note about the item. |
auto-attendant.option-1.call-to-record | string | |
auto-attendant.option-1.auto-attendant | object | |
auto-attendant.option-1.remove | any | |
auto-attendant.option-2 | object | |
auto-attendant.option-2.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-2.destination-user | string | |
auto-attendant.option-2.caller-name-translation | string | Default [*] |
auto-attendant.option-2.description | string | A note about the item. |
auto-attendant.option-2.call-to-record | string | |
auto-attendant.option-2.auto-attendant | object | |
auto-attendant.option-2.remove | any | |
auto-attendant.option-3 | object | |
auto-attendant.option-3.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-3.destination-user | string | |
auto-attendant.option-3.caller-name-translation | string | Default [*] |
auto-attendant.option-3.description | string | A note about the item. |
auto-attendant.option-3.call-to-record | string | |
auto-attendant.option-3.auto-attendant | object | |
auto-attendant.option-3.remove | any | |
auto-attendant.option-4 | object | |
auto-attendant.option-4.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-4.destination-user | string | |
auto-attendant.option-4.caller-name-translation | string | Default [*] |
auto-attendant.option-4.description | string | A note about the item. |
auto-attendant.option-4.call-to-record | string | |
auto-attendant.option-4.auto-attendant | object | |
auto-attendant.option-4.remove | any | |
auto-attendant.option-5 | object | |
auto-attendant.option-5.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-5.destination-user | string | |
auto-attendant.option-5.caller-name-translation | string | Default [*] |
auto-attendant.option-5.description | string | A note about the item. |
auto-attendant.option-5.call-to-record | string | |
auto-attendant.option-5.auto-attendant | object | |
auto-attendant.option-5.remove | any | |
auto-attendant.option-6 | object | |
auto-attendant.option-6.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-6.destination-user | string | |
auto-attendant.option-6.caller-name-translation | string | Default [*] |
auto-attendant.option-6.description | string | A note about the item. |
auto-attendant.option-6.call-to-record | string | |
auto-attendant.option-6.auto-attendant | object | |
auto-attendant.option-6.remove | any | |
auto-attendant.option-7 | object | |
auto-attendant.option-7.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-7.destination-user | string | |
auto-attendant.option-7.caller-name-translation | string | Default [*] |
auto-attendant.option-7.description | string | A note about the item. |
auto-attendant.option-7.call-to-record | string | |
auto-attendant.option-7.auto-attendant | object | |
auto-attendant.option-7.remove | any | |
auto-attendant.option-8 | object | |
auto-attendant.option-8.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-8.destination-user | string | |
auto-attendant.option-8.caller-name-translation | string | Default [*] |
auto-attendant.option-8.description | string | A note about the item. |
auto-attendant.option-8.call-to-record | string | |
auto-attendant.option-8.auto-attendant | object | |
auto-attendant.option-8.remove | any | |
auto-attendant.option-9 | object | |
auto-attendant.option-9.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-9.destination-user | string | |
auto-attendant.option-9.caller-name-translation | string | Default [*] |
auto-attendant.option-9.description | string | A note about the item. |
auto-attendant.option-9.call-to-record | string | |
auto-attendant.option-9.auto-attendant | object | |
auto-attendant.option-9.remove | any | |
auto-attendant.option-0 | object | |
auto-attendant.option-0.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-0.destination-user | string | |
auto-attendant.option-0.caller-name-translation | string | Default [*] |
auto-attendant.option-0.description | string | A note about the item. |
auto-attendant.option-0.call-to-record | string | |
auto-attendant.option-0.auto-attendant | object | |
auto-attendant.option-0.remove | any | |
auto-attendant.option-* | object | |
auto-attendant.option-*.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-*.destination-user | string | |
auto-attendant.option-*.caller-name-translation | string | Default [*] |
auto-attendant.option-*.description | string | A note about the item. |
auto-attendant.option-*.call-to-record | string | |
auto-attendant.option-*.auto-attendant | object | |
auto-attendant.option-*.remove | any |
Example request
curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/autoattendants" \
-H "Authorization: Bearer $NOODLEVOICE_KEY" \
-H "Content-Type: application/json" \
-d '{
"attendant-name": "Front Desk",
"user": "1001"
}'const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/autoattendants", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"attendant-name": "Front Desk",
"user": "1001"
}),
});
const data = await res.json();import os, requests
r = requests.post(
"https://api.noodlevoice.com/ns-api/v2/domains/~/autoattendants",
headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
json={
"attendant-name": "Front Desk",
"user": "1001"
},
)
print(r.status_code, r.json())Response 200
{
"attendant-name": "Front Desk",
"user": "1001",
"time-frame": "string",
"auto-attendant": {
"intro-greetings": "string",
"audio": {},
"unassigned-key-press": "repeat"
}
}Response fields (107)
| Field | Type | Notes |
|---|---|---|
attendant-name | string | Name of the attendant. |
user | string | The user ID (extension). |
time-frame | string | |
auto-attendant | object | |
auto-attendant.intro-greetings | string | |
auto-attendant.audio | object | |
auto-attendant.audio.filename | string | |
auto-attendant.audio.ordinal-order | integer | |
auto-attendant.audio.file-duration-seconds | integer | File duration, in seconds. |
auto-attendant.audio.file-size-kilobytes | string | |
auto-attendant.audio.file-access-url | string | |
auto-attendant.audio.file-script-text | string | |
auto-attendant.audio.text-to-speech-voice-id | string | ID of the text to speech voice. Default en-US-Wavenet-C |
auto-attendant.audio.text-to-speech-language | string | Default en_US |
auto-attendant.unassigned-key-press | string | One of: repeat, hangup, option-1, option-2, option-3, option-4, option-5, option-6, option-7, option-8, option-9, option-0, option-*, option-# Default repeat |
auto-attendant.no-key-press | string | One of: repeat, hangup, option-1, option-2, option-3, option-4, option-5, option-6, option-7, option-8, option-9, option-0, option-*, option-# Default repeat |
auto-attendant.3-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.4-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.5-digit-dial-by-extension | string | One of: yes, no Default yes |
auto-attendant.option-1 | object | |
auto-attendant.option-1.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-1.destination-user | string | |
auto-attendant.option-1.caller-name-translation | string | Default [*] |
auto-attendant.option-1.description | string | A note about the item. |
auto-attendant.option-1.call-to-record | string | |
auto-attendant.option-1.auto-attendant | object | |
auto-attendant.option-1.remove | any | |
auto-attendant.option-2 | object | |
auto-attendant.option-2.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-2.destination-user | string | |
auto-attendant.option-2.caller-name-translation | string | Default [*] |
auto-attendant.option-2.description | string | A note about the item. |
auto-attendant.option-2.call-to-record | string | |
auto-attendant.option-2.auto-attendant | object | |
auto-attendant.option-2.remove | any | |
auto-attendant.option-3 | object | |
auto-attendant.option-3.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-3.destination-user | string | |
auto-attendant.option-3.caller-name-translation | string | Default [*] |
auto-attendant.option-3.description | string | A note about the item. |
auto-attendant.option-3.call-to-record | string | |
auto-attendant.option-3.auto-attendant | object | |
auto-attendant.option-3.remove | any | |
auto-attendant.option-4 | object | |
auto-attendant.option-4.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-4.destination-user | string | |
auto-attendant.option-4.caller-name-translation | string | Default [*] |
auto-attendant.option-4.description | string | A note about the item. |
auto-attendant.option-4.call-to-record | string | |
auto-attendant.option-4.auto-attendant | object | |
auto-attendant.option-4.remove | any | |
auto-attendant.option-5 | object | |
auto-attendant.option-5.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-5.destination-user | string | |
auto-attendant.option-5.caller-name-translation | string | Default [*] |
auto-attendant.option-5.description | string | A note about the item. |
auto-attendant.option-5.call-to-record | string | |
auto-attendant.option-5.auto-attendant | object | |
auto-attendant.option-5.remove | any | |
auto-attendant.option-6 | object | |
auto-attendant.option-6.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-6.destination-user | string | |
auto-attendant.option-6.caller-name-translation | string | Default [*] |
auto-attendant.option-6.description | string | A note about the item. |
auto-attendant.option-6.call-to-record | string | |
auto-attendant.option-6.auto-attendant | object | |
auto-attendant.option-6.remove | any | |
auto-attendant.option-7 | object | |
auto-attendant.option-7.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-7.destination-user | string | |
auto-attendant.option-7.caller-name-translation | string | Default [*] |
auto-attendant.option-7.description | string | A note about the item. |
auto-attendant.option-7.call-to-record | string | |
auto-attendant.option-7.auto-attendant | object | |
auto-attendant.option-7.remove | any | |
auto-attendant.option-8 | object | |
auto-attendant.option-8.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-8.destination-user | string | |
auto-attendant.option-8.caller-name-translation | string | Default [*] |
auto-attendant.option-8.description | string | A note about the item. |
auto-attendant.option-8.call-to-record | string | |
auto-attendant.option-8.auto-attendant | object | |
auto-attendant.option-8.remove | any | |
auto-attendant.option-9 | object | |
auto-attendant.option-9.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-9.destination-user | string | |
auto-attendant.option-9.caller-name-translation | string | Default [*] |
auto-attendant.option-9.description | string | A note about the item. |
auto-attendant.option-9.call-to-record | string | |
auto-attendant.option-9.auto-attendant | object | |
auto-attendant.option-9.remove | any | |
auto-attendant.option-0 | object | |
auto-attendant.option-0.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-0.destination-user | string | |
auto-attendant.option-0.caller-name-translation | string | Default [*] |
auto-attendant.option-0.description | string | A note about the item. |
auto-attendant.option-0.call-to-record | string | |
auto-attendant.option-0.auto-attendant | object | |
auto-attendant.option-0.remove | any | |
auto-attendant.option-* | object | |
auto-attendant.option-*.destination-application | string | One of: available-number, to-voicemail-residential, to-callqueue, to-callqueue-announce-count-callers-ahead, to-callqueue-announce-expected-wait-time, to-connection, to-connection-or-user-no-failover, to-single-device, to-user, to-user-residential, to-voicemail, spam-screening, to-connection-block-caller-id, to-connection-no-timeout, to-connection-add-header-force-caller-id, to-connection-add-header-no-timeout, to-connection-add-header, to-single-device-add-header-allow-voicemail, to-single-device-add-header-allow-voicemail-residential, to-single-device-add-header, to-user-add-header, to-user-residential-add-header, to-user-notify-of-recording, hangup, to-user-answer-and-fake-ringback, toggle-timeframe |
auto-attendant.option-*.destination-user | string | |
auto-attendant.option-*.caller-name-translation | string | Default [*] |
auto-attendant.option-*.description | string | A note about the item. |
auto-attendant.option-*.call-to-record | string | |
auto-attendant.option-*.auto-attendant | object | |
auto-attendant.option-*.remove | any |