JSON API » numbers » numbers/get

Gets the fields of a number.

Input parameters

Authentication and the user role privilege is optional. If not provided, only unassigned numbers will be returned.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	No	None.
auth_password	String	Authentication password.	No	None.
number	String	Number to get.	Yes

Responses

Code	Description
200	Success.
404	The number does not exist, or you do not have permission to view it.

Data returned

Fields of number.

Example: With required parameters

http://enswitch.example.com/api/json/numbers/get/?auth_username=user;auth_password=password;number=2125551234

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "number":"2125551234", "description":"example", ... } }

Change history

Version	Changes
3.13	Function added.