Incoming SMS

Inbound SMS messages received on your tracking numbers, linked to the lead, schedule, and number that received them.

GET /incoming_text_messages

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/incoming_text_messages

List Incoming Text Message records.

Lists incoming SMS messages received on your tracking numbers. Requires the text_messages permission.

Params

Param name Description
ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
page
Optional

Return the next page of results.

  • Must be a number.
per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.
created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String
created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String
fulltext
Optional

Search for any record that matches this text

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.
columns
Optional 		Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • from
  • to
  • message
  • opted_out
  • number_id
  • lead_id
  • provider_configuration_id
  • schedule_id
  • name
  • offer_id
  • traffic_source_id
  • contact_id

  • Must be a String
root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /incoming_text_messages/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/incoming_text_messages/:id

Get Incoming Text Message by id.

Gets a single incoming text message's details by id. Requires the text_messages permission.