JSON API » ivrs » ivrs/destinations/set

Sets an IVR menu destination.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
ivrIntegerID of IVR menu.Yes
nameStringName of destination to set. "0" to "9", "*", and "#" for keys, "t" for timeout.Yes
dtypeStringDestination type.Yes
dnumberStringDestination number.Yes
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
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.
404The 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

VersionChanges
3.13Function added.