\CallFire\Api\Rest\ClientContact

QueryContacts()

QueryContacts(\CallFire\Api\Rest\Request\QueryContacts $QueryContacts)

Lists existing contacts

Parameters

UpdateContacts()

UpdateContacts(int $Id)

Updates existing contacts

REST service parameters:Accepts string of the form-encoded key-value contact pairs. Each contact's value contains URL-encoded (using UTF-8 encoding) attribute name and value separated by collon. Each attribute pair separated by semicolon.Format:contact=attributeName:attributeValue[;attributeName:attributeValue;...][&contact=attributeName:attributeValue[;attributeName:attributeValue;...]&...]Example:contact=id:1;firstName:John;customAttribute:value&contact=id:2;secondName:Doe

Parameters

RemoveContacts()

RemoveContacts(\CallFire\Api\Rest\Request\RemoveContacts $RemoveContacts)

Removes contacts

Parameters

GetContact()

GetContact(int $Id)

Gets the contact by ID

Parameters

GetContactHistory()

GetContactHistory(\CallFire\Api\Rest\Request\GetContactHistory $GetContactHistory)

Gets a contact's history by contact ID

Parameters

CreateContactList()

CreateContactList(\CallFire\Api\Rest\Request\CreateContactList $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

Parameters

QueryContactLists()

QueryContactLists(\CallFire\Api\Rest\Request\QueryContactLists $QueryContactLists)

Lists existing contact lists

Parameters

DeleteContactList()

DeleteContactList(int $Id)

Deletes a contact list by ID

Parameters

AddContactsToList()

AddContactsToList(\CallFire\Api\Rest\Request\AddContactsToList $AddContactsToList)

Adds contacts to an existing list

See CreateContactList. Currently only supports adding ContactSource numbers, not contact lists, contactId lists, or csv files.

Parameters

RemoveContactsFromList()

RemoveContactsFromList(\CallFire\Api\Rest\Request\RemoveContactsFromList $RemoveContactsFromList)

Removes contacts from a list without deleting the contacts

Currently only supports removing contacts by ContactSource numbers, not contact lists, contactId lists, or csv files. Just specify the contact list ID and the numbers to remove from list.

Parameters

ns()

ns()

request()

request(string $type) : mixed

Instantiate a request object of the given type

Parameters

Returns

Request object

response()

response(string $data, string $type) : mixed

Parse a response into a response type

Parameters

Returns

Response object

get()

get(string $uri, \CallFire\Api\Rest\Request $request) : string

Execute a GET request against an API endpoint, optionally with a given Request object as parameters

Parameters

Returns

Response data

post()

post(string $uri, \CallFire\Api\Rest\Request $request) : string

Execute a POST request against an API endpoint, optionally with a given Request object as parameters

Parameters

Returns

Response data

put()

put(string $uri, \CallFire\Api\Rest\Request $request) : string

Execute a PUT request against an API endpoint, optionally with a given Request object as parameters

Parameters

Returns

Response data

delete()

delete(string $uri, \CallFire\Api\Rest\Request $request) : string

Execute a DELETE request again an API endpoint, optionally with a given Request object as parameters

Parameters

Returns

Response data

buildQuery()

buildQuery(string $uri, array $parameters) : string

Build a request URI for a GET request

Parameters

Returns

The resulting URL

buildPostData()

buildPostData(array $parameters) : string

Construct the POST fields data for a POST/PUT request, according to CallFire conventions

Reformats any array parameters to be a space-concatenated list of items. Any object parameters will be casted to a string, as possible.

Parameters

Returns

Encoded POST data

getBasePath()

getBasePath()

setBasePath()

setBasePath( $basePath)

Parameters

getUsername()

getUsername()

setUsername()

setUsername( $username)

Parameters

getPassword()

getPassword()

setPassword()

setPassword( $password)

Parameters

getHttpClone()

getHttpClone()

getHttp()

getHttp()

setHttp()

setHttp(\CallFire\Api\Rest\Http\Request $http)

Parameters

getUri()

getUri( $path,  $parameters)

Parameters

updateCredentials()

updateCredentials() : void

Rehashes the HTTP Basic Authentication on the HTTP client