Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
contacts

Create contact lists

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

post/contacts/lists

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

Request body

contactIdsinteger[]

A list of ids of existing contacts in CallFire system

contactNumbersstring[]

List of numbers in E.164 format (11-digit). Example: 12132000384

contactNumbersFieldstring

A type of a phone number (homePhone, workPhone, mobilePhone). This parameter is used with contactNumbers and specifies which types of phone numbers are included to a contact list

useCustomFieldsboolean

A flag to indicate how to define property names for contacts. If true, uses the field and property names exactly as defined. If false will assign custom properties and fields to A, B, C, etc

namestring

A name of a contact list

Response

successful operation

idinteger

An Id of a contact list

namestring

A name of a contact list

sizeinteger

A number of contacts in a contact list

createdinteger

A time when a given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

status'ACTIVE' | 'VALIDATING' | 'IMPORTING' | 'IMPORT_FAILED' | 'ERRORS' | 'DELETED' | 'PARSE_FAILED' | 'COLUMN_TOO_LARGE'

A current status of a contact list, available values: ACTIVE - contact list is ready, VALIDATING - contact list validation is in progress, IMPORTING - importing is in progress, IMPORT_FAILED - in case of errors occurred during the importing, ERRORS - contact list has validation errors, DELETED - contact list was deleted, PARSE_FAILED - contacts cannot be parsed, COLUMN_TOO_LARGE - if size of phone number or any other column exceeds 255 characters