Streamdata.io API Gallery - CallFire (Report Issue)

Organization(s):

CallFire 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)

CallFire Send calls

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 u...

CallFire 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

CallFire 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 h...

CallFire Find a specific call broadcast

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

CallFire 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

CallFire Archive voice broadcast

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

CallFire Find batches in a call broadcast

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

CallFire Add batches to a call broadcast

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 sc...

CallFire Find calls in a call broadcast

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

CallFire 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. Recip...

CallFire Start voice broadcast

Start a voice broadcast

CallFire 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

CallFire Stop voice broadcast

Stop a voice broadcast

CallFire Find a specific call

Returns a single Call instance for a given call id.

CallFire Get call recordings for a call

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

CallFire Get call recording by name

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

CallFire Get call mp3 recording by name

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

CallFire Get call mp3 recording by name

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

CallFire Get call recording by id

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

CallFire Get call recording in mp3 format

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

CallFire Get call recording in mp3 format

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

CallFire Find a specific batch

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

CallFire Update a batch

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

CallFire Find sounds

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

CallFire 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.

CallFire Add sound via file

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

CallFire 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 access...

CallFire 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

CallFire Download a MP3 sound

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

CallFire Download a WAV sound

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

CallFire Download a MP3 sound

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

CallFire Download a WAV sound

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

CallFire 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

CallFire Find contacts

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

CallFire Create contacts

Creates contacts in CallFire system. These contacts are not validated on creation. They will be validated upon being added to a campaign

CallFire 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

CallFire Add or update 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.

CallFire 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.

CallFire 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.

CallFire Delete do not contact (dnc) numbers contained in source.

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

CallFire 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

CallFire Delete a contact

Deletes a contact instance from account

CallFire 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.

CallFire Update a contact

Updates a single contact instance with id specified

CallFire 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

CallFire Find contact lists

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

CallFire 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...

CallFire Delete a contact list

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

CallFire Find a specific contact list

Returns a single ContactList instance for a given contact list id

CallFire Update a contact list

Updates contact list instance.

CallFire 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.

CallFire Find contacts in a contact list

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

CallFire 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)

CallFire Delete a contact from a contact list

Deletes a single contact from a contact list

CallFire 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

CallFire 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...

CallFire Check for a specific keyword

Searches for the specific keyword to purchase on the CallFire platform. Returns 'true' if keyword is available.

CallFire Find keyword leases

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

CallFire Find a specific lease

Searches for all keywords owned by user

CallFire Update a lease

Updates a keyword lease. Turns the autoRenew on/off.

CallFire Find account details

Searches for the user account details. Details include name, email, and basic account permissions

CallFire 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

CallFire 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 credential...

CallFire Delete api credentials

Deletes a specified API credential. Currently, removes the ability to access the API. Only ACCOUNT_HOLDER can invoke this API

CallFire Find a specific api credential

Returns an API credential instance for a given api credential id. Only ACCOUNT_HOLDER can invoke this API

CallFire Find credit usage

Find credit usage for the user. Returns credits usage for time period specified or if unspecified then total for all time.

CallFire 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

CallFire 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.

CallFire 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.

CallFire Verify a caller id

With the verification code received from the Create caller id endpoint, a call to this endpoint is required to finish verification

CallFire Create media

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

CallFire Download media by extension

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

CallFire Get a specific media

Get media resource by id

CallFire Download media by extension

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

CallFire Download a MP3 media

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

CallFire Download media by extension

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

CallFire Download media by extension

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

CallFire 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.

CallFire Find lease configs

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

CallFire Find a specific lease config

Returns a single NumberConfig instance for a given number lease

CallFire 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 us...

CallFire Find a specific lease

Returns a single NumberLease instance for a given number

CallFire Update a lease

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

CallFire 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.

CallFire 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.

CallFire Find tollfree numbers

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

CallFire Find a specific order

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

CallFire 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

CallFire 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 purcha...

CallFire 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)

CallFire Send texts

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

CallFire Find auto replies

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

CallFire 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 th...

CallFire 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

CallFire Find a specific auto reply

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

CallFire 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

CallFire 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 ...

CallFire Find a specific text broadcast

Returns a single TextBroadcast instance for a given text broadcast id

CallFire 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

CallFire Archive text broadcast

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

CallFire Find batches in a text broadcast

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

CallFire Add batches to a text broadcast

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 du...

CallFire 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 ...

CallFire Start text broadcast

Starts a text broadcast

CallFire 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

CallFire Stop text broadcast

Stops a text broadcast

CallFire 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

CallFire Find a specific text

Returns a single Text instance for a given text id

CallFire Find webhooks

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

CallFire Create a webhook

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 ...

CallFire Delete a webhook

Deletes a webhook instance. Will be removed permanently

CallFire Find a specific webhook

Returns a single Webhook instance for a given webhook id

CallFire Update a webhook

Updates the information in existing webhook

CallFire Find webhook resources

Searches for webhook resources. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], ...

CallFire Find specific webhook resource

Returns information about supported events for a given webhook resource

Submit Your API

Join the gallery to find out how much you can save with Streamdata.io.