- TODO LIST
- Version
- Authentication
- Access Token (Oauth - Username/Password)
- API Key (Machine 2 Machine)
- JWT (JSON Web Token)
- Event Subscriptions
- Resellers
- Domains
- Phone Numbers
- Users
- Devices
- Phones/Macs
- Sites
- Call Center
- Answer Rules
- Call Blocking
- Auto Attendant
- Media
- Voicemail
- Greetings
- Read Greetings for User
- Read Specific Greeting for User
- Delete Specific Greeting for User
- Create a new Greeting from TTS
- Update Greeting with TTS script
- Create a new Greeting from Upload (JSON + Base64 File)
- Update Greeting from Upload (JSON + Base64 File)
- Create a new Greeting from Upload (Multipart/Mixed Post)
- Update Greeting from Upload (Multipart/Mixed Post)
- Music on Hold
- Domain
- Read MOH for Domain
- Create a new MOH for Domain from TTS
- Update MOH for Domain from TTS
- Create a new MOH for Domain from Upload (JSON + Base64 File)
- Update MOH for Domain from Upload (JSON + Base64 File)
- Create a new MOH for Domain from Upload (Multipart/Mixed Post)
- Update MOH for Domain from Upload (Multipart/Mixed Post)
- Delete MOH for Domain
- User
- Read MOH for User
- Create a new MOH for Domain from TTS
- Create a new MOH for User from Upload (JSON + Base64 File)
- Update MOH for User from Upload (JSON + Base64 File)
- Update MOH for Domain from TTS
- Create a new MOH for User from Upload (Multipart/Mixed Post)
- Update a MOH for User from Upload (Multipart/Mixed Post)
- Delete MOH for User
- Domain
- Hold Messages
- Text to Speech
- CDR (Call History)
- Transcriptions & Sentiment
- Call Traces & Cradle to Grave
- Calls (live/active calls)
- Contacts
- Addresses
- Get Addresses for Domain
- Validate Address
- Create Address for Domain
- Update Address for Domain
- Update Address for User
- Update Address Endpoint
- Create Address for User
- Delete Address For User
- Delete Address Endpoint
- Delete Address For Domain
- Create Address Endpoint
- Get Address Endpoints for a Domain
- Get Addresses Count for Domain
- Get Addresses for User
- Get Address Using Address ID
- Voicemail Reminders
- Dialrule
- Messages
- Get Messagesessions for Domain
- Start a new Message Session
- Get Messagesessions for User
- Get Messages for Messagesession
- Send a message (Chat)
- Send a message (Group Chat)
- Send a message (Media Chat)
- Send a message (SMS)
- Send a message (Group SMS)
- Send a message (MMS)
- Update Messagesession (Participants)
- Update Messagesession (Session Name)
- Update Messagesession (Leave)
- Delete Messagesession
- SMS Numbers
- Recordings
- Email
- Connections
- Routes
- Meetings
- Event Logs
- Iotum
- Read Iotum Video Domain Resellers
- Read Iotum Video Host
- Read All Iotum Video Hosts in a Domain
- Read Iotum Video Host Conferences
- Read Iotum Video Host Contacts
- Read Iotum Video Company
- Read Iotum Video Company Products
- Read Iotum Video Available Products
- Create a Host
- Create Host Contacts
- Create Iotum Video Subscription
- Update Domain's Iotum Company
- Update Domain's Iotum Subscriptions
- Update User's Iotum Host
- Delete Iotum Video Subscription
- Delete a Host
- Create Iotum Video Company
- Create a Ad-hoc Conference
- Delete a Video Company
- Create a Meeting with Id
- Create a Meeting
- Read Meeting
- Count Domains Meetings
- Count Meeting
- Register Meeting
- Update a Meeting
- Delete a Meeting
- Request a Meeting ID
- Read Meetings for User
- Backup & Restore
- Configs
- Images
- Templates
- Timeframes
- Domain (Shared)
- User
- Holiday Information
- Firebase
- SSL Certificates
Update Specific Auto Attendant
PUT
/domains/{domain}/users/{user}/autoattendants/{prompt}
Last modified:2023-12-21 20:52:14
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Path Params
domain
stringÂ
required
Example:
{{domain}}
user
stringÂ
required
Example:
3008
prompt
stringÂ
required
Example:
Prompt_100
Body Params application/json
attendant-name
stringÂ
required
auto-attendant
object (AutoAttendantTier)Â
optional
intro-greetings
stringÂ
optional
audio
objectÂ
optional
unassigned-key-press
enum<string>Â
optional
Allowed values:
repeathangupoption-1option-2option-3option-4option-5option-6option-7option-8option-9option-0option-*option-#
Default:
repeat
no-key-press
enum<string>Â
optional
Allowed values:
repeathangupoption-1option-2option-3option-4option-5option-6option-7option-8option-9option-0option-*option-#
Default:
repeat
3-digit-dial-by-extension
enum<string>Â
optional
Allowed values:
yesno
Default:
yes
4-digit-dial-by-extension
enum<string>Â
optional
Allowed values:
yesno
Default:
yes
5-digit-dial-by-extension
enum<string>Â
optional
Allowed values:
yesno
Default:
yes
option-1
object (AutoAttendantTierOption)Â
optional
option-2
object (AutoAttendantTierOption)Â
optional
option-3
object (AutoAttendantTierOption)Â
optional
option-4
object (AutoAttendantTierOption)Â
optional
option-5
object (AutoAttendantTierOption)Â
optional
option-6
object (AutoAttendantTierOption)Â
optional
option-7
object (AutoAttendantTierOption)Â
optional
option-8
object (AutoAttendantTierOption)Â
optional
option-9
object (AutoAttendantTierOption)Â
optional
option-0
object (AutoAttendantTierOption)Â
optional
option-*
object (AutoAttendantTierOption)Â
optional
Example
{
"attendant-name": "Main AA Example",
"auto-attendant": {
"no-key-press": "option-1",
"unassigned-key-press": "repeat",
"3-digit-dial-by-extension": "no",
"4-digit-dial-by-extension": "yes",
"5-digit-dial-by-extension": "yes",
"audio": {
"file-script-text": "Hello! Please press 1 2 or 3. "
},
"option-1": {
"destination-application": "to-user",
"destination-user": "1000",
"description": "Press 1 to go to user 1000",
}
}
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/{{domain}}/users/3008/autoattendants/Prompt_100' \
--header 'Content-Type: application/json' \
--data-raw '{
"attendant-name": "Main AA Example",
"auto-attendant": {
"no-key-press": "option-1",
"unassigned-key-press": "repeat",
"3-digit-dial-by-extension": "no",
"4-digit-dial-by-extension": "yes",
"5-digit-dial-by-extension": "yes",
"audio": {
"file-script-text": "Hello! Please press 1 2 or 3. "
},
"option-1": {
"destination-application": "to-user",
"destination-user": "1000",
"description": "Press 1 to go to user 1000",
}
}
}'
Responses
🟢200OK
application/json
Body
attendant-name
stringÂ
required
user
stringÂ
required
time-frame
stringÂ
optional
starting-prompt
stringÂ
optional
auto-attendant
object (AutoAttendantTier)Â
optional
intro-greetings
stringÂ
optional
audio
objectÂ
optional
unassigned-key-press
enum<string>Â
optional
Allowed values:
repeathangupoption-1option-2option-3option-4option-5option-6option-7option-8option-9option-0option-*option-#
Default:
repeat
no-key-press
enum<string>Â
optional
Allowed values:
repeathangupoption-1option-2option-3option-4option-5option-6option-7option-8option-9option-0option-*option-#
Default:
repeat
3-digit-dial-by-extension
enum<string>Â
optional
Allowed values:
yesno
Default:
yes
4-digit-dial-by-extension
enum<string>Â
optional
Allowed values:
yesno
Default:
yes
5-digit-dial-by-extension
enum<string>Â
optional
Allowed values:
yesno
Default:
yes
option-1
object (AutoAttendantTierOption)Â
optional
option-2
object (AutoAttendantTierOption)Â
optional
option-3
object (AutoAttendantTierOption)Â
optional
option-4
object (AutoAttendantTierOption)Â
optional
option-5
object (AutoAttendantTierOption)Â
optional
option-6
object (AutoAttendantTierOption)Â
optional
option-7
object (AutoAttendantTierOption)Â
optional
option-8
object (AutoAttendantTierOption)Â
optional
option-9
object (AutoAttendantTierOption)Â
optional
option-0
object (AutoAttendantTierOption)Â
optional
option-*
object (AutoAttendantTierOption)Â
optional
Example
{
"attendant-name": "Main AA Example",
"user": "3008",
"starting-prompt": "Prompt_100",
"time-frame": "*",
"audio": {
"filename": "greeting-100.wav",
"ordinal-order": 100,
"file-duration-seconds": 3,
"file-size-kilobytes": "22.74 KB",
"created-datetime": "2023-09-18 21:48:43",
"file-access-url ": "https://vb.netsapiens.com/ns-api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=87683b37a074545aebb0f5eb9ea45f6d&file=greeting-100.wav",
"file-script-text": "Hello! Please press 1 2 or 3. ",
"file-source": "",
"text-to-speech-voice-id": "en-US-Wavenet-C",
"text-to-speech-language": "en-US"
},
"auto-attendant": {
"3-digit-dial-by-extension": "no",
"4-digit-dial-by-extension": "yes",
"5-digit-dial-by-extension": "yes",
"no-key-press": "option-1",
"unassigned-key-press": "repeat",
"option-1": {
"description": "API AA Builder: Press 1 to go to user 1000",
"destination-application": "to-user",
"destination-user": "1000"
},
"option-2": {
"description": "API AA Builder: Press 2 to go to user 1001",
"destination-application": "to-user",
"destination-user": "1001"
},
"option-3": {
"description": "API AA Builder: Press 3 to go to queue 1001",
"destination-application": "to-callqueue",
"destination-user": "2000"
},
"option-4": {
"description": "API AA Builder: Press 4 to go to queue 1001",
"destination-application": "to-callqueue",
"destination-user": "2001"
},
"option-5": {
"description": "API AA Builder: Press 4 to go to queue 1001",
"auto-attendant": {
"3-digit-dial-by-extension": "yes",
"4-digit-dial-by-extension": "no",
"5-digit-dial-by-extension": "no",
"no-key-press": "repeat",
"unassigned-key-press": "option-3",
"option-1": {
"description": "API AA Builder: Press 1 to go to user 1000",
"destination-application": "to-user",
"destination-user": "1000"
},
"option-2": {
"description": "API AA Builder: Press 2 to go to user 1001",
"destination-application": "to-user",
"destination-user": "2003"
},
"option-3": {
"description": "API AA Builder: Press 3 to go to user 1001",
"auto-attendant": {
"3-digit-dial-by-extension": "no",
"4-digit-dial-by-extension": "no",
"5-digit-dial-by-extension": "no",
"no-key-press": "",
"unassigned-key-press": "",
"option-3": {
"description": "API AA Builder: Press 3 to go to user 1001",
"destination-application": "to-user",
"destination-user": "1001"
}
},
"audio": {
"filename": "greeting-108.wav",
"ordinal-order": 108,
"file-duration-seconds": 3,
"file-size-kilobytes": "25.37 KB",
"created-datetime": "2023-09-18 21:48:53",
"file-access-url ": "https://vb.netsapiens.com/ns-api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=d66d443f35fbaae62537267eeebfaa44&file=greeting-108.wav",
"file-script-text": "This is a third tier message. Press some digits. ",
"file-source": "",
"text-to-speech-voice-id": "en-US-Wavenet-C",
"text-to-speech-language": "en-US"
}
}
},
"audio": {
"filename": "greeting-105.wav",
"ordinal-order": 105,
"file-duration-seconds": 3,
"file-size-kilobytes": "25.56 KB",
"created-datetime": "2023-09-18 21:48:50",
"file-access-url ": "https://vb.netsapiens.com/ns-api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=9aa4e65d79cb0455428c04385a456f4e&file=greeting-105.wav",
"file-script-text": "This is a second tier message. Press some digits. ",
"file-source": "",
"text-to-speech-voice-id": "en-US-Wavenet-C",
"text-to-speech-language": "en-US"
}
},
"option-6": {
"description": "API AA Builder: Press 6 to go to queue 1001",
"auto-attendant": {
"3-digit-dial-by-extension": "no",
"4-digit-dial-by-extension": "no",
"5-digit-dial-by-extension": "no",
"no-key-press": "",
"unassigned-key-press": "",
"option-1": {
"description": "API AA Builder: Press 1 to go to user 1000",
"destination-application": "to-user",
"destination-user": "1000"
}
},
"audio": {
"filename": "greeting-106.wav",
"ordinal-order": 106,
"file-duration-seconds": 4,
"file-size-kilobytes": "28.37 KB",
"created-datetime": "2023-09-18 21:48:58",
"file-access-url ": "https://vb.netsapiens.com/ns-api/?object=audio&action=play&domain=apidog.ApiReseller&user=3008&type=greeting&time=20230919034530&auth=6a9f228f27140d3a336a9ff262e0c222&file=greeting-106.wav",
"file-script-text": "This is a second second tier message. Press some digits. ",
"file-source": "",
"text-to-speech-voice-id": "en-US-Wavenet-C",
"text-to-speech-language": "en-US"
}
}
}
}
🟠404Record not found
🟠400Bad Request
🟠401Authentication Required
Modified at 2023-12-21 20:52:14