JSON API » numbers » numbers/callers/get

Gets the fields of a number caller route.

Input parameters

Requires authentication and the administrator, user, or wholesale role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of number caller route to get.Yes

Responses

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

Data returned

Fields of number caller route.

Example: With required parameters

http://enswitch.example.com/api/json/numbers/callers/get/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "number":"2125551234", ... } }

Change history

VersionChanges
3.13Function added.