JSON API » addresses » addresses/get

Gets the fields of a SIP address.

Input parameters

Requires authentication and the addresses or user role privileges.

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 get.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The SIP address does not exist, or you do not have permission to view it.

Data returned

Fields of SIP address.

Example: With required parameters

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "user":"user1", "domain":"example.com", ... } }

Change history

Version	Changes
3.13	Function added.