Standalone Transcription API resource for managing Standalone Transcription.

GET /api/v1/standalone_transcriptions
List Standalone Transcription records.

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
  • file_url
  • transcription_flow_group_id
  • postback_url
  • dual_channel
  • speakers
  • body
  • highlight_wrapper_open
  • highlight_wrapper_close
  • audio_duration
  • transcription_processed
  • keywords
  • utterances
  • highlighted_utterances
  • caller_id
  • data
  • original_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

GET /api/v1/standalone_transcriptions/new
Build Standalone Transcription with defaults.

Params

Param name
Description
file_url
Optional

Audio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.

  • Must be a String
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

  • Must be a String
caller_id
Optional Blank Value Allowed

Caller ID associated with the audio file, which may be used for addition triggers and actions.

  • Must be a String
dual_channel
Optional Blank Value Allowed

Is the audio file dual channel?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
speakers
Optional Blank Value Allowed

Number of people (speakers) in the audio file.

  • Must be a decimal number.
highlight_wrapper_open
Optional Blank Value Allowed

When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”

  • Must be a String
highlight_wrapper_close
Optional Blank Value Allowed

When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”

  • Must be a String
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).

  • Must be a Hash

POST /api/v1/standalone_transcriptions
Create Standalone Transcription.

Examples

# Submit standalone transcriptions as JSON:
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{"caller_id":"+18004506787","file_url":"http://example.com/publicly_accessible_file.mp3","postback_url":"http://example.com/postback_url_without_authentication","data":{"loan_amount":"501","custom_token":"the_value"}}' \
     "https://[your-subdomain].trackdrive.com/api/v1/standalone_transcriptions"

Params

Param name
Description
file_url
Required

Audio File URL location. This must be a publicly accessible URL, and cannot have IP restrictions.

  • Must be a String
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

  • Must be a String
caller_id
Optional Blank Value Allowed

Caller ID associated with the audio file, which may be used for addition triggers and actions.

  • Must be a String
dual_channel
Optional Blank Value Allowed

Is the audio file dual channel?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
speakers
Optional Blank Value Allowed

Number of people (speakers) in the audio file.

  • Must be a decimal number.
highlight_wrapper_open
Optional Blank Value Allowed

When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”

  • Must be a String
highlight_wrapper_close
Optional Blank Value Allowed

When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”

  • Must be a String
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).

  • Must be a Hash

GET /api/v1/standalone_transcriptions/:id
Get Standalone Transcription by id.

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.

  • Must be a String
dual_channel
Optional Blank Value Allowed

Is the audio file dual channel?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
speakers
Optional Blank Value Allowed

Number of people (speakers) in the audio file.

  • Must be a decimal number.
highlight_wrapper_open
Optional Blank Value Allowed

When keywords are highlighted, this is the opening tag, e.g. “This is a {{keyword}}.”

  • Must be a String
highlight_wrapper_close
Optional Blank Value Allowed

When keywords are highlighted, this is the closing tag, e.g. “This is a {{keyword}}.”

  • Must be a String
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).

  • Must be a Hash
original_data
Optional

The original data that was provided when the transcription record was created.

  • Must be a Hash
keywords
Optional

Keywords that were found in the audio file.

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

Utterances are the spoken words in the audio file, broken down by speaker.

  • Must be a Hash
highlighted_utterances
Optional

Highlighted Utterances are the spoken words in the audio file, broken down by speaker, with keywords highlighted.

  • Must be a Hash
transcription_processed
Optional

Returns true if the audio file has been transcribed and keywords have been highlighted.

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

The detected duration of the audio file in seconds.

  • Must be a decimal number.
body
Optional

The raw transcription text of the audio file.

  • Must be a String

DELETE /api/v1/standalone_transcriptions/:id
Destroy Standalone Transcription by id.