JSON API » ivrs » ivrs/update

Updates an existing IVR menu.

Input parameters

Requires authentication and the administrator or wholesale role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of IVR menu to update.	Yes
allow_number	Integer	1 to allow callers to enter a feature code or telephone line, 0 not to.	No	Current value.
description	String	Description.	No	Current value.
name	String	Name.	No	Current value.
panel	Integer	1 to show in the control panel, 0 not to.	No	Current value.
password	String	PIN to enter IVR setup menu. Empty string to disable menu.	No	Current value.
timeout	Integer	Timeout in seconds.	No	Current value.
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
201	Input passed validation. Only returned if validation=1.
204	Success.
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.
404	The IVR menu does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

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

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.1	speech_reco parameter added.
3.13	Function added.