Agents: Call Actions API resource for managing Call Action.

GET /api/v1/call_control_actions
List Call Action 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:
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
  • system_status
  • key
  • name
  • text_color
  • background_color
  • font_size
  • text_shadow_color
  • require_live_caller
  • filter_group_id
  • sortable_order
  • description
  • css_styles
  • webhook_actions_count
  • open_link_on_click
  • open_link_on_click_href
  • webhook_params_count
  • whisper_sound_playlist_enabled
  • whisper_sound_playlist_id
  • whisper_sound_playlist_target
  • message_type
  • text_to_speech
  • stop_whisper_sound_playlist
  • 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/call_control_actions/new
Build Call Action with defaults.

Params

Param name
Description
Validations
system_status
Optional Blank Value Allowed

System Status

Validations:

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
key
Optional Blank Value Allowed

Key

Validations:

  • Must be a String
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
text_color
Optional Blank Value Allowed

Text Color

Validations:

  • Must be a String
background_color
Optional Blank Value Allowed

Background Color

Validations:

  • Must be a String
font_size
Optional Blank Value Allowed

Font Size

Validations:

  • Must be a decimal number.
text_shadow_color
Optional Blank Value Allowed

Text Shadow Color

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.
filter_group_id
Optional Blank Value Allowed

Filter Group

Validations:

  • Must be a String
description
Optional Blank Value Allowed

Description

Validations:

  • Must be a String

Params

Param name
Description
Validations
system_status
Optional Blank Value Allowed

System Status

Validations:

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
key
Optional Blank Value Allowed

Key

Validations:

  • Must be a String
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
text_color
Optional Blank Value Allowed

Text Color

Validations:

  • Must be a String
background_color
Optional Blank Value Allowed

Background Color

Validations:

  • Must be a String
font_size
Optional Blank Value Allowed

Font Size

Validations:

  • Must be a decimal number.
text_shadow_color
Optional Blank Value Allowed

Text Shadow Color

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.
filter_group_id
Optional Blank Value Allowed

Filter Group

Validations:

  • Must be a String
description
Optional Blank Value Allowed

Description

Validations:

  • Must be a String

PUT /api/v1/call_control_actions/:id
Update Call Action by id.

Params

Param name
Description
Validations
system_status
Optional Blank Value Allowed

System Status

Validations:

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
key
Optional Blank Value Allowed

Key

Validations:

  • Must be a String
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
text_color
Optional Blank Value Allowed

Text Color

Validations:

  • Must be a String
background_color
Optional Blank Value Allowed

Background Color

Validations:

  • Must be a String
font_size
Optional Blank Value Allowed

Font Size

Validations:

  • Must be a decimal number.
text_shadow_color
Optional Blank Value Allowed

Text Shadow Color

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.
filter_group_id
Optional Blank Value Allowed

Filter Group

Validations:

  • Must be a String
description
Optional Blank Value Allowed

Description

Validations:

  • Must be a String