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.
CallService
Operations for sending and receiving calls, uploading IVRs, and managing sound files.
Broadcast Guide
The operations defined here should be preferred over BroadcastService methods when appropriate
since the CallService
operations are more consise and selective in the input parameters.
SendCall
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...
QueryCalls
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.
GetCall
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.
CreateSound
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.
QuerySoundMeta
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
.
GetSoundMeta
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
.
GetSoundData
Returns the raw binary data in specified format from specified sound. If no format is specified will return MP3 data.
GetRecordingData
Recording from calls can be retrieved here using CallId / Name pair. Sounds may be given a name, unique within a call, in the IVR using the record tag and varname attribute. This allows them to be requested by name in this API.
SendVerificationCodeToCallerId
Creating broadcasts requires a verified callerId (FromNumber) as one of
the mandatory parameters. This api method along with VerifyCallerIdRequest
can be used to verify a callerId that can be used in subsequent create broadcast requests.
VerifyCallerId
Verifying a callerId is a two step process. First a verification code must
be sent to callerId SendVerificationCodeToCallerId
. Then the
verificationCode sent to callerId must be entered here to mark callerId
as verified.
GetCallerIds
Creating broadcasts requires verified callerId as FromNumber
.
This method returns the list of callerId numbers that have been verified
and can be used to create broadcasts. See
SendVerificationCodeToCallerId
and VerifyCallerIdRequest
for instructions on how to verify
a callerId.