JSON API » addresses » addresses/update

Updates an existing SIP address.

Input parameters

Requires authentication and the addresses role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of SIP address to update.	Yes
user	String	User part of address.	No	Current value.
domain	String	Domain part of address.	No	Current value.
dtype	String	Destination type.	No	Current value.
dnumber	String	Destination number.	No	Current value.
callerid	String	Callerid to force.	No	Current value.
description	String	Description.	No	Current value.
language	Language	Language to set. Empty string for default.	No	Current value.
maximum_seconds	Integer	Maximum seconds to let call run for. 0 for no limit.	No	Current value.
music	Integer	ID of music to use. 0 for default.	No	Current value.
owner	Integer	ID of owner. 0 for none.	No	Current value.
panel	Integer	1 to show in control panel, 0 not to.	No	Current value.
recordgroup	Integer	ID of record group. 0 for none.	No	Current value.
screen	Integer	1 to play the callerid, 2 to ask the caller to record their name, 0 not to screen.	No	Current value.
sname	String	Caller name to force.	No	Current value.
sname_action	String	"append" to append to the caller name, "prepend" to prepend to it, "replace" to replace it.	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 SIP address does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the address

http://enswitch.example.com/api/json/addresses/update/?auth_username=user;auth_password=password;id=123;user=user1;domain=example.com

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

Change history

Version	Changes
3.13	Function added.