v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
texts

Find texts

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

get/texts

Query parameters

idinteger[]

List of Text ids to search for, if ids specified other query params ignored

campaignIdinteger

An id of a campaign, queries for texts inside a particular campaign. Specify null to list texts of all campaigns or 0 for a default campaign

batchIdinteger

An Id of a contact batch, queries for texts which are used in the particular contact batch

fromNumberstring

A phone number in E.164 format (11-digit). Example: 12132000384, 67076

toNumberstring

A phone number in E.164 format (11-digit). Example: 12132000384, 67076

labelstring

A label of a text message

statesstring

Expected text statuses in comma separated string, available values: READY, SELECTED, CALLBACK, FINISHED, DISABLED, DNC, DUP, INVALID, TIMEOUT, PERIOD_LIMIT. See call states and results

resultsstring

Expected text results in comma separated string, available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED. See call states and results

inboundboolean

Specify true for inbound or false for outbounds. Do not specify this parameter if you need to get both inbound and outbound texts listed in response

intervalBegininteger

Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000

intervalEndinteger

End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000

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.

fieldsstring

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

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