Contacts & Blacklist The contacts that have dialed your numbers.

GET /api/v1/contacts/suppression_list
List contacts on your company blacklist.

Params

Param name
Description
Validations
page
Optional

Return the next page of results.

Validations:

  • Must be a number.
per_page
Optional

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

Validations:

  • Must be a number.
created_at_to
Optional

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

Validations:

  • Must be a String
created_at_from
Optional

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

Validations:

  • Must be a String
fulltext
Optional

Search for any record that matches this text

Validations:

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.

Validations:
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
  • number
  • last_call_at
  • blocked
  • opt_out
  • calls_count
  • outbound_call_failure_count
  • outbound_no_answer_count
  • blocked_at
  • sms_opt_out_at

Validations:

  • 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: {}}

Validations:

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

POST /api/v1/contacts/:caller_id/caller_block
Add a caller_id to your company blacklist, preventing all inbound and outbound interactions.

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -X POST -d '' trackdrive.com/api/v1/contacts/17193132645/caller_block

POST /api/v1/contacts/:caller_id/caller_unblock
Remove a caller from your company blacklist.

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -X POST -d '' trackdrive.com/api/v1/contacts/17193132645/caller_unblock

GET /api/v1/contacts/:id
Get details about a contact.

Params

Param name
Description
Validations
id
Optional

Lookup a contact by internal id, or by the 10+ digit telephone number. For example:
To find a number using trackdrive's internal id pass id=185923
To find a number using the phone number pass id=18005002562

Validations:

  • Must be a String
blocked
Optional

Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls & sms.

Validations:

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

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -X PUT "trackdrive.com/api/v1/contacts/18551231234?blocked=true"

Params

Param name
Description
Validations
id
Optional

Lookup a contact by internal id, or by the 10+ digit telephone number. For example:
To find a number using trackdrive's internal id pass id=185923
To find a number using the phone number pass id=18005002562

Validations:

  • Must be a String
opt_out
Optional

Mark a contact as opt-out or opt-in. Opt-out prevents outbound actions (calls, sms, emails), but allows the lead to dial in to your offers to resubscribe.

Validations:

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

Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls & sms.

Validations:

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

DELETE /api/v1/contacts/:id/calls
Hang up all the ongoing calls from a contact.

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -i -X DELETE "https://[your-subdomain].trackdrive.com/api/v1/contacts/123/calls?"

Params

Param name
Description
Validations
uuid
Optional

A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1

Validations:

  • Must be a String