JSON API » numbers » numbers/callers/update

Updates an existing number caller route.

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
id	Integer	ID of number caller route to update.	Yes
caller_number	String	Prefix of the callerid to match.	No	Current value.
description	String	Description.	No	Current value.
dtype	String	Destination type.	No	Current value.
dnumber	String	Destination number.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.
404	The 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

Version	Changes
3.13	Function added.