JSON API » ivrs » ivrs/create

Creates a new IVR menu with default destinations.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name.	Yes
allow_number	Integer	1 to allow callers to enter a feature code or telephone line, 0 not to.	No	0
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
panel	Integer	1 to show in the control panel, 0 not to.	No	0
password	String	PIN to enter IVR setup menu. Empty string to disable menu.	No	Empty string.
timeout	Integer	Timeout in seconds.	No	5
speech_reco	Integer	1 to enable speech recognition, 0 not to. Must be allowed by rate plan.	No	0
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.

Data returned

The ID of the created IVR menu.

Example: With required parameters

http://enswitch.example.com/api/json/ivrs/create/?auth_username=user;auth_password=password;name=example

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
4.1	speech_reco parameter added.
3.13	Function added.