Agents: Statuses API resource for managing Agent Statuses.

GET /api/v1/agent_statuses
List Agent Status 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
  • sortable_order
  • key
  • name
  • hint
  • text_color
  • background_color
  • mute_hold_music
  • pause_agent
  • unpause_agent
  • system_status
  • agent_billable
  • hangup_agent_conference
  • challenge_idle_conference
  • enable_enter_sound
  • enable_exit_sound
  • agent_pause_or_unpause
  • sound_playlist_id
  • skip_placing_outbound_calls
  • speak_lead_name_to_agent
  • speak_lead_name_text
  • timeout_agent_status_enabled
  • timeout_agent_status_seconds
  • timeout_agent_status_apply_alternate_id
  • start_agent_conference
  • park_agent
  • schedule_action_group_id
  • speak_name_record_token_filter_id
  • speak_name_record_token_filter_data_count
  • speak_name_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/agent_statuses/new
Build Agent Status with defaults.

Params

Param name
Description
Validations
key
Optional Blank Value Allowed

Key

Validations:

  • Must be a String
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
hint
Optional Blank Value Allowed

Hint

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

Translation missing: en.api.agent_statuses.pause_agent

Validations:

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

Translation missing: en.api.agent_statuses.unpause_agent

Validations:

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

Translation missing: en.api.agent_statuses.agent_billable

Validations:

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

Translation missing: en.api.agent_statuses.schedule_action_group_id

Validations:

  • Must be a String

POST /api/v1/agent_statuses
Create Agent Status.

Params

Param name
Description
Validations
key
Optional Blank Value Allowed

Key

Validations:

  • Must be a String
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
hint
Optional Blank Value Allowed

Hint

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

Translation missing: en.api.agent_statuses.pause_agent

Validations:

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

Translation missing: en.api.agent_statuses.unpause_agent

Validations:

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

Translation missing: en.api.agent_statuses.agent_billable

Validations:

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

Translation missing: en.api.agent_statuses.schedule_action_group_id

Validations:

  • Must be a String

GET /api/v1/agent_statuses/:id
Get Agent Status by id.

PUT /api/v1/agent_statuses/:id
Update Agent Status by id.

Params

Param name
Description
Validations
key
Optional Blank Value Allowed

Key

Validations:

  • Must be a String
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
hint
Optional Blank Value Allowed

Hint

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

Translation missing: en.api.agent_statuses.pause_agent

Validations:

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

Translation missing: en.api.agent_statuses.unpause_agent

Validations:

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

Translation missing: en.api.agent_statuses.agent_billable

Validations:

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

Translation missing: en.api.agent_statuses.schedule_action_group_id

Validations:

  • Must be a String

DELETE /api/v1/agent_statuses/:id
Destroy Agent Status by id.