AMCONFIG_AM_ONLY
AMCONFIG_AM_ONLY
QueryRegions(\CallFire\Api\Rest\Request\QueryRegions $QueryRegions)
Queries regions for use in subsequent searches and purchase requests
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.
| \CallFire\Api\Rest\Request\QueryRegions | $QueryRegions | = null |
QueryNumbers(\CallFire\Api\Rest\Request\QueryNumbers $QueryNumbers)
Lists numbers owned by your account
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...
| \CallFire\Api\Rest\Request\QueryNumbers | $QueryNumbers | = null |
GetNumber(\CallFire\Api\Rest\Request\GetNumber $GetNumber)
Get information about a single number owned by your account
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...
| \CallFire\Api\Rest\Request\GetNumber | $GetNumber | = null |
ConfigureNumber(int $Id, \CallFire\Api\Rest\Request\ConfigureNumber $ConfigureNumber)
Configure a number owned by your account
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.
| int | $Id | |
| \CallFire\Api\Rest\Request\ConfigureNumber | $ConfigureNumber |
SearchAvailableNumbers(\CallFire\Api\Rest\Request\SearchAvailableNumbers $SearchAvailableNumbers)
Search for new numbers that are available for purchase
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.
| \CallFire\Api\Rest\Request\SearchAvailableNumbers | $SearchAvailableNumbers | = null |
QueryKeywords(\CallFire\Api\Rest\Request\QueryKeywords $QueryKeywords)
Lists keywords owned by your account
Get info such as status, lease dates, etc... on keywords owned by your account.
| \CallFire\Api\Rest\Request\QueryKeywords | $QueryKeywords | = null |
SearchAvailableKeywords(\CallFire\Api\Rest\Request\SearchAvailableKeywords $SearchAvailableKeywords)
Search for keywords available for purchase
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
| \CallFire\Api\Rest\Request\SearchAvailableKeywords | $SearchAvailableKeywords | = null |
CreateNumberOrder(\CallFire\Api\Rest\Request\CreateNumberOrder $CreateNumberOrder)
Order new numbers and/or keywords
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.
| \CallFire\Api\Rest\Request\CreateNumberOrder | $CreateNumberOrder | = null |
GetNumberOrder(int $Id)
Get the status and results of a previous order
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.
| int | $Id | Unique ID of resource |
Release(int $Id, \CallFire\Api\Rest\Request\Release $Release)
Disable auto-renew for a number or keyword
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.
| int | $Id | |
| \CallFire\Api\Rest\Request\Release | $Release |
get(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a GET request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
post(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a POST request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
put(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a PUT request against an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
delete(string $uri, \CallFire\Api\Rest\Request $request) : string
Execute a DELETE request again an API endpoint, optionally with a given Request object as parameters
| string | $uri | Endpoint URL |
| \CallFire\Api\Rest\Request | $request | = null Request object for parameters |
Response data
buildPostData(array $parameters) : string
Construct the POST fields data for a POST/PUT request, according to CallFire conventions
Reformats any array parameters to be a space-concatenated list of items. Any object parameters will be casted to a string, as possible.
| array | $parameters | POST data |
Encoded POST data
setHttp(\CallFire\Api\Rest\Http\Request $http)
| \CallFire\Api\Rest\Http\Request | $http |