API documentation

GET /api/v1/transcription_flows
List Transcription Flow 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_flow_group_id sortable_order name recording_types description transcription_keyword_group_id schedule_action_group_id redact_pii redact_pii_audio redact_pii_sub redact_pii_types record_token_filter_id record_token_filter_data_count record_token_filter_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_flows/new
Build Transcription Flow with defaults.

Params

Param name	Description Validations
transcription_flow_group_id Optional Blank Value Allowed	Transcription Flow Group Validations: Must be a String
name Optional Blank Value Allowed	Name Validations: Must be a String
recording_types Optional Blank Value Allowed	Recording Types Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`
description Optional Blank Value Allowed	Description Validations: Must be a String
record_token_filter_id Optional Blank Value Allowed	Record Token Filter Validations: Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional Blank Value Allowed	Token Value Ids Validations: Must be a decimal number.

POST /api/v1/transcription_flows
Create Transcription Flow.

Params

Param name	Description Validations
transcription_flow_group_id Optional Blank Value Allowed	Transcription Flow Group Validations: Must be a String
name Optional Blank Value Allowed	Name Validations: Must be a String
recording_types Optional Blank Value Allowed	Recording Types Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`
description Optional Blank Value Allowed	Description Validations: Must be a String
record_token_filter_id Optional Blank Value Allowed	Record Token Filter Validations: Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional Blank Value Allowed	Token Value Ids Validations: Must be a decimal number.

GET /api/v1/transcription_flows/:id
Get Transcription Flow by id.

PUT /api/v1/transcription_flows/:id
Update Transcription Flow by id.

Params

Param name	Description Validations
transcription_flow_group_id Optional Blank Value Allowed	Transcription Flow Group Validations: Must be a String
name Optional Blank Value Allowed	Name Validations: Must be a String
recording_types Optional Blank Value Allowed	Recording Types Validations: Must be an array of strings. EG: `["abc123", "xzy023"]`
description Optional Blank Value Allowed	Description Validations: Must be a String
record_token_filter_id Optional Blank Value Allowed	Record Token Filter Validations: Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional Blank Value Allowed	Token Value Ids Validations: Must be a decimal number.

DELETE /api/v1/transcription_flows/:id
Destroy Transcription Flow by id.