API documentation

GET /call_recording_rules

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules

List Call Recording Retention records.

Lists Call Recording Retention rules, which automatically delete call recordings once they exceed a configured age. Requires the setup_system permission; results default to newest first.

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. Must be a valid time zone. See the list of valid time zones.
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 user_id sortable_order description recording_type retention_seconds offer_id schedule_id buyer_id traffic_source_id completed_at 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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "call_recording_rules": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "CallRecordingRule",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "company_id": 10001,
      "user_id": null,
      "sortable_order": -6,
      "description": "Short Retention Call Recording (7 days)",
      "recording_type": "consumer_and_agent",
      "retention_seconds": 604800,
      "offer_id": null,
      "schedule_id": null,
      "buyer_id": null,
      "traffic_source_id": null,
      "completed_at": null
    },
    {
      "id": "a09e6bca-255b-4217-af73-cb9601c80217",
      "type": "CallRecordingRule",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/call_recording_rules/a09e6bca-255b-4217-af73-cb9601c80217",
      "routes_edit_path": "/call_recording_rules/a09e6bca-255b-4217-af73-cb9601c80217/edit",
      "external_record_id": null,
      "company_id": 10001,
      "user_id": null,
      "sortable_order": -5,
      "description": "Compliance Recording (2 years)",
      "recording_type": "call",
      "retention_seconds": 63072000,
      "offer_id": null,
      "schedule_id": null,
      "buyer_id": null,
      "traffic_source_id": null,
      "completed_at": null
    }
  ],
  "metadata": {
    "root": "call_recording_rules",
    "page": 1,
    "total_pages": 3,
    "per_page": 2,
    "total_count": 6,
    "next_cursor": 10002
  }
}

GET /call_recording_rules/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/new

Build Call Recording Retention with defaults.

Builds a Call Recording Retention rule with default attributes without saving it.

Params

Param name	Description
description Optional Blank value allowed	Description Must be a String
recording_type Optional Blank value allowed	This type of recording will be deleted once the retention period has passed. Must be one of: `call`, `consumer_and_agent`, `consumer_and_buyer`.
retention_seconds Optional Blank value allowed	If a recording is older than this many seconds, it will be deleted. Must be a decimal number.
offer_id Optional Blank value allowed	Only recordings matching this offer will be deleted after the retention period. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
schedule_id Optional Blank value allowed	Only recordings matching this Schedule will be deleted after the retention period. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
buyer_id Optional Blank value allowed	Only recordings matching this Buyer will be deleted after the retention period. Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
traffic_source_id Optional Blank value allowed	Only recordings matching this Traffic Source will be deleted after the retention period. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_recording_rule": {
    "id": null,
    "type": "CallRecordingRule",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/call_recording_rules/new",
    "routes_edit_path": "/call_recording_rules/new",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "sortable_order": null,
    "description": "Delete calls after 1 week.",
    "recording_type": "call",
    "retention_seconds": 604800,
    "offer_id": null,
    "schedule_id": null,
    "buyer_id": null,
    "traffic_source_id": null,
    "completed_at": null
  },
  "metadata": {
    "root": "call_recording_rule"
  }
}

POST /call_recording_rules

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules

Create Call Recording Retention.

Creates a rule that deletes matching call recordings once they are older than retention_seconds. Can be scoped to a specific offer, schedule, buyer, or traffic source; unscoped rules apply company-wide.

Params

Param name	Description
description Optional Blank value allowed	Description Must be a String
recording_type Optional Blank value allowed	This type of recording will be deleted once the retention period has passed. Must be one of: `call`, `consumer_and_agent`, `consumer_and_buyer`.
retention_seconds Optional Blank value allowed	If a recording is older than this many seconds, it will be deleted. Must be a decimal number.
offer_id Optional Blank value allowed	Only recordings matching this offer will be deleted after the retention period. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
schedule_id Optional Blank value allowed	Only recordings matching this Schedule will be deleted after the retention period. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
buyer_id Optional Blank value allowed	Only recordings matching this Buyer will be deleted after the retention period. Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
traffic_source_id Optional Blank value allowed	Only recordings matching this Traffic Source will be deleted after the retention period. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Example Call Recording Rule",
  "recording_type": "call",
  "retention_seconds": 604800
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "call_recording_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRecordingRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "sortable_order": -7,
    "description": "Example Call Recording Rule",
    "recording_type": "call",
    "retention_seconds": 604800,
    "offer_id": null,
    "schedule_id": null,
    "buyer_id": null,
    "traffic_source_id": null,
    "completed_at": null
  },
  "metadata": {
    "root": "call_recording_rule"
  }
}

GET /call_recording_rules/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/:id

Get Call Recording Retention by id.

Retrieves a Call Recording Retention rule by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_recording_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRecordingRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "sortable_order": -6,
    "description": "Short Retention Call Recording (7 days)",
    "recording_type": "consumer_and_agent",
    "retention_seconds": 604800,
    "offer_id": null,
    "schedule_id": null,
    "buyer_id": null,
    "traffic_source_id": null,
    "completed_at": null
  },
  "metadata": {
    "root": "call_recording_rule"
  }
}

PUT /call_recording_rules/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/:id

Update Call Recording Retention by id.

Updates a Call Recording Retention rule's retention period, recording_type, or the offer, schedule, buyer, or traffic source it applies to.

Params

Param name	Description
description Optional Blank value allowed	Description Must be a String
recording_type Optional Blank value allowed	This type of recording will be deleted once the retention period has passed. Must be one of: `call`, `consumer_and_agent`, `consumer_and_buyer`.
retention_seconds Optional Blank value allowed	If a recording is older than this many seconds, it will be deleted. Must be a decimal number.
offer_id Optional Blank value allowed	Only recordings matching this offer will be deleted after the retention period. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
schedule_id Optional Blank value allowed	Only recordings matching this Schedule will be deleted after the retention period. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
buyer_id Optional Blank value allowed	Only recordings matching this Buyer will be deleted after the retention period. Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
traffic_source_id Optional Blank value allowed	Only recordings matching this Traffic Source will be deleted after the retention period. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Example Call Recording Rule (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_recording_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRecordingRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "sortable_order": -8,
    "description": "Example Call Recording Rule (renamed)",
    "recording_type": "call",
    "retention_seconds": 604800,
    "offer_id": null,
    "schedule_id": null,
    "buyer_id": null,
    "traffic_source_id": null,
    "completed_at": null
  },
  "metadata": {
    "root": "call_recording_rule"
  }
}

DELETE /call_recording_rules/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/:id

Destroy Call Recording Retention by id.

Deletes a Call Recording Retention rule by id.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_recording_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRecordingRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "sortable_order": -8,
    "description": "Example Call Recording Rule",
    "recording_type": "call",
    "retention_seconds": 604800,
    "offer_id": null,
    "schedule_id": null,
    "buyer_id": null,
    "traffic_source_id": null,
    "completed_at": null
  },
  "metadata": {
    "root": "call_recording_rule"
  }
}

Params

Must be any combination of:

Params

Params

Params