JSON API » numbers » numbers/callers/update

Updates an existing 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 update.Yes
caller_numberStringPrefix of the callerid to match.NoCurrent value.
descriptionStringDescription.NoCurrent value.
dtypeStringDestination type.NoCurrent value.
dnumberStringDestination number.NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your rate plan does not allow this.
404The number or caller route does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the destination

http://enswitch.example.com/api/json/numbers/callers/update/?auth_username=user;auth_password=password;id=123;dtype=phone;dnumber=1234567

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.13Function added.