GET /api/v1/offer_amd_flows
List AMD Flow records.

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
  • offer_id
  • name
  • sortable_order
  • description
  • record_token_filter_id
  • token_value_ids
  • ai_classification_matches
  • ai_speech_text_matches
  • apply_detected_type
  • record_token_filter_data_count
  • record_token_filter_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 /api/v1/offer_amd_flows/new
Build AMD Flow with defaults.

Params

Param name
Description
offer_id
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.offer_id

description
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.description

  • Must be a String

record_token_filter_id
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.record_token_filter_id

token_value_ids
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.token_value_ids

  • Must be a decimal number.

ai_classification_matches
Optional Blank Value Allowed

If Classification Matches

  • Must be a String

ai_speech_text_matches
Optional Blank Value Allowed

Or if Speech To Text Matches

  • Must be a String

apply_detected_type
Optional Blank Value Allowed

Then Apply This Behaviour. When a machine is detected agents will not be connected. When a human is detected, agents will prioritize connecting to the call.

  • Must be a String


Params

Param name
Description
offer_id
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.offer_id

description
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.description

  • Must be a String

record_token_filter_id
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.record_token_filter_id

token_value_ids
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.token_value_ids

  • Must be a decimal number.

ai_classification_matches
Optional Blank Value Allowed

If Classification Matches

  • Must be a String

ai_speech_text_matches
Optional Blank Value Allowed

Or if Speech To Text Matches

  • Must be a String

apply_detected_type
Optional Blank Value Allowed

Then Apply This Behaviour. When a machine is detected agents will not be connected. When a human is detected, agents will prioritize connecting to the call.

  • Must be a String



PUT /api/v1/offer_amd_flows/:id
Update AMD Flow by id.

Params

Param name
Description
offer_id
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.offer_id

description
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.description

  • Must be a String

record_token_filter_id
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.record_token_filter_id

token_value_ids
Optional Blank Value Allowed

Translation missing: en.api.offer_amd_flows.token_value_ids

  • Must be a decimal number.

ai_classification_matches
Optional Blank Value Allowed

If Classification Matches

  • Must be a String

ai_speech_text_matches
Optional Blank Value Allowed

Or if Speech To Text Matches

  • Must be a String

apply_detected_type
Optional Blank Value Allowed

Then Apply This Behaviour. When a machine is detected agents will not be connected. When a human is detected, agents will prioritize connecting to the call.

  • Must be a String


DELETE /api/v1/offer_amd_flows/:id
Destroy AMD Flow by id.