Transcription Keyword

Defines keywords or phrases to detect in call transcripts, and which audio channel to scan.

GET /transcription_keywords

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keywords

List Transcription Keyword records.

Returns the Transcription Keywords on the account, the individual keyword-spotting rules that flag specified words or phrases when they appear in a calls transcription. Supports the standard pagination and filtering parameters plus filtering by a list of ids. Requires superuser access.

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
  • transcription_keyword_group_id
  • detection_channel
  • sortable_order
  • keywords
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_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 /transcription_keywords/new

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keywords/new

Build Transcription Keyword with defaults.

Returns a Transcription Keyword built with default attributes, including detection_channel defaulting to all, for previewing available fields before creating one. It is not saved. Requires superuser access.

Params

Param name Description
transcription_keyword_group_id
Optional Blank value allowed

Transcription Keyword Group

  • Must be a String
detection_channel
Optional Blank value allowed

Detection Channel

  • Must be one of: caller, others, all.
key
Optional Blank value allowed

Key

  • Must be a String
values
Optional Blank value allowed

Values

  • Must be a String
record_token_additional_id
Optional Blank value allowed

Record Token Additional

  • Must be a String
attribution_token_value_ids
Optional Blank value allowed

Attribution Token Value Ids

  • Must be a decimal number.
keywords
Optional Blank value allowed

Keywords

  • Must be an array of strings. EG: ["abc123", "xzy023"]
description
Optional Blank value allowed

A note describing what this Transcription Keyword detects, shown when managing your keywords.

  • Must be a String
record_token_additional_list
Optional Blank value allowed

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

  • Must be a valid list of tokens. Example tokens:
    buyer_interest:loan,another_token:value

POST /transcription_keywords

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keywords

Create Transcription Keyword.

Creates a Transcription Keyword within a Transcription Keyword Group. keywords lists the words or phrases to watch for, and detection_channel controls whether spotting runs against the callers audio, the other partys audio, or both (all). Requires superuser access.

Params

Param name Description
transcription_keyword_group_id
Optional Blank value allowed

Transcription Keyword Group

  • Must be a String
detection_channel
Optional Blank value allowed

Detection Channel

  • Must be one of: caller, others, all.
key
Optional Blank value allowed

Key

  • Must be a String
values
Optional Blank value allowed

Values

  • Must be a String
record_token_additional_id
Optional Blank value allowed

Record Token Additional

  • Must be a String
attribution_token_value_ids
Optional Blank value allowed

Attribution Token Value Ids

  • Must be a decimal number.
keywords
Optional Blank value allowed

Keywords

  • Must be an array of strings. EG: ["abc123", "xzy023"]
description
Optional Blank value allowed

A note describing what this Transcription Keyword detects, shown when managing your keywords.

  • Must be a String
record_token_additional_list
Optional Blank value allowed

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

  • Must be a valid list of tokens. Example tokens:
    buyer_interest:loan,another_token:value

GET /transcription_keywords/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keywords/:id

Get Transcription Keyword by id.

Returns a single Transcription Keyword by id, scoped to the current company. Requires superuser access.

PUT /transcription_keywords/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keywords/:id

Update Transcription Keyword by id.

Updates a Transcription Keywords keyword list, detection channel, group, or description by id. Requires superuser access.

Params

Param name Description
transcription_keyword_group_id
Optional Blank value allowed

Transcription Keyword Group

  • Must be a String
detection_channel
Optional Blank value allowed

Detection Channel

  • Must be one of: caller, others, all.
key
Optional Blank value allowed

Key

  • Must be a String
values
Optional Blank value allowed

Values

  • Must be a String
record_token_additional_id
Optional Blank value allowed

Record Token Additional

  • Must be a String
attribution_token_value_ids
Optional Blank value allowed

Attribution Token Value Ids

  • Must be a decimal number.
keywords
Optional Blank value allowed

Keywords

  • Must be an array of strings. EG: ["abc123", "xzy023"]
description
Optional Blank value allowed

A note describing what this Transcription Keyword detects, shown when managing your keywords.

  • Must be a String
record_token_additional_list
Optional Blank value allowed

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

  • Must be a valid list of tokens. Example tokens:
    buyer_interest:loan,another_token:value

DELETE /transcription_keywords/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/transcription_keywords/:id

Destroy Transcription Keyword by id.

Soft deletes a Transcription Keyword by id, excluding it from future keyword-spotting runs without permanently removing the record. Requires superuser access.