Find texts
GET {{baseUrl}}/texts?fields=<string>&limit=<integer>&offset=<integer>&id=<integer>&campaignId=<integer>&batchId=<integer>&fromNumber=<string>&toNumber=<string>&label=<string>&states=<string>&results=<string>&inbound=<boolean>&intervalBegin=<integer>&intervalEnd=<integer>
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
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page. | |
limit | string | To set the maximum number of records to return in a paged list response. The default is 100 | |
offset | string | Offset to the start of a given page. The default is 0. Check pagination page for more information about pagination in CallFire API. | |
id | string | Lists the Call ids to search for. If calls ids are specified then other query parameters can be ignored | |
campaignId | string | An id of a campaign, queries for calls included to a particular campaign. Specify null for all campaigns and 0 for default campaign | |
batchId | string | An id of a contact batch, queries for calls of a particular contact batch | |
fromNumber | string | Phone number in E.164 format (11-digit) that call was from. Example: 12132000384 | |
toNumber | string | Phone number in E.164 format (11-digit) that call was sent to. Example: 12132000384 | |
label | string | A label for a specific call | |
states | string | 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 | |
results | string | 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 | |
inbound | string | Filters inbound calls for "true" value and outbound calls for "false" value | |
intervalBegin | string | Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT | |
intervalEnd | string | End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |