v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
contacts

Find do not contact (dnc) items

Searches for all Do Not Contact (DNC) objects created by user. These DoNotContact entries only affect calls/texts/campaigns on this account. Returns a paged list of DoNotContact objects

get/contacts/dncs

Query parameters

fieldsstring

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

limitinteger

To set the maximum number of records to return in a paged list response. The default is 100

offsetinteger

Offset to the start of a given page. The default is 0. Check pagination page for more information about pagination in CallFire API.

prefixstring

Prefix (1-10 digits) of phone numbers

campaignIdinteger

A campaign id which was used to send a message to a DNC number

sourcestring

A DNC source name to search for DNCs

callboolean

Show only Do-Not-Call numbers

textboolean

Show only Do-Not-Text numbers

inboundCallboolean

~

inboundTextboolean

~

numberstring[]

~

Response

successful operation

limitinteger

A maximum number of returned items. If items.size() < limit assume no more items

offsetinteger

An offset from a start of paging source

totalCountinteger

Total count of available results. -1 if unknown