flowground für Geschäftskunden

Technische Spezifikationen

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

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](https://developers.callfire.com/results-responses-errors.html)

OnInit
./lib/actions/findCalls.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/sendCalls.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/findCallBroadcasts.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/createCallBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

getCallBroadcast

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

OnInit
./lib/actions/getCallBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/updateCallBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

archiveVoiceBroadcast

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

OnInit
./lib/actions/archiveVoiceBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

getCallBroadcastBatches

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

OnInit
./lib/actions/getCallBroadcastBatches.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/addCallBroadcastBatch.js
OnStartup
-
OnClose
-

Attributes

-

getCallBroadcastCalls

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

OnInit
./lib/actions/getCallBroadcastCalls.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/addCallBroadcastRecipients.js
OnStartup
-
OnClose
-

Attributes

-

startVoiceBroadcast

Start a voice broadcast

OnInit
./lib/actions/startVoiceBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

getCallBroadcastStats

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

OnInit
./lib/actions/getCallBroadcastStats.js
OnStartup
-
OnClose
-

Attributes

-

stopVoiceBroadcast

Stop a voice broadcast

OnInit
./lib/actions/stopVoiceBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

getCallRecording

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

OnInit
./lib/actions/getCallRecording.js
OnStartup
-
OnClose
-

Attributes

-

getCallRecordingMp3

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

OnInit
./lib/actions/getCallRecordingMp3.js
OnStartup
-
OnClose
-

Attributes

-

getCall

Returns a single Call instance for a given call id.

OnInit
./lib/actions/getCall.js
OnStartup
-
OnClose
-

Attributes

-

getCallRecordings

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

OnInit
./lib/actions/getCallRecordings.js
OnStartup
-
OnClose
-

Attributes

-

getCallRecordingByName

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

OnInit
./lib/actions/getCallRecordingByName.js
OnStartup
-
OnClose
-

Attributes

-

getCallRecordingMp3ByName

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

OnInit
./lib/actions/getCallRecordingMp3ByName.js
OnStartup
-
OnClose
-

Attributes

-

getCampaignBatch

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

OnInit
./lib/actions/getCampaignBatch.js
OnStartup
-
OnClose
-

Attributes

-

updateCampaignBatch

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

OnInit
./lib/actions/updateCampaignBatch.js
OnStartup
-
OnClose
-

Attributes

-

findCampaignSounds

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

OnInit
./lib/actions/findCampaignSounds.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/postCallCampaignSound.js
OnStartup
-
OnClose
-

Attributes

-

postFileCampaignSound

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

OnInit
./lib/actions/postFileCampaignSound.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/postTTSCampaignSound.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/deleteCampaignSound.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/getCampaignSound.js
OnStartup
-
OnClose
-

Attributes

-

getCampaignSoundDataMp3

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

OnInit
./lib/actions/getCampaignSoundDataMp3.js
OnStartup
-
OnClose
-

Attributes

-

getCampaignSoundDataWav

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

OnInit
./lib/actions/getCampaignSoundDataWav.js
OnStartup
-
OnClose
-

Attributes

-

findContacts

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

OnInit
./lib/actions/findContacts.js
OnStartup
-
OnClose
-

Attributes

-

createContacts

Creates contacts in CallFire system. See [contacts validation rules](https://www.callfire.com/help/docs/getting-started/managing-contacts/validating-contacts#section1)

OnInit
./lib/actions/createContacts.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/findDoNotContacts.js
OnStartup
-
OnClose
-

Attributes

-

addDoNotContacts

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

OnInit
./lib/actions/addDoNotContacts.js
OnStartup
-
OnClose
-

Attributes

-

deleteDoNotContactsBySource

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

OnInit
./lib/actions/deleteDoNotContactsBySource.js
OnStartup
-
OnClose
-

Attributes

-

getUniversalDoNotContacts

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

OnInit
./lib/actions/getUniversalDoNotContacts.js
OnStartup
-
OnClose
-

Attributes

-

deleteDoNotContact

Delete a Do Not Contact (DNC) contact entry.

OnInit
./lib/actions/deleteDoNotContact.js
OnStartup
-
OnClose
-

Attributes

-

getDoNotContact

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

OnInit
./lib/actions/getDoNotContact.js
OnStartup
-
OnClose
-

Attributes

-

updateDoNotContact

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

OnInit
./lib/actions/updateDoNotContact.js
OnStartup
-
OnClose
-

Attributes

-

findContactLists

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

OnInit
./lib/actions/findContactLists.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/createContactList.js
OnStartup
-
OnClose
-

Attributes

-

createContactListFromFile

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

OnInit
./lib/actions/createContactListFromFile.js
OnStartup
-
OnClose
-

Attributes

-

deleteContactList

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

OnInit
./lib/actions/deleteContactList.js
OnStartup
-
OnClose
-

Attributes

-

getContactList

Returns a single ContactList instance for a given contact list id

OnInit
./lib/actions/getContactList.js
OnStartup
-
OnClose
-

Attributes

-

updateContactList

Updates contact list instance.

OnInit
./lib/actions/updateContactList.js
OnStartup
-
OnClose
-

Attributes

-

removeContactListItems

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

OnInit
./lib/actions/removeContactListItems.js
OnStartup
-
OnClose
-

Attributes

-

getContactListItems

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

OnInit
./lib/actions/getContactListItems.js
OnStartup
-
OnClose
-

Attributes

-

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)

OnInit
./lib/actions/addContactListItems.js
OnStartup
-
OnClose
-

Attributes

-

removeContactListItem

Deletes a single contact from a contact list

OnInit
./lib/actions/removeContactListItem.js
OnStartup
-
OnClose
-

Attributes

-

deleteContact

Deletes a contact instance from account

OnInit
./lib/actions/deleteContact.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getContact.js
OnStartup
-
OnClose
-

Attributes

-

updateContact

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)

OnInit
./lib/actions/updateContact.js
OnStartup
-
OnClose
-

Attributes

-

getContactHistory

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

OnInit
./lib/actions/getContactHistory.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/findKeywords.js
OnStartup
-
OnClose
-

Attributes

-

findKeywordLeases

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

OnInit
./lib/actions/findKeywordLeases.js
OnStartup
-
OnClose
-

Attributes

-

getKeywordLease

Searches for all keywords owned by user

OnInit
./lib/actions/getKeywordLease.js
OnStartup
-
OnClose
-

Attributes

-

updateKeywordLease

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

OnInit
./lib/actions/updateKeywordLease.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/isKeywordAvailable.js
OnStartup
-
OnClose
-

Attributes

-

getAccount

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

OnInit
./lib/actions/getAccount.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/findApiCredentials.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/createApiCredential.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/deleteApiCredential.js
OnStartup
-
OnClose
-

Attributes

-

getApiCredential

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

OnInit
./lib/actions/getApiCredential.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/disableApiCredentials.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/enableApiCredentials.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getCreditUsage.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getBillingPlanUsage.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getCallerIds.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/sendVerificationCodeToCallerId.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/verifyCallerId.js
OnStartup
-
OnClose
-

Attributes

-

findMedia

Find media files created by user

OnInit
./lib/actions/findMedia.js
OnStartup
-
OnClose
-

Attributes

-

createMedia

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

OnInit
./lib/actions/createMedia.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/getMediaDataByKey.js
OnStartup
-
OnClose
-

Attributes

-

getMedia

Get media resource by id

OnInit
./lib/actions/getMedia.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/getMediaData.js
OnStartup
-
OnClose
-

Attributes

-

getMediaDataBinary

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

OnInit
./lib/actions/getMediaDataBinary.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/findNumberLeases.js
OnStartup
-
OnClose
-

Attributes

-

findNumberLeaseConfigs

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

OnInit
./lib/actions/findNumberLeaseConfigs.js
OnStartup
-
OnClose
-

Attributes

-

getNumberLeaseConfig

Returns a single NumberConfig instance for a given number lease

OnInit
./lib/actions/getNumberLeaseConfig.js
OnStartup
-
OnClose
-

Attributes

-

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](https://www.callfire.com/products/call-tracking)

OnInit
./lib/actions/updateNumberLeaseConfig.js
OnStartup
-
OnClose
-

Attributes

-

getNumberLease

Returns a single NumberLease instance for a given number

OnInit
./lib/actions/getNumberLease.js
OnStartup
-
OnClose
-

Attributes

-

updateNumberLease

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

OnInit
./lib/actions/updateNumberLease.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/findNumbersLocal.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/findNumberRegions.js
OnStartup
-
OnClose
-

Attributes

-

findNumbersTollfree

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

OnInit
./lib/actions/findNumbersTollfree.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/orderKeywords.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/orderNumbers.js
OnStartup
-
OnClose
-

Attributes

-

getOrder

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

OnInit
./lib/actions/getOrder.js
OnStartup
-
OnClose
-

Attributes

-

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](https://developers.callfire.com/results-responses-errors.html)

OnInit
./lib/actions/findTexts.js
OnStartup
-
OnClose
-

Attributes

-

sendTexts

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

OnInit
./lib/actions/sendTexts.js
OnStartup
-
OnClose
-

Attributes

-

findTextAutoReplys

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

OnInit
./lib/actions/findTextAutoReplys.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/createTextAutoReply.js
OnStartup
-
OnClose
-

Attributes

-

deleteTextAutoReply

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

OnInit
./lib/actions/deleteTextAutoReply.js
OnStartup
-
OnClose
-

Attributes

-

getTextAutoReply

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

OnInit
./lib/actions/getTextAutoReply.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/findTextBroadcasts.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/createTextBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

getTextBroadcast

Returns a single TextBroadcast instance for a given text broadcast id

OnInit
./lib/actions/getTextBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/updateTextBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

archiveTextBroadcast

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

OnInit
./lib/actions/archiveTextBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

getTextBroadcastBatches

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

OnInit
./lib/actions/getTextBroadcastBatches.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/addTextBroadcastBatch.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/addTextBroadcastRecipients.js
OnStartup
-
OnClose
-

Attributes

-

startTextBroadcast

Starts a text broadcast

OnInit
./lib/actions/startTextBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

getTextBroadcastStats

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

OnInit
./lib/actions/getTextBroadcastStats.js
OnStartup
-
OnClose
-

Attributes

-

stopTextBroadcast

Stops a text broadcast

OnInit
./lib/actions/stopTextBroadcast.js
OnStartup
-
OnClose
-

Attributes

-

getTextBroadcastTexts

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

OnInit
./lib/actions/getTextBroadcastTexts.js
OnStartup
-
OnClose
-

Attributes

-

getText

Returns a single Text instance for a given text id

OnInit
./lib/actions/getText.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/findWebhooks.js
OnStartup
-
OnClose
-

Attributes

-

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']. 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](https://developers.callfire.com/security-guide.html)

OnInit
./lib/actions/createWebhook.js
OnStartup
-
OnClose
-

Attributes

-

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']

OnInit
./lib/actions/findWebhookResources.js
OnStartup
-
OnClose
-

Attributes

-

getWebhookResource

Returns information about supported events for a given webhook resource

OnInit
./lib/actions/getWebhookResource.js
OnStartup
-
OnClose
-

Attributes

-

deleteWebhook

Deletes a webhook instance. Will be removed permanently

OnInit
./lib/actions/deleteWebhook.js
OnStartup
-
OnClose
-

Attributes

-

getWebhook

Returns a single Webhook instance for a given webhook id

OnInit
./lib/actions/getWebhook.js
OnStartup
-
OnClose
-

Attributes

-

updateWebhook

Updates the information in existing webhook

OnInit
./lib/actions/updateWebhook.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

Keine Daten für environment vorhanden