MENU
CallFire - Your Message Delivered
Call Us! (877) 897-FIRE
CLOSE
  • Products
  • Pricing
  • Developers
  • Help
  • Agents
  • Log In
  • Sign Up
Call Us! (877) 897-FIRE

CallFire-API-Documentation

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
    • CreateBroadcast
    • QueryBroadcasts
    • GetBroadcast
    • UpdateBroadcast
    • GetBroadcastStats
    • ControlBroadcast
    • CreateContactBatch
    • QueryContactBatches
    • GetContactBatch
    • ControlContactBatch
    • CreateBroadcastSchedule
    • QueryBroadcastSchedule
    • GetBroadcastSchedule
    • DeleteBroadcastSchedule
  • ▶/SubscriptionService
    • CreateSubscription
    • QuerySubscriptions
    • GetSubscription
    • UpdateSubscription
    • DeleteSubscription
  • ▶/TextService
    • SendText
    • QueryTexts
    • GetText
    • CreateAutoReply
    • QueryAutoReplies
    • GetAutoReply
    • DeleteAutoReply
  • ▶/CallService
    • SendCall
    • QueryCalls
    • GetCall
    • CreateSound
    • QuerySoundMeta
    • GetSoundMeta
    • GetSoundData
    • GetRecordingData
    • SendVerificationCodeToCallerId
    • VerifyCallerId
    • GetCallerIds
  • ▶/CccService
    • GetCccCampaign
    • GetCccCampaignStats
    • CreateCccCampaign
    • QueryCccCampaigns
    • UpdateCccCampaign
    • DeleteCccCampaignTransferNumbers
    • DeleteCccCampaignQuestions
    • ControlCccCampaign
    • DeleteCccCampaign
    • GetAgent
    • QueryAgents
    • AddAgents
    • GetAgents
    • RemoveAgent
    • GetAgentGroup
    • QueryAgentGroups
    • CreateAgentGroup
    • UpdateAgentGroup
    • AddAgentGroups
    • GetAgentGroups
    • DeleteAgentGroup
    • RemoveAgentGroup
    • GetAgentSession
    • QueryAgentSessions
    • SendAgentInvites
    • GetAgentInviteUri
  • ▶/ContactService
    • QueryContacts
    • UpdateContacts
    • RemoveContacts
    • GetContact
    • GetContactHistory
    • CreateContactList
    • QueryContactLists
    • DeleteContactList
    • AddContactsToList
    • GetContactList
    • RemoveContactsFromList
    • QueryDncNumbers
    • UpdateDncNumber
    • QueryDncLists
    • CreateDncList
    • GetDncList
    • DeleteDncList
    • AddNumbersToDncList
    • RemoveNumbersFromDncList
  • ▶/NumberService
    • QueryRegions
    • QueryNumbers
    • GetNumber
    • ConfigureNumber
    • SearchAvailableNumbers
    • QueryKeywords
    • SearchAvailableKeywords
    • CreateNumberOrder
    • GetNumberOrder
    • Release
  • ▶/LabelService
    • DeleteLabel
    • QueryLabels
    • LabelBroadcast
    • UnlabelBroadcast
    • LabelNumber
    • UnlabelNumber
  • Version 1.1    >  
  • CallFire-API-Documentation

CallFire-API-Documentation

BroadcastService

Operations for creating and managing outbound call and texts broadcasts.

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

Provides operations for creating and managing CallFire subscriptions which listen for account events.

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

Sending and receiving text messages and managing auto-replies

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

Provides operations for sending calls, viewing their results, and managing sound files

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

Provides operations for creating ccc campaigns and viewing their results

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.

ContactService

Provides operations for managing contact lists
Managing Contacts

NumberService

Operations for buying and configuring numbers and keywords.

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

Operations for labeling and querying objects by label

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.

Company

  • Careers
  • Blog
  • Press

Products

  • Text Messaging
  • Call Tracking
  • Voice Broadcast
  • CallFire IVR
  • Developer API

Resources

  • Case Studies
  • Industries
  • Communications Glossary
  • Marketing Glossary
  • Area Codes
  • Labs

Help

  • FAQs
  • CallFire XML
  • Contact Us
  • Reviews
  • System Status

© Copyright 2019 CallFire Inc. All Rights Reserved

Privacy Policy / Terms / Service Policy / FTC/FCC/DNC Compliance / Sitemap


Phone +1.877.897.3473
Fax +1.310.943.0415

Msg&data rates may apply in the US. Standard message and data rates apply in Canada. To unsubscribe from any CallFire ® list simply send 'STOP' to the originating short code or contact Support.