JSON API » ivrs » ivrs/destinations/set

Sets an IVR menu destination.

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
ivr	Integer	ID of IVR menu.	Yes
name	String	Name of destination to set. "0" to "9", "*", and "#" for keys, "t" for timeout.	Yes
dtype	String	Destination type.	Yes
dnumber	String	Destination number.	Yes
speech_text	String	Speech recognition words to match..	No	Empty string.
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: With required parameters

http://enswitch.example.com/api/json/ivrs/destinations/set/?auth_username=user;auth_password=password;ivr=123;name=1;dtype=phone;dnumber=1234567

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

Change history

Version	Changes
4.1	speech_text parameter added.
3.13	Function added.