JSON API » ivrs » ivrs/create

Creates a new IVR menu with default destinations.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringName.Yes
allow_numberInteger1 to allow callers to enter a feature code or telephone line, 0 not to.No0
customerIntegerID of customer to create in.NoCustomer of authentication user.
descriptionStringDescription.NoEmpty string.
panelInteger1 to show in the control panel, 0 not to.No0
passwordStringPIN to enter IVR setup menu. Empty string to disable menu.NoEmpty string.
timeoutIntegerTimeout in seconds.No5
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
200Success.
201Input passed validation. Only returned if validation=1.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your 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

VersionChanges
3.13Function added.