Creates a new IVR. You can use the result of GET /ivrs/:id as a template

Field

Description

id

OPTIONAL to edit a IVR

audio_files

Shows the SoundFile id for each audio setting.

maximum_ringing_time

Maximum Wait Time (in seconds)
Time during which the call will ring before going to voicemail, call queue, or being forwarded.

accept_voicemails

Turn this option on if you want to be able to receive voicemails.

no_answer_external_phone_number

If no answer, forward the call to an external phone number
Turn this option on if you want to forward the calls to a specific phone number, when nobody's available to answer.

outside_office_hours_external_phone_number

If a call comes outside office hours, forward it to an external phone number
Turn this option on if you want to forward inbound calls outside office hours to a specific phone number.

call_queue_enabled

Enable Call Queue
Turns on the call queueing feature, required when your customers need to wait in line until an agent becomes available.

call_queue_maximun_wait_time

Maximum Wait Time (in seconds)
In the call queue, amount of time the caller can remain waiting before being asked to leave a voicemail, or the call to be forwarded

call_queue_on_no_answer

If there are available agents and still there's no answer, send call to queue
If there's no answer send the caller to the call queue, instead of sending it to voicemail or forwarding it directly.

extension_dialing_enabled

Enable extension dialing
Turn this option on if you want your agents to be reachable via a direct personal extension number. Go to Agent Screen to setup individual extension numbers.

options

There's one option for each digit you can configure and one for the default option (When no digit is pressed).

Options description

Action

Value

send_to_agent

Agent email address

send_to_agent_group

Agent group ID

send_to_voicemail

No value necessary

play_audio_repeat_greeting

SoundFile ID

send_to_number

Phone Number to witch send the call.

receive_fax_and_notify

Comma separated email addresses

repeat_greeting

No value necessary

hangup

No value necessary

return_to_previous_menu

No value necessary

send_to_ivr

Child IVR ID

Language
Authentication
Query
Click Try It! to start a request and see the response here!