actionPOSTv1.0.0
Add contacts to a contact list
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)
actionPOSTv1.0.0
Add do not contact (dnc) numbers
Add or update a list of Do Not Contact (DNC) contact entries. Can toggle whether the DNCs are enabled for calls/texts.
actionPOSTv1.0.0
Add recipients to a call broadcast
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
actionPOSTv1.0.0
Add recipients to a text broadcast
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
actionPOSTv1.0.0
Add sound via call
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.
actionPOSTv1.0.0
Add sound via file
Create a campaign sound file via a supplied .mp3 or .wav file
actionPOSTv1.0.0
Add sound via text-to-speech
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
actionPOSTv1.0.0
Archive text broadcast
Archives a text broadcast (and hides it in the search results)
actionPOSTv1.0.0
Archive voice broadcast
Archives a voice broadcast (voice broadcast will be hidden in search results)
actionGETv1.0.0
Check for a specific keyword
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.
actionPOSTv1.0.0
Create a call broadcast
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
actionPOSTv1.0.0
Create a caller id
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.
actionPOSTv1.0.0
Create a text broadcast
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.
actionPOSTv1.0.0
Create an auto reply
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
actionPOSTv1.0.0
Create api credentials
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.
actionPOSTv1.0.0
Create contact list from file
Creates a contact list to be used with campaigns through uploading a .csv file. Returns the id of created list
actionPOSTv1.0.0
Create contact lists
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
actionPOSTv1.0.0
Create contacts
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](https://www.callfire.com/help/docs/getting-started/managing-contacts/validating-contacts#section1)
actionPOSTv1.0.0
Create media
Uploads media file to account, acceptable media formats: bmp, gif, jpg, m4a, mp3, mp4, png, wav
actionDELETEv1.0.0
Delete a contact
Deletes a contact instance from account
actionDELETEv1.0.0
Delete a contact from a contact list
Deletes a single contact from a contact list
actionDELETEv1.0.0
Delete a contact list
Deletes a contact list, included contacts will not be deleted.
actionDELETEv1.0.0
Delete a specific sound
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
actionDELETEv1.0.0
Delete an auto reply
Deletes a text auto reply and removes the configuration. Can not delete a TextAutoReply which is currently active for a campaign
actionDELETEv1.0.0
Delete api credentials
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.
actionDELETEv1.0.0
Delete contacts from a contact list
Deletes contacts from a contact list. List the contact ids in request to delete multiple contacts with one request.
actionDELETEv1.0.0
Delete do not contact (dnc) number. If number contains commas treat as list of numbers
Delete a Do Not Contact (DNC) contact entry.
actionDELETEv1.0.0
Delete do not contact (dnc) numbers contained in source.
Delete Do Not Contact (DNC) contact entries contained in source.
actionPOSTv1.0.0
Disable specified API credentials
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.
actionPOSTv1.0.0
Enable specified API credentials
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.
actionGETv1.0.0
Find a contact's history
Searches for all texts and calls attributed to a contact. Returns a list of calls and texts a contact has been involved with
actionGETv1.0.0
Find a keyword by id
Get keyword by id
actionGETv1.0.0
Find a specific api credential
Returns an API credential instance for a given api credential id. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials.
actionGETv1.0.0
Find a specific auto reply
Returns a single TextAutoReply instance for a given text auto reply id
actionGETv1.0.0
Find a specific call
Returns a single Call instance for a given call id.
actionGETv1.0.0
Find a specific call broadcast
Returns a single CallBroadcast instance for a given call broadcast campaign id
actionGETv1.0.0
Find a specific contact
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.
actionGETv1.0.0
Find a specific contact list
Returns a single ContactList instance for a given contact list id
actionGETv1.0.0
Find a specific keyword lease config
Returns a single KeywordConfig instance for a given keyword lease
actionGETv1.0.0
Find a specific lease
Searches for all keywords owned by user
actionGETv1.0.0
Find a specific lease
Returns a single NumberLease instance for a given number
actionGETv1.0.0
Find a specific lease config
Returns a single NumberConfig instance for a given number lease
actionGETv1.0.0
Find a specific order
Returns a single NumberOrder instance for a given order id. Order contains information about purchased keywords, local, toll-free numbers
actionGETv1.0.0
Find a specific sound
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
actionGETv1.0.0
Find a specific text
Returns a single Text instance for a given text id
actionGETv1.0.0
Find a specific text broadcast
Returns a single TextBroadcast instance for a given text broadcast id
actionGETv1.0.0
Find account details
Searches for the user account details. Details include name, email, and basic account permissions. For authentication use api credentials.
actionGETv1.0.0
Find api credentials
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.
actionGETv1.0.0
Find auto replies
Find all text autoreplies created by user. Returns a paged list of TextAutoReply
actionGETv1.0.0
Find call broadcasts
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
actionGETv1.0.0
Find caller ids
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.
actionGETv1.0.0
Find calls
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](https://developers.callfire.com/results-responses-errors.html)
actionGETv1.0.0
Find calls in a call broadcast
This endpoint will enable the user to page through all calls for a particular call broadcast campaign
actionGETv1.0.0
Find contact lists
Searches for all contact lists which are available for the current user. Returns a paged list of contact lists
actionGETv1.0.0
Find contacts
Find user's contacts by id, contact list, or on any property name. Returns a paged list of contacts
actionGETv1.0.0
Find contacts in a contact list
Searches for all entries in a contact list with specified id. Returns a paged list of contact entries
actionGETv1.0.0
Find credit usage
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.
actionGETv1.0.0
Find do not contact (dnc) items
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
actionGETv1.0.0
Find keyword lease configs
Searches for all keyword lease configs for the user. Returns a paged list of KeywordConfig
actionGETv1.0.0
Find keyword leases
Searches for all keywords owned by user. A keyword lease is the ownership information involving a keyword
actionGETv1.0.0
Find keywords
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.
actionGETv1.0.0
Find lease configs
Searches for all number lease configs for the user. Returns a paged list of NumberConfig
actionGETv1.0.0
Find leases
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.
actionGETv1.0.0
Find local numbers
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.
actionGETv1.0.0
Find media
Find media files created by user
actionGETv1.0.0
Find number regions
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.
actionGETv1.0.0
Find orders
Searches for account orders
actionGETv1.0.0
Find plan usage
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.
actionGETv1.0.0
Find sounds
To find all campaign sounds which were created by user. Returns all sounds available to be used in campaigns
actionGETv1.0.0
Find text broadcasts
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
actionGETv1.0.0
Find texts
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](https://developers.callfire.com/results-responses-errors.html)
actionGETv1.0.0
Find texts in a text broadcast
This endpoint will enable the user to page through all of the texts for a particular text broadcast campaign
actionGETv1.0.0
Find tollfree numbers
Searches for the toll free numbers which are available for purchase in the CallFire catalog
actionGETv1.0.0
Find universal do not contacts (udnc) associated with toNumber
Searches for a UniversalDoNotContact object for a given phone number. Shows whether inbound/outbound actions are allowed for a given number
actionGETv1.0.0
Get a specific media
Get media resource by id
actionGETv1.0.0
Get call mp3 recording by name
Returns a MP3 recording of a particular call, response contains binary data, content type is 'audio/mpeg'
actionGETv1.0.0
Get call recording by id
Returns metadata of recording of a particular call. Metadata contains a link to a MP3 recording
actionGETv1.0.0
Get call recording by name
Returns recording metadata of particular call. Metadata contains link to a MP3 recording
actionGETv1.0.0
Get call recording in mp3 format
Returns an MP3 recording of particular call, response contains binary data, content type is 'audio/mpeg'
actionGETv1.0.0
Get call recordings for a call
Returns a list of recordings metadata of particular call. Metadata contains link to a MP3 recording
actionGETv1.0.0
Get delivery reports by ad hoc criteria
Get delivery reports
actionGETv1.0.0
Get do not contact (dnc)
Get Do Not Contact (DNC) object create by user. This DoNotContact entry only affects calls/texts/campaigns on this account.
actionGETv1.0.0
Get statistics on call broadcast
Returns broadcast statistics like total number of sent/received actions, total cost, number of remaining outbound actions, error count, etc
actionGETv1.0.0
Get statistics on text broadcast
Returns the broadcast statistics. Example: total number of the sent/received actions, total cost, number of remaining outbound actions, error count, etc
actionPOSTv1.0.0
Purchase keywords
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.
actionPOSTv1.0.0
Purchase numbers
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
actionPOSTv1.0.0
Send texts
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
actionPOSTv1.0.0
Start text broadcast
Starts a text broadcast
actionPOSTv1.0.0
Start voice broadcast
Start a voice broadcast
actionPOSTv1.0.0
Stop text broadcast
Stops a text broadcast
actionPOSTv1.0.0
Stop voice broadcast
Stop a voice broadcast
actionPUTv1.0.0
Update a call broadcast
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
actionPUTv1.0.0
Update a contact
Updates a single contact instance with id specified. See [contact validation rules](https://www.callfire.com/help/docs/getting-started/managing-contacts/validating-contacts#section1)
actionPUTv1.0.0
Update a contact list
Updates contact list instance.
actionPUTv1.0.0
Update a keyword lease config
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)
actionPUTv1.0.0
Update a lease
Updates a keyword lease. Turns the autoRenew on/off. Configure double opt in feature. Add/remove contact list from keyword.
actionPUTv1.0.0
Update a lease
Updates a number lease instance. Ability to turn on/off autoRenew and toggle call/text features for a particular number
actionPUTv1.0.0
Update a lease config
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](https://www.callfire.com/products/call-tracking)
actionPUTv1.0.0
Update a text broadcast
Allows modifying the configuration of existing text broadcast campaign. See TextBroadcast for more information on what can/can't be updated on this API
actionPUTv1.0.0
Update an individual do not contact (dnc) number
Update a Do Not Contact (DNC) contact entry. Can toggle whether the DNC is enabled for calls/texts.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec