CallFire API Documentation

Tools (124)

Extracted live via the executor SDK.

• calls.addCallBroadcastBatch

  The 'add batch' API allows user to add additional batches to an already created voice broadcast campaign. The added batch will go through the CallFire validation process, unlike in the recipients version of this API. That is why you can use the scrubDuplicates flag to remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers

• calls.addCallBroadcastRecipients

  Use this API to add the recipients to an existing voice broadcast. Post a list of Recipient objects to be added to the voice broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers

• calls.archiveVoiceBroadcast

  Archives a voice broadcast (voice broadcast will be hidden in search results)

• calls.createCallBroadcast

  Creates a call broadcast campaign using the Call Broadcast API. Send a CallBroadcast in the message body to add details in a voice broadcast campaign. The campaign can be created without contacts and bare minimum configuration, but contacts will have to be added further on to use the campaign

• calls.findCallBroadcasts

  Searches for all voice broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of voice broadcasts

• calls.findCalls

  To search for all calls sent or received by the user. Use "id=0" for the campaignId parameter to query for all calls sent through the POST /calls API. See call states and results

• calls.getCall

  Returns a single Call instance for a given call id.

• calls.getCallBroadcast

  Returns a single CallBroadcast instance for a given call broadcast campaign id

• calls.getCallBroadcastBatches

  This endpoint will enable the user to page through all of the batches for a particular voice broadcast campaign

• calls.getCallBroadcastCalls

  This endpoint will enable the user to page through all calls for a particular call broadcast campaign

• calls.getCallBroadcastStats

  Returns broadcast statistics like total number of sent/received actions, total cost, number of remaining outbound actions, error count, etc

• calls.getCallRecording

  Returns metadata of recording of a particular call. Metadata contains a link to a MP3 recording

• calls.getCallRecordingByName

  Returns recording metadata of particular call. Metadata contains link to a MP3 recording

• calls.getCallRecordingMp3

  Returns an MP3 recording of particular call, response contains binary data, content type is 'audio/mpeg'

• calls.getCallRecordingMp3ByName

  Returns a MP3 recording of a particular call, response contains binary data, content type is 'audio/mpeg'

• calls.getCallRecordings

  Returns a list of recordings metadata of particular call. Metadata contains link to a MP3 recording

• calls.sendCalls

  Use the /calls API to send individual calls quickly. A verified Caller ID and sufficient credits are required to make a call. CallRecipient represents a single recipient identified by phone number or contact id in CallFire system. You can attach user-defined attributes to a Call action via CallRecipient.attributes property, attributes are available in Call action response

• calls.startVoiceBroadcast

  Start a voice broadcast

• calls.stopVoiceBroadcast

  Stop a voice broadcast

• calls.toggleCallBroadcastRecipientsStatus

  This operation lets the user to disable/enable undialed recipients in created broadcast

• calls.updateCallBroadcast

  This operation lets the user modify the configuration of a voice broadcast campaign after call broadcast campaign is created. See CallBroadcast for more information on what can/can't be updated on this API

• campaigns.deleteCampaignSound

  Deletes a single campaign sound instance for a specific campaign sound id, this operation does not delete sound completely, it sets sound status to ARCHIVED which means that sound will no longer appear in 'find' operation results, but still accessible via 'get' operation

• campaigns.findCampaignSounds

  To find all campaign sounds which were created by user. Returns all sounds available to be used in campaigns

• campaigns.getCampaignBatch

  Returns a single Batch instance for a given batch id. This API is useful for determining the state of a validating batch

• campaigns.getCampaignSound

  Returns a single CampaignSound instance for a given sound id in campaign. This is a meta data to the sounds. No audio data is returned from this API

• campaigns.getCampaignSoundDataMp3

  Download the MP3 version of a hosted file. This is an audio data endpoint. Returns binary response of the 'audio/mpeg' content type

• campaigns.getCampaignSoundDataWav

  Download the WAV version of the hosted file. This is an audio data endpoint. Returns binary response of the 'audio/mpeg' content type

• campaigns.postCallCampaignSound

  Use this API to create a sound via a phone call. Provide the required phone number in the CallCreateSound object inside the request, and user will receive a call shortly after with instructions on how to record a sound over the phone.

• campaigns.postFileCampaignSound

  Create a campaign sound file via a supplied .mp3 or .wav file

• campaigns.postTtsCampaignSound

  Use this API to create a sound file via a supplied string of text. Add a text in the TextToSpeech.message field, and pick a voice in the TextToSpeech.voice field. Available voices are: MALE1, FEMALE1, FEMALE2, SPANISH1, FRENCHCANADIAN1

• campaigns.updateCampaignBatch

  Updates a single Batch instance, currently batch can only be turned "on/off"

• contacts.addContactListItems

  Adds contacts to a contact list. Available contact sources are: list of the contact entities, list of ids of existing contacts in user's account, list of phone numbers in E.164 format (11-digits)

• contacts.addDoNotContacts

  Add or update a list of Do Not Contact (DNC) contact entries. Can toggle whether the DNCs are enabled for calls/texts.

• contacts.createContactList

  Creates a contact list for use with campaigns using 1 of 3 inputs. A List of Contact objects, a list of String E.164 numbers, or a list of CallFire contactIds can be used as the data source for the created contact list. After contact list is added into the CallFire system, contact lists goes through seven system safeguards that check the accuracy and consistency of the data. For example, our system checks that contact number is formatted correctly, is valid, is not duplicated in another contact list, or is not added on a specific DNC list. You can configure to keep/merge or remove contacts which do not complies these rules. If contacts were not added to a contact list after the validation, this means the data needs to be properly formatted and corrected before calling this API

• contacts.createContactListFromFile

  Creates a contact list to be used with campaigns through uploading a .csv file. Returns the id of created list

• contacts.createContacts

  Creates contacts in CallFire system. Only values from the next list can be used as external system parameter in contact creation: NATION_BUILDER, SALES_FORCE_CONTACTS, SALES_FORCE_LEADS, SALES_FORCE_REPORTS, ZOHO, MAIL_CHIMP. See contacts validation rules

• contacts.deleteContact

  Deletes a contact instance from account

• contacts.deleteContactList

  Deletes a contact list, included contacts will not be deleted.

• contacts.deleteDoNotContact

  Delete a Do Not Contact (DNC) contact entry.

• contacts.deleteDoNotContactsBySource

  Delete Do Not Contact (DNC) contact entries contained in source.

• contacts.findContactLists

  Searches for all contact lists which are available for the current user. Returns a paged list of contact lists

• contacts.findContacts

  Find user's contacts by id, contact list, or on any property name. Returns a paged list of contacts

• contacts.findDoNotContacts

  Searches for all Do Not Contact (DNC) objects created by user. These DoNotContact entries only affect calls/texts/campaigns on this account. Returns a paged list of DoNotContact objects

• contacts.getContact

  Returns a Contact instance for a given contact id. Deleted contacts can be still retrieved but will be marked as deleted. Deleted contacts will not be shown in search request.

• contacts.getContactHistory

  Searches for all texts and calls attributed to a contact. Returns a list of calls and texts a contact has been involved with

• contacts.getContactList

  Returns a single ContactList instance for a given contact list id

• contacts.getContactListItems

  Searches for all entries in a contact list with specified id. Returns a paged list of contact entries

• contacts.getDoNotContact

  Get Do Not Contact (DNC) object create by user. This DoNotContact entry only affects calls/texts/campaigns on this account.

• contacts.getUniversalDoNotContacts

  Searches for a UniversalDoNotContact object for a given phone number. Shows whether inbound/outbound actions are allowed for a given number

• contacts.removeContactListItem

  Deletes a single contact from a contact list

• contacts.removeContactListItems

  Deletes contacts from a contact list. List the contact ids in request to delete multiple contacts with one request.

• contacts.updateContact

  Updates a single contact instance with id specified. See contact validation rules

• contacts.updateContactList

  Updates contact list instance.

• contacts.updateDoNotContact

  Update a Do Not Contact (DNC) contact entry. Can toggle whether the DNC is enabled for calls/texts.

• keywords.findKeywordLeaseConfigs

  Searches for all keyword lease configs for the user. Returns a paged list of KeywordConfig

• keywords.findKeywordLeases

  Searches for all keywords owned by user. A keyword lease is the ownership information involving a keyword

• keywords.findKeywords

  Searches for all keywords available for purchase on the CallFire platform. If a keyword appears in the response, it is available for purchase. List the 'keywords' in a query parameter to search for multiple keywords (at least one keyword should be sent in request). Keyword should only consist of uppercase and lowercase letters and numbers. Number of characters must be greater than 2, but less than 65.

• keywords.getKeywordLease

  Searches for all keywords owned by user

• keywords.getKeywordLeaseById

  Get keyword by id

• keywords.getKeywordLeaseConfig

  Returns a single KeywordConfig instance for a given keyword lease

• keywords.isKeywordAvailable

  Searches for the specific keyword to purchase on the CallFire platform. Returns 'true' if keyword is available. Keyword should only consist of uppercase and lowercase letters and numbers. Number of characters must be greater than 2, but less than 65.

• keywords.updateKeywordLease

  Updates a keyword lease. Turns the autoRenew on/off. Configure double opt in feature. Add/remove contact list from keyword.

• keywords.updateKeywordLeaseConfig

  Updates a keyword lease configuration. Use this API endpoint to enable/disable inbound SMS forwarding, set forward number. Forward number must be in E.164 format)

• me.createApiCredential

  Creates an API credentials for the CallFire API. This endpoint requires full CallFire account credentials to be used, authenticated using Basic Authentication. At the moment user provides only the name for the credentials. The generated credentials can be used to access any CallFire APIs. For authentication use account credentials.

• me.deleteApiCredential

  Deletes a specified API credential. Currently, removes the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.

• me.disableApiCredentials

  Disables a specified API credential. Currently, removes the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.

• me.enableApiCredentials

  Enables a specified API credential. Currently, adds the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.

• me.findApiCredentials

  Searches for all credentials generated by user. Returns a paged list of the API credentials. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.

• me.getAccount

  Searches for the user account details. Details include name, email, and basic account permissions. For authentication use api credentials.

• me.getApiCredential

  Returns an API credential instance for a given api credential id. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.

• me.getBillingPlanUsage

  Searches for the data of a billing plan usage for the user. Returns the data of a billing plan usage for the current month. For authentication use api credentials.

• me.getCallerIds

  Returns a list of verified caller ids. If the number is not shown in the list, then it is not verified. In this case sending of a verification code is required. For authentication use api credentials.

• me.getCreditUsage

  Find credit usage for the user. Returns credits usage for time period specified or if unspecified then total for all time. For authentication use api credentials.

• me.sendVerificationCodeToCallerId

  Generates and sends a verification code to the phone number provided in the path. The verification code is delivered via a phone call. This code needs to be submitted to the verify caller id API endpoint to complete verification. For authentication use api credentials.

• me.verifyCallerId

  With the verification code received from the Create caller id endpoint, a call to this endpoint is required to finish verification. For authentication use api credentials.

• media.createMedia

  Uploads media file to account, acceptable media formats: bmp, gif, jpg, m4a, mp3, mp4, png, wav

• media.findMedia

  Find media files created by user

• media.getMedia

  Get media resource by id

• media.getMediaData

  Download a media file. Available types of files: bmp, gif, jpg, m4a, mp3, mp4, png, wav. Content type in response depends on 'extension' parameter, e.g. image/jpeg, image/png, audio/mp3, etc

• media.getMediaDataBinary

  Download a MP3 media, endpoint returns application/binary content-type

• media.getMediaDataByKey

  Download a media file. Available types of files: bmp, gif, jpg, m4a, mp3, mp4, png, wav. Content type in response depends on 'extension' parameter, e.g. image/jpeg, image/png, audio/mp3, etc

• numbers.findNumberLeaseConfigs

  Searches for all number lease configs for the user. Returns a paged list of NumberConfig

• numbers.findNumberLeases

  Searches for all numbers leased by account user. This API is useful for finding all numbers currently owned by the user. Returns a paged list of number leases.

• numbers.findNumberRegions

  Searches for region information. Use this API to obtain detailed region information that can be used to query for more specific phone numbers than a general query.

• numbers.findNumbersLocal

  Searches for numbers available for purchase in CallFire local numbers catalog . At least one additional parameter is required. User may filter local numbers by their region information. If all numbers with desirable zip code is already busy search will return available numbers with nearest zip code.

• numbers.findNumbersTollfree

  Searches for the toll free numbers which are available for purchase in the CallFire catalog

• numbers.getNumberLease

  Returns a single NumberLease instance for a given number

• numbers.getNumberLeaseConfig

  Returns a single NumberConfig instance for a given number lease

• numbers.updateNumberLease

  Updates a number lease instance. Ability to turn on/off autoRenew and toggle call/text features for a particular number

• numbers.updateNumberLeaseConfig

  Updates a phone number lease configuration. Use this API endpoint to add an Inbound IVR or Call Tracking feature to a CallFire phone number. Call tracking configuration allows you to track the incoming calls, to analyze and to respond customers using sms or voice replies. For more information see call tracking page

• orders.findOrders

  Searches for account orders

• orders.getOrder

  Returns a single NumberOrder instance for a given order id. Order contains information about purchased keywords, local, toll-free numbers

• orders.orderKeywords

  Purchase keywords. Send a list of available keywords into this API to purchase them using CallFire credits. Make sure the account has enough credits before trying to purchase the keywords. Keyword should only consist of uppercase and lowercase letters and numbers. Number of characters must be greater than 2, but less than 65.

• orders.orderNumbers

  Purchase numbers. There are many ways to purchase a number. Set either 'tollFreeCount' or 'localCount' along with some querying fields to purchase numbers by bulk query. Set the list of numbers to purchase by list. Available numbers will be purchased using CallFire credits owned by the user. Make sure the account has enough credits before trying to purchase

• reports.getDeliveryReports

  Get delivery reports

• texts.addTextBroadcastBatch

  Allows adding an extra batches to an already created text broadcast campaign. The batches which being added pass the CallFire validation process (unlike in the recipients version of this API). That is why using of a scrubDuplicates flag remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers

• texts.addTextBroadcastRecipients

  Use this API to add recipients to a text broadcast which is already created. Post a list of Recipient objects to be immediately added to the text broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers

• texts.archiveTextBroadcast

  Archives a text broadcast (and hides it in the search results)

• texts.createTextAutoReply

  CallFire gives you possibility to set up auto reply messages for your numbers and keywords. You can set a general auto reply for anyone who texts your number, keyword, and/or include a text to match, so that the auto reply would be sent only to those who text the matched text

• texts.createTextBroadcast

  Creates a text broadcast campaign using the Text Broadcast API. Send a TextBroadcast object in the message body to detail a text broadcast campaign. A campaign can be created without contacts and with bare minimum configuration, but contacts have to be added further on to use the campaign. It supports scheduling, retry logic, pattern-based messages.

• texts.deleteTextAutoReply

  Deletes a text auto reply and removes the configuration. Can not delete a TextAutoReply which is currently active for a campaign

• texts.findTextAutoReplys

  Find all text autoreplies created by user. Returns a paged list of TextAutoReply

• texts.findTextBroadcasts

  Searches for all text broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of text broadcasts

• texts.findTexts

  Searches for texts sent or received by user. Use "campaignId=0" parameter to query for all texts sent through the POST /texts API. See call states and results

• texts.getText

  Returns a single Text instance for a given text id

• texts.getTextAutoReply

  Returns a single TextAutoReply instance for a given text auto reply id

• texts.getTextBroadcast

  Returns a single TextBroadcast instance for a given text broadcast id

• texts.getTextBroadcastBatches

  This endpoint will enable the user to page through all of the batches for a particular text broadcast campaign

• texts.getTextBroadcastStats

  Returns the broadcast statistics. Example: total number of the sent/received actions, total cost, number of remaining outbound actions, error count, etc

• texts.getTextBroadcastTexts

  This endpoint will enable the user to page through all of the texts for a particular text broadcast campaign

• texts.sendTexts

  Use the /texts API to send individual texts quickly. By default all texts are going out from CallFire's dedicated short code. Example: 67076, 818818 etc

• texts.startTextBroadcast

  Starts a text broadcast

• texts.stopTextBroadcast

  Stops a text broadcast

• texts.toggleTextBroadcastRecipientsStatus

  This operation lets the user to disable/enable undialed contacts in created broadcast

• texts.updateTextBroadcast

  Allows modifying the configuration of existing text broadcast campaign. See TextBroadcast for more information on what can/can't be updated on this API

• webhooks.createWebhook

  Create a Webhook for notification in the CallFire system. Use the webhooks API to receive notifications of important CallFire events. Select the resource to listen to, and then choose the resource events to receive notifications on. When an event triggers, a POST will be made to the callback URL with a payload of notification information. Available resources and their events include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], 'InboundCall': ['finished'], 'OutboundText': ['finished'], 'InboundText': ['finished'], 'ContactList': ['validationFinished', 'validationFailed'], 'MonthlyRenewal': ['failed', 'finished'], 'LowBalance': ['failed', 'finished']. Webhooks support secret token which is used as signing key to HmacSHA1 hash of json payload which is returned in 'X-CallFire-Signature' header. This header can be used to verify callback POST is coming from CallFire. See security guide

• webhooks.deleteWebhook

  Deletes a webhook instance. Will be removed permanently

• webhooks.findWebhookResources

  Searches for webhook resources. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], 'InboundCall': ['finished'], 'OutboundText': ['finished'], 'InboundText': ['finished'], 'ContactList': ['validationFinished', 'validationFailed'], 'MonthlyRenewal': ['failed', 'finished'], 'LowBalance': ['failed', 'finished']

• webhooks.findWebhooks

  Searches all webhooks available for a current user. Searches by name, resource, event, callback URL, or whether they are enabled. Returns a paged list of Webhooks

• webhooks.getWebhook

  Returns a single Webhook instance for a given webhook id

• webhooks.getWebhookResource

  Returns information about supported events for a given webhook resource

• webhooks.updateWebhook

  Updates the information in existing webhook

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools