MENU
CallFire - Your Message Delivered
Call Us! (877) 897-3473
CLOSE
  • Products
  • Pricing
  • Developers
  • Help
  • Log In
  • Sign Up
Call Us! (877) 897-3473

ContactService

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.

CallFire-API-Documentation

  • ▶/BroadcastService
    • CreateBroadcast
    • QueryBroadcasts
    • GetBroadcast
    • UpdateBroadcast
    • GetBroadcastStats
    • ControlBroadcast
    • CreateContactBatch
    • QueryContactBatches
    • GetContactBatch
    • ControlContactBatch
    • CreateBroadcastSchedule
    • QueryBroadcastSchedule
    • GetBroadcastSchedule
    • DeleteBroadcastSchedule
  • ▶/SubscriptionService
    • CreateSubscription
    • QuerySubscriptions
    • GetSubscription
    • UpdateSubscription
    • DeleteSubscription
  • ▶/TextService
    • SendText
    • QueryTexts
    • GetText
    • CreateAutoReply
    • QueryAutoReplies
    • GetAutoReply
    • DeleteAutoReply
  • ▶/CallService
    • SendCall
    • QueryCalls
    • GetCall
    • CreateSound
    • QuerySoundMeta
    • GetSoundMeta
    • GetSoundData
    • GetRecordingData
    • SendVerificationCodeToCallerId
    • VerifyCallerId
    • GetCallerIds
  • ▶/CccService
    • GetCccCampaign
    • GetCccCampaignStats
    • CreateCccCampaign
    • QueryCccCampaigns
    • UpdateCccCampaign
    • DeleteCccCampaignTransferNumbers
    • DeleteCccCampaignQuestions
    • ControlCccCampaign
    • DeleteCccCampaign
    • GetAgent
    • QueryAgents
    • AddAgents
    • GetAgents
    • RemoveAgent
    • GetAgentGroup
    • QueryAgentGroups
    • CreateAgentGroup
    • UpdateAgentGroup
    • AddAgentGroups
    • GetAgentGroups
    • DeleteAgentGroup
    • RemoveAgentGroup
    • GetAgentSession
    • QueryAgentSessions
    • SendAgentInvites
    • GetAgentInviteUri
  • ▶/ContactService
    • QueryContacts
    • UpdateContacts
    • RemoveContacts
    • GetContact
    • GetContactHistory
    • CreateContactList
    • QueryContactLists
    • DeleteContactList
    • AddContactsToList
    • GetContactList
    • RemoveContactsFromList
    • QueryDncNumbers
    • UpdateDncNumber
    • QueryDncLists
    • CreateDncList
    • GetDncList
    • DeleteDncList
    • AddNumbersToDncList
    • RemoveNumbersFromDncList
  • ▶/NumberService
    • QueryRegions
    • QueryNumbers
    • GetNumber
    • ConfigureNumber
    • SearchAvailableNumbers
    • QueryKeywords
    • SearchAvailableKeywords
    • CreateNumberOrder
    • GetNumberOrder
    • Release
  • ▶/LabelService
    • DeleteLabel
    • QueryLabels
    • LabelBroadcast
    • UnlabelBroadcast
    • LabelNumber
    • UnlabelNumber
  • API    >  
  • ContactService

ContactService

Provides operations for managing contact lists
Managing Contacts

QueryContacts

Lists existing contacts

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

Updates existing contacts

Update existing contacts.

RemoveContacts

Removes contacts

Delete contacts identified by contactIds from system. If id points to non-existent contact the id will be ignored and processing will continue.

GetContact

Gets the contact by ID

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

Gets a contact's history by contact ID

List all calls and texts associated with a contact.

CreateContactList

Create new contact list and add to account

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_UNMAPPEDResolution USE_DEFAULT_COLUMNS
LIST_HAS_DUPLICATE_NUMBERSResolution SCRUB
LIST_HAS_DNC_CONTACTSResolution SCRUB
LIST_HAS_CONTACT_CONFLICTSResolution MERGE
LIST_HAS_INVALID_NUMBERSResolution SCRUB

QueryContactLists

Lists existing contact lists

Query for existing contact lists. Currently does no filtering and returns all contact lists.

DeleteContactList

Deletes a contact list by ID

Delete contact list identified by id.

AddContactsToList

Adds contacts to an existing list

See CreateContactList.

GetContactList

Gets the contact list by ID

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

Removes contacts from a list without deleting the contacts.

QueryDncNumbers

Query for existing do not contact (DNC) numbers

Query for existing do not contact (DNC) numbers.

UpdateDncNumber

Update existing do not contact (DNC) number

Update existing do not contact (DNC) numbers.

QueryDncLists

Query for existing do not contact (DNC) lists

Query for existing do not contact (DNC) lists.

CreateDncList

Create do not contact (DNC) list

Create do not contact (DNC) list.

GetDncList

Get do not contact (DNC) list

Get do not contact (DNC) list by id.

DeleteDncList

Delete do not contact (DNC) list

Delete do not contact (DNC) list by id.

AddNumbersToDncList

Add numbers to do not contact (DNC) list

Add numbers to do not contact (DNC) list.

RemoveNumbersFromDncList

Removes number from do not contact (DNC) list

Remove numbers from do not contact (DNC) list.

Company

  • Careers
  • Blog
  • Press

Products

  • Text Messaging
  • Call Tracking
  • Voice Broadcast
  • CallFire IVR
  • Developer API

Resources

  • Case Studies
  • Industries
  • Communications Glossary
  • Marketing Glossary
  • Area Codes
  • Labs

Help

  • FAQs
  • CallFire XML
  • Contact Us
  • Reviews
  • System Status

© Copyright 2021 CallFire Inc. All Rights Reserved

Privacy Policy / Terms / Service Policy / FTC/FCC/DNC Compliance / Sitemap

Contact Support
Contact Sales
Phone +1.877.897.3473
Fax +1.310.943.0415

Msg&data rates may apply in the US. Standard message and data rates apply in Canada. To unsubscribe from any CallFire ® list simply send 'STOP' to the originating short code or contact Support.