Provisioning numbers is easy with the CallFire REST API! Find Toll-Free and Local Numbers.
- Jump to Method
- Search Phone Numbers
- Purchase Phone Numbers
Methods
Search Phone Numbers
URL
https://www.callfire.com/cloud/1/inbound/numbers
HTTP Method
GET
Content Type
text/plain or application/x-www-form-urlencoded
Parameters
| Parameter name | Required | Description |
|---|---|---|
| apikey | Y | This is your account api key |
| npa | N | The Area Code for a Local number search |
| isTollFree | N | True if you want to search for Toll Free |
| listSize | N | The number of results to list - 50 maximum |
Example Response
The response content type can be xml or json.
| xml | |
|---|---|
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | |
| <inboundresponse> | |
| <description>Numbers Found</description> | |
| <successful>true</successful> | |
| <numbers> | |
| <entry> | |
| <key>50a77c9a-9d2f-001</key> | |
| <value>8665630000</value> | |
| </entry> | |
| <entry> | |
| <key>847a2b59-53bf-002</key> | |
| <value>8669290000</value> | |
| </entry> | |
| </numbers> | |
| </inboundresponse> | |
Purchase Phone Numbers
Provisioning numbers is easy with the CallFire REST API! Find Toll-Free and Local Numbers.
URL
https://www.callfire.com/cloud/1/inbound/numbers
HTTP Method
POST
Content Type
application/x-www-form-urlencoded
Parameters
| Parameter name | Required | Description |
|---|---|---|
| apikey | Y | The API key that is registered with your account |
| numberKey | Y | The key value of the phone number. |
| number | Y | The number that you wish to purchase |
Example Response
The response content type can be xml or json.
| xml | |
|---|---|
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | |
| <inboundresponse> | |
| <description>XXXXXXXXXX Purchased</description> | |
| <successful>true</successful> | |
| <number>XXXXXXXXXX</number> | |
| </inboundresponse> | |