CallFire API Documentation
CallFire
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
CallFire
Endpoints 122
calls
- GETFind calls
/calls?fields=string&limit=100&offset=0&id=0&campaignId=0&batchId=0&fromNumber=string&toNumber=string&label=string&states=string&results=string&inbound=true&intervalBegin=0&intervalEnd=0To 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… - POSTSend calls
/calls?fields=string&campaignId=0&defaultLiveMessage=string&defaultMachineMessage=string&defaultLiveMessageSoundId=0&defaultMachineMessageSoundId=0&defaultVoice=MALE1&strictValidation=trueUse the /calls API to send individual calls quickly. A verified Caller ID and sufficient credits are required to make a call. CallRecipient represents a… - GETFind call broadcasts
/calls/broadcasts?fields=string&limit=10&offset=0&label=string&name=string&running=true&scheduled=true&intervalBegin=0&intervalEnd=0Searches 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… - POSTCreate a call broadcast
/calls/broadcasts?start=true&strictValidation=trueCreates 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… - GETFind a specific call broadcast
/calls/broadcasts/:id?fields=stringReturns a single CallBroadcast instance for a given call broadcast campaign id - PUTUpdate a call broadcast
/calls/broadcasts/:id?strictValidation=trueThis operation lets the user modify the configuration of a voice broadcast campaign after call broadcast campaign is created. See CallBroadcast for more… - POSTArchive voice broadcast
/calls/broadcasts/:id/archiveArchives a voice broadcast (voice broadcast will be hidden in search results) - GETFind batches in a call broadcast
/calls/broadcasts/:id/batches?fields=string&limit=100&offset=0This endpoint will enable the user to page through all of the batches for a particular voice broadcast campaign - POSTAdd batches to a call broadcast
/calls/broadcasts/:id/batches?strictValidation=trueThe 'add batch' API allows user to add additional batches to an already created voice broadcast campaign. The added batch will go through the CallFire… - GETFind calls in a call broadcast
/calls/broadcasts/:id/calls?batchId=0&fields=string&limit=100&offset=0This endpoint will enable the user to page through all calls for a particular call broadcast campaign - POSTAdd recipients to a call broadcast
/calls/broadcasts/:id/recipients?fields=string&strictValidation=trueUse 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… - POSTStart voice broadcast
/calls/broadcasts/:id/startStart a voice broadcast - GETGet statistics on call broadcast
/calls/broadcasts/:id/stats?fields=string&begin=0&end=0Returns broadcast statistics like total number of sent/received actions, total cost, number of remaining outbound actions, error count, etc - POSTStop voice broadcast
/calls/broadcasts/:id/stopStop a voice broadcast - POSTDisable/enable undialed recipients in broadcast
/calls/broadcasts/:id/toggleRecipientsStatus?enable=falseThis operation lets the user to disable/enable undialed recipients in created broadcast - GETGet call recording by id
/calls/recordings/:id?fields=stringReturns metadata of recording of a particular call. Metadata contains a link to a MP3 recording - GETGet call recording in mp3 format
/calls/recordings/:id.mp3Returns an MP3 recording of particular call, response contains binary data, content type is 'audio/mpeg' - GETFind a specific call
/calls/:id?fields=stringReturns a single Call instance for a given call id. - GETGet call recordings for a call
/calls/:id/recordings?fields=stringReturns a list of recordings metadata of particular call. Metadata contains link to a MP3 recording - GETGet call recording by name
/calls/:id/recordings/:name?fields=stringReturns recording metadata of particular call. Metadata contains link to a MP3 recording - GETGet call mp3 recording by name
/calls/:id/recordings/:name.mp3Returns a MP3 recording of a particular call, response contains binary data, content type is 'audio/mpeg'
campaigns
- GETFind a specific batch
/campaigns/batches/:id?fields=stringReturns a single Batch instance for a given batch id. This API is useful for determining the state of a validating batch - PUTUpdate a batch
/campaigns/batches/:idUpdates a single Batch instance, currently batch can only be turned "on/off" - GETFind sounds
/campaigns/sounds?limit=100&offset=0&filter=string&includeArchived=true&includePending=true&includeScrubbed=true&fields=stringTo find all campaign sounds which were created by user. Returns all sounds available to be used in campaigns - POSTAdd sound via call
/campaigns/sounds/calls?fields=stringUse 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… - POSTAdd sound via file
/campaigns/sounds/files?fields=stringCreate a campaign sound file via a supplied .mp3 or .wav file - POSTAdd sound via text-to-speech
/campaigns/sounds/tts?fields=stringUse 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… - GETFind a specific sound
/campaigns/sounds/:id?fields=stringReturns 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 - DELETEDelete a specific sound
/campaigns/sounds/:idDeletes a single campaign sound instance for a specific campaign sound id, this operation does not delete sound completely, it sets sound status to ARCHIVED… - GETDownload a MP3 sound
/campaigns/sounds/:id.mp3Download the MP3 version of a hosted file. This is an audio data endpoint. Returns binary response of the 'audio/mpeg' content type - GETDownload a WAV sound
/campaigns/sounds/:id.wavDownload the WAV version of the hosted file. This is an audio data endpoint. Returns binary response of the 'audio/mpeg' content type
contacts
- GETFind contacts
/contacts?fields=string&limit=100&offset=0&id=0&number=string&contactListId=0&propertyName=string&propertyValue=stringFind user's contacts by id, contact list, or on any property name. Returns a paged list of contacts - POSTCreate contacts
/contactsCreates contacts in CallFire system. Only values from the next list can be used as external system parameter in contact creation: NATION_BUILDER,… - GETFind do not contact (dnc) items
/contacts/dncs?fields=string&limit=100&offset=0&prefix=string&campaignId=0&source=string&call=true&text=true&inboundCall=true&inboundText=true&number=stringSearches for all Do Not Contact (DNC) objects created by user. These DoNotContact entries only affect calls/texts/campaigns on this account. Returns a paged… - POSTAdd do not contact (dnc) numbers
/contacts/dncsAdd or update a list of Do Not Contact (DNC) contact entries. Can toggle whether the DNCs are enabled for calls/texts. - DELETEDelete do not contact (dnc) numbers contained in source.
/contacts/dncs/sources/:sourceDelete Do Not Contact (DNC) contact entries contained in source. - GETFind universal do not contacts (udnc) associated with toNumber
/contacts/dncs/universals/:toNumber?fromNumber=string&fields=stringSearches for a UniversalDoNotContact object for a given phone number. Shows whether inbound/outbound actions are allowed for a given number - GETGet do not contact (dnc)
/contacts/dncs/:numberGet Do Not Contact (DNC) object create by user. This DoNotContact entry only affects calls/texts/campaigns on this account. - PUTUpdate an individual do not contact (dnc) number
/contacts/dncs/:numberUpdate a Do Not Contact (DNC) contact entry. Can toggle whether the DNC is enabled for calls/texts. - DELETEDelete do not contact (dnc) number. If number contains commas treat as list of numbers
/contacts/dncs/:numberDelete a Do Not Contact (DNC) contact entry. - GETFind contact lists
/contacts/lists?fields=string&limit=100&offset=0&name=string&exactMatch=true&contactCount=0&orderBy=stringSearches for all contact lists which are available for the current user. Returns a paged list of contact lists - POSTCreate contact lists
/contacts/lists?fields=stringCreates 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… - POSTCreate contact list from file
/contacts/lists/uploadCreates a contact list to be used with campaigns through uploading a .csv file. Returns the id of created list - GETFind a specific contact list
/contacts/lists/:id?fields=stringReturns a single ContactList instance for a given contact list id - PUTUpdate a contact list
/contacts/lists/:idUpdates contact list instance. - DELETEDelete a contact list
/contacts/lists/:idDeletes a contact list, included contacts will not be deleted. - GETFind contacts in a contact list
/contacts/lists/:id/items?fields=string&limit=0&offset=0Searches for all entries in a contact list with specified id. Returns a paged list of contact entries - POSTAdd contacts to a contact list
/contacts/lists/:id/itemsAdds 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… - DELETEDelete contacts from a contact list
/contacts/lists/:id/items?contactId=0Deletes contacts from a contact list. List the contact ids in request to delete multiple contacts with one request. - DELETEDelete a contact from a contact list
/contacts/lists/:id/items/:contactIdDeletes a single contact from a contact list - GETFind a specific contact
/contacts/:id?fields=stringReturns 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… - PUTUpdate a contact
/contacts/:idUpdates a single contact instance with id specified. See contact validation rules - DELETEDelete a contact
/contacts/:idDeletes a contact instance from account - GETFind a contact's history
/contacts/:id/history?limit=0&offset=0&fields=stringSearches for all texts and calls attributed to a contact. Returns a list of calls and texts a contact has been involved with
keywords
- GETFind keywords
/keywords?keywords=stringSearches for all keywords available for purchase on the CallFire platform. If a keyword appears in the response, it is available for purchase. List the… - GETFind keyword leases
/keywords/leases?limit=100&offset=0&filter=string&labelName=string&fields=stringSearches for all keywords owned by user. A keyword lease is the ownership information involving a keyword - GETFind keyword lease configs
/keywords/leases/configs?limit=20&offset=0&filter=string&labelName=string&fields=stringSearches for all keyword lease configs for the user. Returns a paged list of KeywordConfig - GETFind a specific keyword lease config
/keywords/leases/configs/:keyword?fields=stringReturns a single KeywordConfig instance for a given keyword lease - PUTUpdate a keyword lease config
/keywords/leases/configs/:keywordUpdates a keyword lease configuration. Use this API endpoint to enable/disable inbound SMS forwarding, set forward number. Forward number must be in E.164… - GETFind a keyword by id
/keywords/leases/id/:id?fields=stringGet keyword by id - GETFind a specific lease
/keywords/leases/:keyword?fields=stringSearches for all keywords owned by user - PUTUpdate a lease
/keywords/leases/:keywordUpdates a keyword lease. Turns the autoRenew on/off. Configure double opt in feature. Add/remove contact list from keyword. - GETCheck for a specific keyword
/keywords/:keyword/availableSearches for the specific keyword to purchase on the CallFire platform. Returns 'true' if keyword is available. Keyword should only consist of uppercase and…
me
- GETFind account details
/me/account?fields=stringSearches for the user account details. Details include name, email, and basic account permissions. For authentication use api credentials. - GETFind api credentials
/me/api/credentials?name=string&fields=string&limit=100&offset=0Searches for all credentials generated by user. Returns a paged list of the API credentials. Only ACCOUNT_HOLDER can invoke this API. For authentication use… - POSTCreate api credentials
/me/api/credentialsCreates an API credentials for the CallFire API. This endpoint requires full CallFire account credentials to be used, authenticated using Basic… - GETFind a specific api credential
/me/api/credentials/:id?fields=stringReturns an API credential instance for a given api credential id. Only ACCOUNT_HOLDER can invoke this API. For authentication use account credentials. - DELETEDelete api credentials
/me/api/credentials/:idDeletes a specified API credential. Currently, removes the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account… - POSTDisable specified API credentials
/me/api/credentials/:id/disableDisables a specified API credential. Currently, removes the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account… - POSTEnable specified API credentials
/me/api/credentials/:id/enableEnables a specified API credential. Currently, adds the ability to access the API. Only ACCOUNT_HOLDER can invoke this API. For authentication use account… - GETFind credit usage
/me/billing/credit-usage?intervalBegin=0&intervalEnd=0Find credit usage for the user. Returns credits usage for time period specified or if unspecified then total for all time. For authentication use api… - GETFind plan usage
/me/billing/plan-usageSearches 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… - GETFind caller ids
/me/calleridsReturns 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… - POSTCreate a caller id
/me/callerids/:calleridGenerates 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… - POSTVerify a caller id
/me/callerids/:callerid/verification-codeWith the verification code received from the Create caller id endpoint, a call to this endpoint is required to finish verification. For authentication use api…
media
- GETFind media
/media?limit=100&offset=0&filter=string&fields=stringFind media files created by user - POSTCreate media
/mediaUploads media file to account, acceptable media formats: bmp, gif, jpg, m4a, mp3, mp4, png, wav - GETDownload media by extension
/media/public/:key.:extensionDownload 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.… - GETGet a specific media
/media/:id?fields=stringGet media resource by id - GETDownload media by extension
/media/:id.:extensionDownload 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.… - GETDownload a MP3 media
/media/:id/fileDownload a MP3 media, endpoint returns application/binary content-type
numbers
- GETFind leases
/numbers/leases?limit=100&offset=0&prefix=string&city=string&state=string&zipcode=string&labelName=string&tollFree=true&fields=stringSearches 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. - GETFind lease configs
/numbers/leases/configs?limit=100&offset=0&prefix=string&city=string&state=string&zipcode=string&labelName=string&fields=stringSearches for all number lease configs for the user. Returns a paged list of NumberConfig - GETFind a specific lease config
/numbers/leases/configs/:number?fields=stringReturns a single NumberConfig instance for a given number lease - PUTUpdate a lease config
/numbers/leases/configs/:numberUpdates 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… - GETFind a specific lease
/numbers/leases/:number?fields=stringReturns a single NumberLease instance for a given number - PUTUpdate a lease
/numbers/leases/:numberUpdates a number lease instance. Ability to turn on/off autoRenew and toggle call/text features for a particular number - GETFind local numbers
/numbers/local?limit=100&prefix=string&city=string&state=string&zipcode=string&fields=stringSearches for numbers available for purchase in CallFire local numbers catalog . At least one additional parameter is required. User may filter local numbers… - GETFind number regions
/numbers/regions?limit=100&offset=0&prefix=string&city=string&cityPrefix=string&state=string&zipcode=string&country=string&fields=stringSearches 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… - GETFind tollfree numbers
/numbers/tollfree?pattern=string&limit=100&fields=stringSearches for the toll free numbers which are available for purchase in the CallFire catalog
orders
- GETFind orders
/orders?limit=20&offset=0&fields=string&status=string&intervalBegin=0&intervalEnd=0Searches for account orders - POSTPurchase keywords
/orders/keywords?fields=stringPurchase keywords. Send a list of available keywords into this API to purchase them using CallFire credits. Make sure the account has enough credits before… - POSTPurchase numbers
/orders/numbers?fields=stringPurchase numbers. There are many ways to purchase a number. Set either 'tollFreeCount' or 'localCount' along with some querying fields to purchase numbers by… - GETFind a specific order
/orders/:id?fields=stringReturns a single NumberOrder instance for a given order id. Order contains information about purchased keywords, local, toll-free numbers
reports
- GETGet delivery reports by ad hoc criteria
/reports/delivery?startDate=string&endDate=string&limit=100&offset=0&campaignId=0&fromNumber=string&toNumber=string&deliveryCategory=NO_DATA&deliveryState=DELIVERED&carrier=string&messageText=stringGet delivery reports
texts
- GETFind texts
/texts?id=0&campaignId=0&batchId=0&fromNumber=string&toNumber=string&label=string&states=string&results=string&inbound=true&intervalBegin=0&intervalEnd=0&limit=10&offset=0&fields=stringSearches 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 - POSTSend texts
/texts?fields=string&campaignId=0&defaultMessage=string&strictValidation=trueUse 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 - GETFind auto replies
/texts/auto-replys?fields=string&limit=100&offset=0&number=stringFind all text autoreplies created by user. Returns a paged list of TextAutoReply - POSTCreate an auto reply
/texts/auto-replysCallFire 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,… - GETFind a specific auto reply
/texts/auto-replys/:id?fields=stringReturns a single TextAutoReply instance for a given text auto reply id - DELETEDelete an auto reply
/texts/auto-replys/:idDeletes a text auto reply and removes the configuration. Can not delete a TextAutoReply which is currently active for a campaign - GETFind text broadcasts
/texts/broadcasts?name=string&label=string&running=true&scheduled=true&intervalBegin=0&intervalEnd=0&limit=10&offset=0&fields=stringSearches 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… - POSTCreate a text broadcast
/texts/broadcasts?start=true&strictValidation=trueCreates a text broadcast campaign using the Text Broadcast API. Send a TextBroadcast object in the message body to detail a text broadcast campaign. A… - GETFind a specific text broadcast
/texts/broadcasts/:id?fields=stringReturns a single TextBroadcast instance for a given text broadcast id - PUTUpdate a text broadcast
/texts/broadcasts/:id?strictValidation=trueAllows modifying the configuration of existing text broadcast campaign. See TextBroadcast for more information on what can/can't be updated on this API - POSTArchive text broadcast
/texts/broadcasts/:id/archiveArchives a text broadcast (and hides it in the search results) - GETFind batches in a text broadcast
/texts/broadcasts/:id/batches?fields=string&limit=100&offset=0This endpoint will enable the user to page through all of the batches for a particular text broadcast campaign - POSTAdd batches to a text broadcast
/texts/broadcasts/:id/batches?strictValidation=trueAllows adding an extra batches to an already created text broadcast campaign. The batches which being added pass the CallFire validation process (unlike in… - POSTAdd recipients to a text broadcast
/texts/broadcasts/:id/recipients?fields=string&strictValidation=trueUse 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… - POSTStart text broadcast
/texts/broadcasts/:id/startStarts a text broadcast - GETGet statistics on text broadcast
/texts/broadcasts/:id/stats?fields=string&begin=0&end=0Returns the broadcast statistics. Example: total number of the sent/received actions, total cost, number of remaining outbound actions, error count, etc - POSTStop text broadcast
/texts/broadcasts/:id/stopStops a text broadcast - GETFind texts in a text broadcast
/texts/broadcasts/:id/texts?batchId=0&fields=string&limit=100&offset=0This endpoint will enable the user to page through all of the texts for a particular text broadcast campaign - POSTDisable/enable undialed recipients in broadcast
/texts/broadcasts/:id/toggleRecipientsStatus?enable=falseThis operation lets the user to disable/enable undialed contacts in created broadcast - GETFind a specific text
/texts/:id?fields=stringReturns a single Text instance for a given text id
webhooks
- GETFind webhooks
/webhooks?fields=string&limit=100&offset=0&name=string&resource=string&event=string&callback=string&enabled=trueSearches all webhooks available for a current user. Searches by name, resource, event, callback URL, or whether they are enabled. Returns a paged list of… - POSTCreate a webhook
/webhooksCreate a Webhook for notification in the CallFire system. Use the webhooks API to receive notifications of important CallFire events. Select the resource to… - GETFind webhook resources
/webhooks/resources?fields=stringSearches for webhook resources. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped',… - GETFind specific webhook resource
/webhooks/resources/:resource?fields=stringReturns information about supported events for a given webhook resource - GETFind a specific webhook
/webhooks/:id?fields=stringReturns a single Webhook instance for a given webhook id - PUTUpdate a webhook
/webhooks/:idUpdates the information in existing webhook - DELETEDelete a webhook
/webhooks/:idDeletes a webhook instance. Will be removed permanently
API details
- Base URL
https://api.callfire.com/v2- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 122 operations on 89 pathsGET 67POST 34PUT 11DELETE 10
- Main resources
- contacts 23calls 21texts 20me 12campaigns 10keywords 9numbers 9webhooks 7media 6orders 4
- Response formats
application/jsonaudio/wavaudio/m4aaudio/mp3- Description format
- OpenAPI 3.0.0, API version
V2 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the CallFire API Documentation in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the CallFire API Documentation collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Find calls” (GET /calls?fields=string&limit=100&offset=0&id=0&campaignId=0&batchId=0&fromNumber=string&toNumber=string&label=string&states=string&results=string&inbound=true&intervalBegin=0&intervalEnd=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the CallFire API Documentation?
CallFire It is listed under Communication and has 122 endpoints.
Who publishes the CallFire API Documentation?
It is listed from CallFire's public API description (an OpenAPI document), not published by CallFire on Swastik Codes. Anyone who controls callfire.com can claim the profile by adding a DNS TXT record.
What is the base URL of the CallFire API Documentation?
Requests go to https://api.callfire.com/v2. Endpoint paths are added to this base URL.
How do I authenticate with the CallFire API Documentation?
With HTTP Basic authentication (username and password).
How many endpoints does the CallFire API Documentation have?
122 operations on 89 paths (67 GET, 34 POST, 11 PUT, 10 DELETE). The largest groups are contacts, calls, texts, me.
Is forking the CallFire API Documentation free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.