API Audio Transcriptions
Speech-to-text transcripts generated from an audio file you submit directly, independent of any call or lead.
GET /standalone_transcriptions
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/standalone_transcriptions
List Standalone Transcription records.
Returns Standalone Transcriptions: audio files submitted for transcription independent of a Trackdrive call or lead. Defaults to the current day if no date range is given. Restricted to account superusers.
Params
| Param name | Description |
|---|---|
|
ids Optional |
Return records matching these ids.
|
|
page Optional |
Return the next page of results.
|
|
per_page Optional |
How many results to return per page. The default is 25.
|
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
|
fulltext Optional |
Search for any record that matches this text
|
|
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:
|
|
root Optional |
Pass
|
GET /standalone_transcriptions/new
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/standalone_transcriptions/new
Build Standalone Transcription with defaults.
Returns a Standalone Transcription built with default attributes for previewing available fields. It is not saved.
Params
| Param name | Description |
|---|---|
|
file_url Optional |
Audio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.
|
|
postback_url Optional |
Postback URL that we will send the following JSON payload to when the transcription is complete: id, highlighted_utterances, keywords, data, body, utterances, file_url
|
|
caller_id Optional Blank value allowed |
Caller ID associated with the audio file, which may be used for addition triggers and actions.
|
|
dual_channel Optional Blank value allowed |
Is the audio file dual channel?
|
|
speakers Optional Blank value allowed |
Number of people (speakers) in the audio file.
|
|
highlight_wrapper_open Optional Blank value allowed |
When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”
|
|
highlight_wrapper_close Optional Blank value allowed |
When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”
|
|
transcription_flow_group_id Optional Blank value allowed |
Transcription Flow Group that will be used to process the transcription. This will be used even if an Offer with a Transcription Flow Group is provided.
|
|
offer_id Optional Blank value allowed |
Offer that will be used to process the transcription. This will be used if a Transcription Flow Group is not provided, as long as the Offer has a Transcription Flow Group.
|
|
data Optional Blank value allowed |
A JSON object that is used to store information to filter Transcription Flows and Schedule Action Groups. It is automatically updated with Trackdrive tokens (such as zip code, state, etc.). Extra tokens can be applied to Data when specific keywords are found (Transcription Keyword settings), or when an Action is triggered (Action Group > Action settings).
|
POST /standalone_transcriptions
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/standalone_transcriptions
Create Standalone Transcription.
Submits a publicly accessible audio file URL for transcription. Processing is asynchronous and is billed; once complete, Trackdrive posts the resulting transcript, utterances, and detected keywords to the given postback_url. Restricted to account superusers.
Params
| Param name | Description |
|---|---|
|
file_url Required |
Audio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.
|
|
postback_url Required |
Postback URL that we will send the following JSON payload to when the transcription is complete: id, highlighted_utterances, keywords, data, body, utterances, file_url
|
|
caller_id Optional Blank value allowed |
Caller ID associated with the audio file, which may be used for addition triggers and actions.
|
|
dual_channel Optional Blank value allowed |
Is the audio file dual channel?
|
|
speakers Optional Blank value allowed |
Number of people (speakers) in the audio file.
|
|
highlight_wrapper_open Optional Blank value allowed |
When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”
|
|
highlight_wrapper_close Optional Blank value allowed |
When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”
|
|
transcription_flow_group_id Optional Blank value allowed |
Transcription Flow Group that will be used to process the transcription. This will be used even if an Offer with a Transcription Flow Group is provided.
|
|
offer_id Optional Blank value allowed |
Offer that will be used to process the transcription. This will be used if a Transcription Flow Group is not provided, as long as the Offer has a Transcription Flow Group.
|
|
data Optional Blank value allowed |
A JSON object that is used to store information to filter Transcription Flows and Schedule Action Groups. It is automatically updated with Trackdrive tokens (such as zip code, state, etc.). Extra tokens can be applied to Data when specific keywords are found (Transcription Keyword settings), or when an Action is triggered (Action Group > Action settings).
|
GET /standalone_transcriptions/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/standalone_transcriptions/:id
Get Standalone Transcription by id.
Returns a single Standalone Transcription by id, including its processing status and, once complete, the transcript body, utterances, and detected keywords. Restricted to account superusers.
Params
| Param name | Description |
|---|---|
|
caller_id Optional Blank value allowed |
Caller ID associated with the audio file, which may be used for addition triggers and actions.
|
|
dual_channel Optional Blank value allowed |
Is the audio file dual channel?
|
|
speakers Optional Blank value allowed |
Number of people (speakers) in the audio file.
|
|
highlight_wrapper_open Optional Blank value allowed |
When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”
|
|
highlight_wrapper_close Optional Blank value allowed |
When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”
|
|
transcription_flow_group_id Optional Blank value allowed |
Transcription Flow Group that will be used to process the transcription. This will be used even if an Offer with a Transcription Flow Group is provided.
|
|
offer_id Optional Blank value allowed |
Offer that will be used to process the transcription. This will be used if a Transcription Flow Group is not provided, as long as the Offer has a Transcription Flow Group.
|
|
data Optional Blank value allowed |
A JSON object that is used to store information to filter Transcription Flows and Schedule Action Groups. It is automatically updated with Trackdrive tokens (such as zip code, state, etc.). Extra tokens can be applied to Data when specific keywords are found (Transcription Keyword settings), or when an Action is triggered (Action Group > Action settings).
|
|
original_data Optional |
The original data that was provided when the transcription record was created.
|
|
keywords Optional |
Keywords that were found in the audio file.
|
|
utterances Optional |
Utterances are the spoken words in the audio file, broken down by speaker.
|
|
highlighted_utterances Optional |
Highlighted Utterances are the spoken words in the audio file, broken down by speaker, with keywords highlighted.
|
|
transcription_processed Optional |
Returns true if the audio file has been transcribed and keywords have been highlighted.
|
|
audio_duration Optional |
The detected duration of the audio file in seconds.
|
|
body Optional |
The raw transcription text of the audio file.
|
DELETE /standalone_transcriptions/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.com/api/v1/standalone_transcriptions/:id
Destroy Standalone Transcription by id.
Permanently deletes a Standalone Transcription record. Restricted to account superusers.