CallFire has a new API!
We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
NumberService
Find and provision toll-free and local numbers and keywords using the number service.
To aquire a number or keyword first search for available inventory using either
SearchAvailableNumbers
or SearchAvailableKeywords
. Then
provision that asset using the CreateNumberOrder
operation.
QueryRegions
Use a know subset of info on a region to query for the full set of info on a region. Example, if you know the city you can query for phone number prefixes, rate-centers, etc... associated with that city.
QueryNumbers
Search for numbers already purchased and in your account by region info such as prefix, city, state, zipcode, rate center, etc... Returns info on the numbers in your account such as status, lease info, configuration, etc...
GetNumber
Select number, using 11 digit E.164 format, already purchased and in your account. Returns info on the number in your account such as status, lease info, configuration, etc...
ConfigureNumber
Update number configuration, such as ENABLE / DISABLE or turn call recording on, using 11 diget E.164 format to select number. No response is returned.
SearchAvailableNumbers
Find numbers available for purchase using either TollFree = true or by region info, such as prefix, city, zipcode, etc... The max count of numbers to return must also be specified.
QueryKeywords
Get info such as status, lease dates, etc... on keywords owned by your account.
SearchAvailableKeywords
Supply list of keywords to see if they are available for purchase. If keyword is available for purchase it will be returned in result. If not available then it will not be returned in result.
Once available keywords are found they can be purchase using CreateNumberOrder
CreateNumberOrder
Purchase numbers and keywords by creating a number order that includes a list of numbers, list of keywords, region info, or specifying toll-free. OrderId is returned from request.
Creating a number order is an asynchronous process. The returned orderId
can be used in a GetNumberOrder
request to see the status of
the order. However, there is no guarantee the order will be finished by
the time GetNumberOrder
is called therefore the GetNumberOrder
operation must be polled (no more than once a second) untill the order is in a
terminal state (FINISHED or ERRORED).
The recommended way to determine if an order is finished is not to poll but to use a
Postback.
See SubscriptionService
for information on registering a postback using
subscriptions.
GetNumberOrder
Returns information on the order status, cost, and assets aquired.
Since CreateNumberOrder
is an asynchronous process this
GetNumberOrder
operation may need to be polled for up to
20 seconds at a rate of no more than once a second to determine when the
order is in a terminal state of FINISHED or ERRORED. Order will be in
'PROCESSING' status untill finished.
Release
CallFire's system automatically "renews" your numbers and keywords each month and bills you accordingly. When you no longer need a number or keyword, you can easily 'Release' it and stop your recurring monthly charge.
Once you release a keyword, you will not be able to repurchase it for a month after the release becomes effective. For example, if your keyword is slated to auto-renew for another month on April 29th, and you release it on April 15th, you will still be able to use it until April 29th. However, you will not be able to repurchase it until May 29th. Therefore, please be sure of your decision before releasing.