QueryContacts

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.

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.

Request Parameters

Parameter Demo Value Description Data Type
QueryContacts Contacts request by query which can include String, Field, and ContactListId object
MaxResults Max number of results to return limited to 1000 (default: 1000) long
FirstResult Start of next result set (default: 0) long
Field Field to filter by string
ContactListId ContactList to filter by long
String Substring contained in Contact to filter by string

* indicates choice value, bolded parameters are required

Response Parameters

Parameter Description Data Type
ContactQueryResult List of Contacts returned from query
TotalResults Results count long
Contact Info about the people you want to contact. Any info needed can be stored under Contact as an extra attribute.
mobilePhone E.164 11 digit number PhoneNumber
homePhone E.164 11 digit number PhoneNumber
extraPhone1 E.164 11 digit number PhoneNumber
externalSystem System where externalId was generated from (NATION_BUILDER, GOOGLE_GROUPS, etc...) string
zipcode 5 digit zipcode string
extraPhone2 E.164 11 digit number PhoneNumber
firstName First name string
lastName Last name string
extraPhone3 E.164 11 digit number PhoneNumber
externalId id of contact defined by external system (NATION_BUILDER, GOOGLE_GROUPS, etc...) string
id Unique ID of Contact long
workPhone E.164 11 digit number PhoneNumber

 

Example Code

	<?php
/**
 * You'll need your login/password pair when you create the SOAP client.
 * Don't use the fake login/password provided here; it's just for show and won't work.
 */
$wsdl = "http://callfire.com/api/1.1/wsdl/callfire-service-http-soap12.wsdl";
$client = new SoapClient($wsdl, array(
    'soap_version' => SOAP_1_2,
    'login'        => 'YourLoginId',    
    'password'     => 'YourPassword'));


/**
 * QueryContacts.
 */
 
?>