Mitigation Numbers

Manage spam-tag mitigation and branded caller ID for your phone numbers. Enabling a number registers it with the mobile carriers to remove "Spam Likely" labels; setting a branded name displays your business name as the caller ID on outbound calls. A one-time business compliance profile must be completed before numbers can be enabled; carriers approve the business in 1-3 business days, then approve each submitted number in about 2-3 weeks.

GET /mitigation_numbers

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

List mitigation numbers

List the mitigation numbers in your account. Each row includes the per-carrier reputation reported by T-Mobile, Verizon, and AT&T (displayed caller ID and whether the number is currently spam-flagged), the branded name, and the carrier approval status.

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
  • company_id
  • number
  • trackdrive_number_id
  • branded_name
  • approved
  • enabled
  • provider_synced_at
  • trackdrive_number_state
  • ring_pool_id
  • offer_id
  • traffic_source_id
  • tmobile_caller_id
  • verizon_caller_id
  • att_caller_id
  • tmobile_is_spam
  • verizon_is_spam
  • att_is_spam
  • mitigation_organization_id
  • organization_name
  • organization_approval_status

  • 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

PUT /mitigation_numbers/:id

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

Update a number's spam-tag mitigation

Enable or disable spam-tag mitigation, or set the branded name, for a number.

Params

Param name Description
id
Required

The id of the mitigation number to update.

  • Must be a number.
enabled
Optional Blank value allowed

Whether spam-tag mitigation is active for this number. Enabling registers the number with the mobile carriers for spam-label removal; carriers typically take 2-3 weeks to approve a submitted number.

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

The business name shown as branded caller ID. Calls placed from a number with a branded name are billed per call.

  • Must be a String

DELETE /mitigation_numbers/:id

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

Remove a number from spam-tag mitigation

Remove a number from spam-tag mitigation. Deactivates the number with the carriers, then soft-deletes it. Use this to remove numbers that are not hosted on TrackDrive.

Params

Param name Description
id
Required

The id of the mitigation number to update.

  • Must be a number.