Key Press Flow Groups

Groups the individual key press actions a caller can use during a call into one reusable set.

GET /key_press_flow_groups

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

List Key Press Flow Group records.

Returns the Key Press Flow Groups on the account, the named containers that hold the individual key press flows (the digit-to-action mappings) used in an IVR menu. Supports the standard pagination and filtering parameters plus filtering by a list of ids.

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
  • name
  • redirect_no_key_press
  • sortable_order
  • description

  • 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 /key_press_flow_groups/new

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

Build Key Press Flow Group with defaults.

Returns a Key Press Flow Group built with default attributes for previewing available fields before creating one. It is not saved.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String
redirect_no_key_press
Optional Blank value allowed

If the caller doesn’t press a key, use the flow configured for no key press instead.

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

POST /key_press_flow_groups

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

Create Key Press Flow Group.

Creates a Key Press Flow Group that acts as a named container for a set of key press flows. The group itself only holds a name and description; the individual key presses inside it are created and managed separately.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String
redirect_no_key_press
Optional Blank value allowed

If the caller doesn’t press a key, use the flow configured for no key press instead.

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

GET /key_press_flow_groups/:id

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

Get Key Press Flow Group by id.

Returns a single Key Press Flow Group by id, scoped to the current company.

PUT /key_press_flow_groups/:id

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

Update Key Press Flow Group by id.

Updates a Key Press Flow Groups name or description by id. The individual key press flows inside the group are not changed by this call.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String
redirect_no_key_press
Optional Blank value allowed

If the caller doesn’t press a key, use the flow configured for no key press instead.

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

DELETE /key_press_flow_groups/:id

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

Destroy Key Press Flow Group by id.

Soft deletes a Key Press Flow Group by id, excluding it from future lookups without permanently removing the record. The key press flows that belonged to it are not deleted along with it.