AMCONFIG_AM_ONLY
AMCONFIG_AM_ONLY
SendCall(\CallFire\Api\Rest\Request\SendCall $SendCall)
Creates a call broadcast, adds numbers to it, and sends it immediately
Start sending calls using VoiceBroadcastConfig or by setting up an IVR using IvrBroadcastConfig. Sending a call requires at least a ToNumber and sound id or an IVR. The returned broadcastId can be passed to QueryCalls to get state of call actions in campaign and get list of individual callIds for use in GetCall request. The broadcastId can also be passed to GetBroadcastStats to get information about the call campaign, such as BilledAmount, Duration, State, etc...
| \CallFire\Api\Rest\Request\SendCall | $SendCall | = null |
QueryCalls(\CallFire\Api\Rest\Request\QueryCalls $QueryCalls)
Lists inbound and outbound calls
Query for calls using standard ActionQuery which filters on batchId, broadcastId, toNumber, etc... Returns a list of calls and all associated info. See GetCall to return just a single call action by id.
| \CallFire\Api\Rest\Request\QueryCalls | $QueryCalls | = null |
GetCall(int $Id)
Gets a call by ID
Return individual call action. See QueryCalls to return a list of call actions and determine individual callIds. General usage is to start a call campaign using SendCall, then to pass returned broadcastId to QueryCalls to determine callIds of call actions created. This GetCall can then be called with unique callId to determine info and state of call action.
| int | $Id | Unique ID of resource |
CreateSound(\CallFire\Api\Rest\Request\CreateSound $CreateSound)
Creates a new CallFire-hosted sound for use in calls.
There are two ways to create a sound: (1) uploading a pre-recorded WAV or MP3, or (2) initiating a call to record a sound over the phone. Duplicate uploads are not allowed. If a duplicate sound data are provided, a new sound is not created. Instead, the ID of the previous sound is returned. Recording a sound over the phone works by first creating a sound asset using the RecordingCall option, then call the ToNumber to record live voice as sound. If sound is created using RecordingCall then need to wait for sound to be active by calling GetSoundMeta until Status = 'ACTIVE'. Use the returned soundId in a subsequent SendCall request.
| \CallFire\Api\Rest\Request\CreateSound | $CreateSound | = null |
QuerySoundMeta(\CallFire\Api\Rest\Request\QuerySoundMeta $QuerySoundMeta)
Lists sounds available for use in calls.
Return list of sound meta info that includes id, status, name, length, etc... This operation only returns meta info, not the actual sound data. The raw binary sound data can be obtained from the GetSoundData.
| \CallFire\Api\Rest\Request\QuerySoundMeta | $QuerySoundMeta | = null |
GetSoundMeta(int $Id)
Gets metadata for a sound for use in calls
Return sound meta info for specified sound that includes id, status, name, length, etc... This operation only returns meta info, not the actual sound data. The raw binary sound data can be obtained from the GetSoundData.
| int | $Id | Unique ID of resource |
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 |