JSON API » numbers » numbers/available/get

Gets the fields of a number available to purchase.

Input parameters

Does not require authentication.

NameTypeDescriptionRequiredDefault value
numberStringNumber to get.Yes
portIntegerNumber is being ported in.No0

Responses

CodeDescription
200The number exists and is available for purchase, or can be automatically created on purchase.
400The number exists, but is already in use.
404The 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

VersionChanges
3.13Function added.