v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
calls

Find calls

To search for all calls sent or received by the user. Use "id=0" for the campaignId parameter to query for all calls sent through the POST /calls API. See call states and results

get/calls

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.

idinteger[]

Lists the Call ids to search for. If calls ids are specified then other query parameters can be ignored

campaignIdinteger

An id of a campaign, queries for calls included to a particular campaign. Specify null for all campaigns and 0 for default campaign

batchIdinteger

An id of a contact batch, queries for calls of a particular contact batch

fromNumberstring

Phone number in E.164 format (11-digit) that call was from. Example: 12132000384

toNumberstring

Phone number in E.164 format (11-digit) that call was sent to. Example: 12132000384

labelstring

A label for a specific call

statesstring

Searches for all calls which correspond to statuses listed in a comma separated string. Available values: READY, SELECTED, CALLBACK, FINISHED, DISABLED, DNC, DUP, INVALID, TIMEOUT, PERIOD_LIMIT. See call states and results

resultsstring

Searches for all calls with statuses listed in a comma separated string. Available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED. See call states and results

inboundboolean

Filters inbound calls for "true" value and outbound calls for "false" value

intervalBegininteger

Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

intervalEndinteger

End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

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

All 123 operations