API documentation

GET /sound_files

Authorization Required

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

List Sound File records.

Lists the audio files uploaded to your company for use in IVR prompts, hold messages, and other call playback.

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 name description token_values_count sound_playlist_ids audio_file_url record_token_filter_id record_token_filter_data_count record_token_filter_data 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/sound_files/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "sound_files": [
    {
      "id": 10001,
      "type": "SoundFile",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T13:30:00.000Z",
      "updated_at": "2026-01-15T14:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/sound_files/10001",
      "routes_edit_path": "/sound_files/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "name": "Example Sound File (renamed)",
      "description": "Standard greeting played at the start of a call",
      "token_values_count": 0,
      "sound_playlist_ids": [],
      "audio_file_url": "/greetings/sound_file/audio_file/2-1/a0d49c48545bcaaf801ee2f44f8f73cb/original/greeting.mp3",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": 10003,
      "type": "SoundFile",
      "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": "/sound_files/10003",
      "routes_edit_path": "/sound_files/10003/edit",
      "external_record_id": null,
      "company_id": 10002,
      "name": "Greeting",
      "description": "Standard greeting played at the start of a call",
      "token_values_count": 0,
      "sound_playlist_ids": [],
      "audio_file_url": "/greetings/sound_file/audio_file/2-10003/a0d49c48545bcaaf801ee2f44f8f73cb/original/greeting.mp3",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "sound_files",
    "page": 1,
    "total_pages": 2,
    "per_page": 2,
    "total_count": 3,
    "next_cursor": 10004
  }
}

GET /sound_files/new

Authorization Required

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

Build Sound File with defaults.

Builds a Sound File record with default attributes without saving it.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
audio_file Optional Blank value allowed	Audio File Must be a valid file upload.
sound_playlist_ids Optional Blank value allowed	The Playlists this sound file belongs to. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Sound Playlist. Refer to: /api/docs/1.0/sound_playlists
token_value_ids Optional Blank value allowed	Play this sound file only when the call matches these Tokens. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sound_file": {
    "id": null,
    "type": "SoundFile",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sound_files/new",
    "routes_edit_path": "/sound_files/new",
    "external_record_id": null,
    "company_id": 10001,
    "name": null,
    "description": null,
    "token_values_count": 0,
    "sound_playlist_ids": [],
    "audio_file_url": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sound_file"
  }
}

POST /sound_files

Authorization Required

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

Create Sound File.

Uploads a new Sound File, supplying a name, description, and the audio_file itself.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
audio_file Optional Blank value allowed	Audio File Must be a valid file upload.
sound_playlist_ids Optional Blank value allowed	The Playlists this sound file belongs to. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Sound Playlist. Refer to: /api/docs/1.0/sound_playlists
token_value_ids Optional Blank value allowed	Play this sound file only when the call matches these Tokens. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/sound_files/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -F 'name=Example Sound File' \
  -F 'description=Played at the start of a call' \
  -F 'audio_file=@greeting.mp3'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "sound_file": {
    "id": 10001,
    "type": "SoundFile",
    "uuid": null,
    "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": "/sound_files/10001",
    "routes_edit_path": "/sound_files/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Sound File",
    "description": "Played at the start of a call",
    "token_values_count": 0,
    "sound_playlist_ids": [],
    "audio_file_url": "/greetings/sound_file/audio_file/2-10001/a0d49c48545bcaaf801ee2f44f8f73cb/original/greeting.mp3",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sound_file"
  }
}

GET /sound_files/:id

Authorization Required

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

Get Sound File by id.

Retrieves a Sound File's details by id.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sound_file": {
    "id": 10001,
    "type": "SoundFile",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T14:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sound_files/10001",
    "routes_edit_path": "/sound_files/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Sound File (renamed)",
    "description": "Standard greeting played at the start of a call",
    "token_values_count": 0,
    "sound_playlist_ids": [],
    "audio_file_url": "/greetings/sound_file/audio_file/2-1/a0d49c48545bcaaf801ee2f44f8f73cb/original/greeting.mp3",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sound_file"
  }
}

PUT /sound_files/:id

Authorization Required

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

Update Sound File by id.

Updates a Sound File's name or description, or replaces its audio_file.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
audio_file Optional Blank value allowed	Audio File Must be a valid file upload.
sound_playlist_ids Optional Blank value allowed	The Playlists this sound file belongs to. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Sound Playlist. Refer to: /api/docs/1.0/sound_playlists
token_value_ids Optional Blank value allowed	Play this sound file only when the call matches these Tokens. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/sound_files/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Sound File (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sound_file": {
    "id": 10001,
    "type": "SoundFile",
    "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": "/sound_files/10001",
    "routes_edit_path": "/sound_files/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Sound File (renamed)",
    "description": "Played at the start of a call",
    "token_values_count": 0,
    "sound_playlist_ids": [],
    "audio_file_url": "/greetings/sound_file/audio_file/2-10001/a0d49c48545bcaaf801ee2f44f8f73cb/original/greeting.mp3",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sound_file"
  }
}

DELETE /sound_files/:id

Authorization Required

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

Destroy Sound File by id.

Deletes a Sound File by id.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/sound_files/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 204

Params

Must be any combination of:

Params

Params

Params