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.
CallFire-API-Documentation
BroadcastService
A Broadcast consists of a configuration for the outbound call or text experience, a set of recipient contacts organized into contact batches, and an optional schedule of dates and times at which the broadcast should automatically start and stop.
The Call Service and Text Service provide convenience methods that encapsulate the creation, population and starting of broadcasts. The Broadcast Service is only required for advanced use cases involving delayed or scheduled starts, multiple contact batches, or changing configurations over time.
SubscriptionService
CallFire account events, such as TextSent
or CallFinished
, can be listened for (subscribed to) by
registering a postback URI endpoint, either an email address or web service URL, that CallFire can publish
the event info to. Subscription service is used for registering and managing these postback URI endpoints.
A typical use case would be for determining the status of a SendText
request which is an asynchronous operation.
The status of the Text can be obtained either by polling the GetText / QueryText operations (pull strategy) or
more efficiently by registering with Subscription Service a postback internet endpoint URL for receiving
'textsent' and 'textfinished' events to.
Currently supports TextSent, TextFinished, CallFinished, and CampaignFinished events.
TextService
Operations for sending and receiving text messages and managing auto-replies
Text Broadcast Guide
The operations defined here should be preferred over BroadcastService methods when appropriate
since the TextService
operations are more consise and selective in the input parameters.
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.
CccService
The operations defined here should be preferred over BroadcastService methods when appropriate
since the CccService
operations are more consise and selective in the input parameters.
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.
LabelService
Labels allow you to organize broadcasts, numbers, calls and texts into groups that
make sense for your application. Attach labels to any of these objects by
using LabelNumber
or LabelBroadcast
. Labels use
name as their identifier instead of id.