JSON API » ivrs » ivrs/destinations/get
Gets the fields of 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 get. "0" to "9", "*", and "#" for keys, "t" for timeout. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The 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
Version | Changes |
---|---|
3.13 | Function added. |