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