JSON API » addresses » addresses/create

Creates a new SIP address.

Input parameters

Requires authentication and the addresses role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
user	String	User part of address.	Yes
domain	String	Domain part of address.	Yes
dtype	String	Destination type.	Yes
dnumber	String	Destination number.	Yes
callerid	String	Callerid to force.	No	Empty string.
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
language	Language	Language to set. Empty string for default.	No	Empty string.
maximum_seconds	Integer	Maximum seconds to let call run for. 0 for no limit.	No	0
music	Integer	ID of music to use. 0 for default.	No	0
owner	Integer	ID of owner. 0 for none.	No	0
panel	Integer	1 to show in control panel, 0 not to.	No	0
recordgroup	Integer	ID of record group. 0 for none.	No	0
screen	Integer	1 to play the callerid, 2 to ask the caller to record their name, 0 not to screen.	No	0
sname	String	Caller name to force.	No	Empty string.
sname_action	String	"append" to append to the caller name, "prepend" to prepend to it, "replace" to replace it.	No	"replace"
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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.

Data returned

The ID of the created SIP address.

Example: With required parameters

http://enswitch.example.com/api/json/addresses/create/?auth_username=user;auth_password=password;user=user1;domain=example.com;dtype=phone;dnumber=1234567

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

Change history

Version	Changes
3.13	Function added.