{"@context": "https://schema.org", "@type": "WebAPI", "name": "CallFire API Documentation API", "description": "CallFire", "provider": {"@type": "Organization", "name": "callfire.com"}, "documentation": "https://www.callfire.com/v2/api-docs/swagger.json"}
CallFire
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.callfire.com/v2
auth: b a s i c
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
CallFire
| method | path | what the vendor says it does |
|---|---|---|
GET | /calls | Find calls To search for all calls sent or received by the user. Use "id=0" for the campaignId parameter to qu |
POST | /calls | Send calls Use the /calls API to send individual calls quickly. A verified Caller ID and sufficient credits ar |
GET | /calls/broadcasts | Find call broadcasts Searches for all voice broadcasts created by user. Can query on label, name, and the curr |
POST | /calls/broadcasts | Create a call broadcast Creates a call broadcast campaign using the Call Broadcast API. Send a CallBroadcast i |
GET | /calls/broadcasts/{id} | Find a specific call broadcast Returns a single CallBroadcast instance for a given call broadcast campaign id |
PUT | /calls/broadcasts/{id} | Update a call broadcast This operation lets the user modify the configuration of a voice broadcast campaign af |
POST | /calls/broadcasts/{id}/archive | Archive voice broadcast Archives a voice broadcast (voice broadcast will be hidden in search results) calls |
GET | /calls/broadcasts/{id}/batches | Find batches in a call broadcast This endpoint will enable the user to page through all of the batches for a p |
POST | /calls/broadcasts/{id}/batches | Add batches to a call broadcast The 'add batch' API allows user to add additional batches to an already create |
GET | /calls/broadcasts/{id}/calls | Find calls in a call broadcast This endpoint will enable the user to page through all calls for a particular c |
POST | /calls/broadcasts/{id}/recipients | Add recipients to a call broadcast Use this API to add the recipients to an existing voice broadcast. Post a l |
POST | /calls/broadcasts/{id}/start | Start voice broadcast Start a voice broadcast calls |
GET | /calls/broadcasts/{id}/stats | Get statistics on call broadcast Returns broadcast statistics like total number of sent/received actions, tota |
POST | /calls/broadcasts/{id}/stop | Stop voice broadcast Stop a voice broadcast calls |
POST | /calls/broadcasts/{id}/toggleRecipientsStatus | Disable/enable undialed recipients in broadcast This operation lets the user to disable/enable undialed recipi |
GET | /calls/recordings/{id} | Get call recording by id Returns metadata of recording of a particular call. Metadata contains a link to a MP3 |
GET | /calls/recordings/{id}.mp3 | Get call recording in mp3 format Returns an MP3 recording of particular call, response contains binary data, c |
GET | /calls/{id} | Find a specific call Returns a single Call instance for a given call id. calls |
GET | /calls/{id}/recordings | Get call recordings for a call Returns a list of recordings metadata of particular call. Metadata contains lin |
GET | /calls/{id}/recordings/{name} | Get call recording by name Returns recording metadata of particular call. Metadata contains link to a MP3 reco |
GET | /calls/{id}/recordings/{name}.mp3 | Get call mp3 recording by name Returns a MP3 recording of a particular call, response contains binary data, co |
GET | /campaigns/batches/{id} | Find a specific batch Returns a single Batch instance for a given batch id. This API is useful for determining |
PUT | /campaigns/batches/{id} | Update a batch Updates a single Batch instance, currently batch can only be turned "on/off" campaigns |
GET | /campaigns/sounds | Find sounds To find all campaign sounds which were created by user. Returns all sounds available to be used in |
POST | /campaigns/sounds/calls | Add sound via call Use this API to create a sound via a phone call. Provide the required phone number in the C |
POST | /campaigns/sounds/files | Add sound via file Create a campaign sound file via a supplied .mp3 or .wav file campaigns |
POST | /campaigns/sounds/tts | Add sound via text-to-speech Use this API to create a sound file via a supplied string of text. Add a text in |
GET | /campaigns/sounds/{id} | Find a specific sound Returns a single CampaignSound instance for a given sound id in campaign. This is a meta |
DELETE | /campaigns/sounds/{id} | Delete a specific sound Deletes a single campaign sound instance for a specific campaign sound id, this operat |
GET | /campaigns/sounds/{id}.mp3 | Download a MP3 sound Download the MP3 version of a hosted file. This is an audio data endpoint. Returns binary |
GET | /campaigns/sounds/{id}.wav | Download a WAV sound Download the WAV version of the hosted file. This is an audio data endpoint. Returns bina |
GET | /contacts | Find contacts Find user's contacts by id, contact list, or on any property name. Returns a paged list of conta |
POST | /contacts | Create contacts Creates contacts in CallFire system. Only values from the next list can be used as external sy |
GET | /contacts/dncs | Find do not contact (dnc) items Searches for all Do Not Contact (DNC) objects created by user. These DoNotCont |
POST | /contacts/dncs | Add do not contact (dnc) numbers Add or update a list of Do Not Contact (DNC) contact entries. Can toggle whet |
DELETE | /contacts/dncs/sources/{source} | Delete do not contact (dnc) numbers contained in source. Delete Do Not Contact (DNC) contact entries contained |
GET | /contacts/dncs/universals/{toNumber} | Find universal do not contacts (udnc) associated with toNumber Searches for a UniversalDoNotContact object for |
GET | /contacts/dncs/{number} | Get do not contact (dnc) Get Do Not Contact (DNC) object create by user. This DoNotContact entry only affects |
PUT | /contacts/dncs/{number} | Update an individual do not contact (dnc) number Update a Do Not Contact (DNC) contact entry. Can toggle wheth |
DELETE | /contacts/dncs/{number} | Delete do not contact (dnc) number. If number contains commas treat as list of numbers Delete a Do Not Contact |
and 82 more operation(s) in this specification, all searchable.
specification origin: https://www.callfire.com/v2/api-docs/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.