JSON API » numbers » numbers/available/get
Gets the fields of a number available to purchase.
Input parameters
Does not require authentication.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
number | String | Number to get. | Yes | |
port | Integer | Number is being ported in. | No | 0 |
Responses
Code | Description |
---|---|
200 | The number exists and is available for purchase, or can be automatically created on purchase. |
400 | The number exists, but is already in use. |
404 | The number does not exist and cannot be automatically created. |
Data returned
Fields of number.
Example: With required parameters
http://enswitch.example.com/api/json/numbers/available/get/?number=2125551234{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "number":"2125551234", "class":1, ... } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |