CallFire has a new API!
We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
ContactService
QueryContacts
Query for existing contacts using optional filters such as ContactListId, Field,
etc... Returns a list of contacts and all associated info.
See GetContact
to return just a single contact by id.
UpdateContacts
Update existing contacts.
RemoveContacts
Delete contacts identified by contactIds from system. If id points to non-existent contact the id will be ignored and processing will continue.
GetContact
Return individual contact by ID. See QueryContacts to return a list of contacts and determine individual contactIds.
Note: GetContact returns all contact fields however when using PHP SoapClient only the predifined fields (lastName, mobileNumber, firstName, homePhone, workPhone, and zipcode) will show in $response. This is problem with SoapClient, not the underlying Soap message. Use our PHP REST API or another PHP SOAP client to work around the problem.
GetContactHistory
List all calls and texts associated with a contact.
CreateContactList
Add contact list to account using 1 of 4 inputs: list of contacts, numbers string, list of contactIds, or csv file containing contacts or numbers. If more then one ContactSource specified then only load from 1 source with precedence as listed above.
On import contact lists go through seven system safeguards that check the accuracy of the list. For example, our system checks if a number is formatted correctly, is invalid, is duplicated in another contact list, or is on your Do Not Contact list. API calls have their default validation error resolutions set differently then the defaults set on the CallFire web site under Settings | List Validation. The API validation defaults are:
LIST_COLUMNS_UNMAPPED | Resolution USE_DEFAULT_COLUMNS |
LIST_HAS_DUPLICATE_NUMBERS | Resolution SCRUB |
LIST_HAS_DNC_CONTACTS | Resolution SCRUB |
LIST_HAS_CONTACT_CONFLICTS | Resolution MERGE |
LIST_HAS_INVALID_NUMBERS | Resolution SCRUB |
QueryContactLists
Query for existing contact lists. Currently does no filtering and returns all contact lists.
DeleteContactList
Delete contact list identified by id.
AddContactsToList
See CreateContactList.
GetContactList
Return individual contact list by ID. See QueryContactLists to return a list of contact lists and determine individual contactListIds.
RemoveContactsFromList
Removes contacts from a list without deleting the contacts.
QueryDncNumbers
Query for existing do not contact (DNC) numbers.
UpdateDncNumber
Update existing do not contact (DNC) numbers.
QueryDncLists
Query for existing do not contact (DNC) lists.
CreateDncList
Create do not contact (DNC) list.
GetDncList
Get do not contact (DNC) list by id.
DeleteDncList
Delete do not contact (DNC) list by id.
AddNumbersToDncList
Add numbers to do not contact (DNC) list.
RemoveNumbersFromDncList
Remove numbers from do not contact (DNC) list.