JSON API » ivrs » ivrs/destinations/get

Gets the fields of 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 get. "0" to "9", "*", and "#" for keys, "t" for timeout.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The IVR menu does not exist, or you do not have permission to view it.

Data returned

Fields of IVR menu destination.

Example: With required parameters

http://enswitch.example.com/api/json/ivrs/destinations/get/?auth_username=user;auth_password=password;ivr=123;name=1

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "ivr":1, "name":"1", ... } }

Change history

VersionChanges
3.13Function added.