JSON API » codes » codes/callers/list
Gets the fields of all caller routes for a feature code.
Input parameters
Requires authentication and the administrator, user, or wholesale role privileges.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
code | String | Feature code. | Yes | |
customer | Integer | ID of customer owning feature code. | No | Customer of authentication user. |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The feature code does not exist, or you do not have permission to view it. |
Data returned
An array of fields, corresponding to the caller routes.
Example: With required parameters
http://enswitch.example.com/api/json/codes/callers/list/?auth_username=user;auth_password=password;code=100{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "code":"100", ... }, { "id":2, "code":"100", ... } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |