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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
codeStringFeature code.Yes
customerIntegerID of customer owning feature code.NoCustomer of authentication user.

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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

VersionChanges
3.13Function added.