API documentation

GET /api/v1/transcription_keywords
List Transcription Keyword records.

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: 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 transcription_keyword_group_id detection_channel sortable_order keywords record_token_additional_id record_token_additional_data_count record_token_additional_data Validations: 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: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/transcription_keywords/new
Build Transcription Keyword with defaults.

Params

Param name	Description Validations
transcription_keyword_group_id Optional Blank Value Allowed	Transcription Keyword Group Validations: Must be a String
detection_channel Optional Blank Value Allowed	Detection Channel Validations: Must be one of: `caller`, `others`, `all`.
key Optional Blank Value Allowed	Key Validations: Must be a String
operator Optional Blank Value Allowed	Operator Validations: Must be a String
values Optional Blank Value Allowed	Values Validations: Must be a String
record_token_additional_id Optional Blank Value Allowed	Record Token Additional Validations: Must be a String
attribution_token_value_ids Optional Blank Value Allowed	Attribution Token Value Ids Validations: Must be a decimal number.
keywords Optional Blank Value Allowed	Keywords Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`

POST /api/v1/transcription_keywords
Create Transcription Keyword.

Params

Param name	Description Validations
transcription_keyword_group_id Optional Blank Value Allowed	Transcription Keyword Group Validations: Must be a String
detection_channel Optional Blank Value Allowed	Detection Channel Validations: Must be one of: `caller`, `others`, `all`.
key Optional Blank Value Allowed	Key Validations: Must be a String
operator Optional Blank Value Allowed	Operator Validations: Must be a String
values Optional Blank Value Allowed	Values Validations: Must be a String
record_token_additional_id Optional Blank Value Allowed	Record Token Additional Validations: Must be a String
attribution_token_value_ids Optional Blank Value Allowed	Attribution Token Value Ids Validations: Must be a decimal number.
keywords Optional Blank Value Allowed	Keywords Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`

GET /api/v1/transcription_keywords/:id
Get Transcription Keyword by id.

PUT /api/v1/transcription_keywords/:id
Update Transcription Keyword by id.

Params

Param name	Description Validations
transcription_keyword_group_id Optional Blank Value Allowed	Transcription Keyword Group Validations: Must be a String
detection_channel Optional Blank Value Allowed	Detection Channel Validations: Must be one of: `caller`, `others`, `all`.
key Optional Blank Value Allowed	Key Validations: Must be a String
operator Optional Blank Value Allowed	Operator Validations: Must be a String
values Optional Blank Value Allowed	Values Validations: Must be a String
record_token_additional_id Optional Blank Value Allowed	Record Token Additional Validations: Must be a String
attribution_token_value_ids Optional Blank Value Allowed	Attribution Token Value Ids Validations: Must be a decimal number.
keywords Optional Blank Value Allowed	Keywords Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`

DELETE /api/v1/transcription_keywords/:id
Destroy Transcription Keyword by id.