Agents: Call Dispositions API resource for managing Call Disposition.

GET /api/v1/call_dispositions
List Call Disposition 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
  • sortable_order
  • key
  • name
  • hint
  • show_on_agent_widget
  • show_in_tables
  • show_in_reports
  • apply_call_answered
  • apply_agent_handled
  • apply_buyer_handled
  • apply_qualified
  • schedule_callback_now
  • apply_end_of_schedule
  • apply_block_caller
  • apply_auto_next_lead
  • notes_required
  • font_size
  • text_shadow_color
  • text_color
  • background_color
  • line_height
  • context_menu_name
  • call_action_leave_voicemail
  • call_action_apply_opt_out
  • system_status
  • use_when_blank
  • apply_machine_detected
  • schedule_id
  • call_disposition_action_ids
  • reuse_conference
  • apply_add_to_schedule_suppression
  • delete_scheduled_callbacks
  • scheduled_callback_chance
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_data
  • 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/call_dispositions/new
Build Call Disposition with defaults.

Params

Param name
Description
Validations
key
Optional Blank Value Allowed

The internal token name where values are stored.

Validations:

  • Must be a String
name
Optional Blank Value Allowed

The friendly human name displayed to users.

Validations:

  • Must be a String
hint
Optional Blank Value Allowed

Display a helpful hint to users explaining the purpose of this disposition.

Validations:

  • Must be a String
show_on_agent_widget
Optional Blank Value Allowed

Show this disposition on the agent widget?

Validations:

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

Show this disposition as a column on tables?

Validations:

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

Show this disposition as a column on reports?

Validations:

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

Mark the call as having been answered?

Validations:

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

Mark the call as having been handled by an agent?

Validations:

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

Mark the call as having been handled by a buyer?

Validations:

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

Mark the call as having been qualified?

Validations:

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

Trigger the end of schedule when selecting this disposition?

Validations:

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

Block the caller when selecting this disposition?

Validations:

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

Automatically move to the next lead after selecting this disposition?

Validations:

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

Require the agent to write notes about this call?

Validations:

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

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

Validations:

  • Must be a decimal number.

POST /api/v1/call_dispositions
Create Call Disposition.

Params

Param name
Description
Validations
key
Required

The internal token name where values are stored.

Validations:

  • Must be a String
name
Required

The friendly human name displayed to users.

Validations:

  • Must be a String
hint
Optional Blank Value Allowed

Display a helpful hint to users explaining the purpose of this disposition.

Validations:

  • Must be a String
show_on_agent_widget
Optional Blank Value Allowed

Show this disposition on the agent widget?

Validations:

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

Show this disposition as a column on tables?

Validations:

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

Show this disposition as a column on reports?

Validations:

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

Mark the call as having been answered?

Validations:

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

Mark the call as having been handled by an agent?

Validations:

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

Mark the call as having been handled by a buyer?

Validations:

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

Mark the call as having been qualified?

Validations:

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

Trigger the end of schedule when selecting this disposition?

Validations:

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

Block the caller when selecting this disposition?

Validations:

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

Automatically move to the next lead after selecting this disposition?

Validations:

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

Require the agent to write notes about this call?

Validations:

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

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

Validations:

  • Must be a decimal number.

GET /api/v1/call_dispositions/:id
Get Call Disposition by id.

PUT /api/v1/call_dispositions/:id
Update Call Disposition by id.

Params

Param name
Description
Validations
key
Optional Blank Value Allowed

The internal token name where values are stored.

Validations:

  • Must be a String
name
Optional Blank Value Allowed

The friendly human name displayed to users.

Validations:

  • Must be a String
hint
Optional Blank Value Allowed

Display a helpful hint to users explaining the purpose of this disposition.

Validations:

  • Must be a String
show_on_agent_widget
Optional Blank Value Allowed

Show this disposition on the agent widget?

Validations:

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

Show this disposition as a column on tables?

Validations:

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

Show this disposition as a column on reports?

Validations:

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

Mark the call as having been answered?

Validations:

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

Mark the call as having been handled by an agent?

Validations:

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

Mark the call as having been handled by a buyer?

Validations:

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

Mark the call as having been qualified?

Validations:

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

Trigger the end of schedule when selecting this disposition?

Validations:

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

Block the caller when selecting this disposition?

Validations:

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

Automatically move to the next lead after selecting this disposition?

Validations:

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

Require the agent to write notes about this call?

Validations:

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

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

Validations:

  • Must be a decimal number.

DELETE /api/v1/call_dispositions/:id
Destroy Call Disposition by id.