GetHuntGroupAgentSettings

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

hunt_group_sid

integer <int64> | string

hunt_group_sid

optional

Example

{
  "hunt_group_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

statistics

object (AgentStatisticsSettings)

statistics

optional

filter_call_history

enum<string>

filter_call_history

optional

Allowed values:

TODAYSESSION

show_statistics

boolean

show_statistics

optional

show_call_history

boolean

show_call_history

optional

pause

object (PauseSettings)

pause

optional

allow_agent_pause

boolean

allow_agent_pause

optional

allow_agent_pause_reset

boolean

allow_agent_pause_reset

optional

use_agent_pause_codes

boolean

use_agent_pause_codes

optional

default_agent_pause_code

string

default_agent_pause_code

optional

recording_pause_confirmation

boolean

recording_pause_confirmation

optional

recording pause confirmationl -

hqm

object (HoldQueueMonitorSettings)

hqm

optional

agent_routing

enum<string>

agent_routing

optional

Allowed values:

UNKNOWNORIGINAL_AGENT_REQUIREDORIGINAL_AGENT_PREFERREDANY_AGENT

monitor

boolean

monitor

optional

required_group

integer <int64> | string

required_group

optional

preferred_group

integer <int64> | string

preferred_group

optional

manual_dial

object (ManualDialSettings)

manual_dial

optional

use_timezone_validation_zip

enum<string>

use_timezone_validation_zip

optional

Allowed values:

FALSETRUEREQUIRED

manual_dial_data_dip_result_handling

enum<string>

manual_dial_data_dip_result_handling

optional

Configuration on which action to take on data dip failure

Allowed values:

NONECANCELNOTIFY_AND_CANCELNOTIFY_AND_ALLOW_CALLCALL_WITH_ORIGINAL_VALUES

data_dip_manual_dial_integration_handling

enum<string>

data_dip_manual_dial_integration_handling

optional

Configuration for which action to take on data dip parameter replacement failure

Allowed values:

NONECANCELNOTIFY_AND_CANCELNOTIFY_AND_ALLOW_CALLCALL_WITH_ORIGINAL_VALUES

enabled

boolean

enabled

optional

show_outbound_phone_book

boolean

show_outbound_phone_book

optional

show_caller_id_phone_book

boolean

show_caller_id_phone_book

optional

has_custom_caller_id

boolean

has_custom_caller_id

optional

default_caller_id

string

default_caller_id

optional

show_country_selector

boolean

show_country_selector

optional

timezone_restrictions

boolean

timezone_restrictions

optional

scrub_cell_phones

boolean

scrub_cell_phones

optional

call_recording

boolean

call_recording

optional

agent_override_cell

boolean

agent_override_cell

optional

agent_override_ccr

boolean

agent_override_ccr

optional

agent_override_dncl

boolean

agent_override_dncl

optional

agent_override_timezone

boolean

agent_override_timezone

optional

use_white_list

boolean

use_white_list

optional

use_random_caller_id

boolean

use_random_caller_id

optional

display_caller_id_country_select

boolean

display_caller_id_country_select

optional

use_caller_id_bucket

boolean

use_caller_id_bucket

optional

agent_override_natural_compliance

boolean

agent_override_natural_compliance

optional

natural_compliance_rule_set_name

string

natural_compliance_rule_set_name

optional

compliance_metadata

array[object (ComplianceMetadata) {2}]

compliance_metadata

optional

enable_metadata

boolean

enable_metadata

optional

enable_reject_option_for_approvers

boolean

enable_reject_option_for_approvers

deprecated

Control whether the reject option is available to the approvers.
Please use disable_reject_option_for_approvers under GeneralSettings.

enable_sip_address

boolean

enable_sip_address

optional

enable/disable the SIP address

mask_manual_dial_caller_id

boolean

mask_manual_dial_caller_id

optional

mask/unmask the caller id for buckets and statically set caller ids

enable_manual_dial_data_dip

string

enable_manual_dial_data_dip

optional

Manual Dial Data Dip Settings

default_country_sid

integer <int64> | string

default_country_sid

optional

random_caller_id_bucket

integer <int64> | string

random_caller_id_bucket

optional

default_caller_id_country_sid

integer <int64> | string

default_caller_id_country_sid

optional

manual_dial_data_dip_config

integer <int64> | string

manual_dial_data_dip_config

optional

Data dip url id

data_dip_manual_dial_integration

object

data_dip_manual_dial_integration

optional

Configuration for which Manual Dial Data Dip Parameters to replace

transfer

object (TransferSettings)

transfer

optional

requeue_type

enum<string>

requeue_type

optional

Allowed values:

UNKNOWNDEFAULTCURRENTCUSTOM

recording_status

enum<string>

recording_status

optional

Allowed values:

UNKNOWNKEEP_RECORDINGSTOP_RECORDINGSTART_RECORDING

agent_transfer_recording_status

enum<string>

agent_transfer_recording_status

optional

Determines what should happen with the recording status on agent transfers

Allowed values:

UNKNOWNKEEP_RECORDINGSTOP_RECORDINGSTART_RECORDING

requeue_transfer_recording_status

enum<string>

requeue_transfer_recording_status

optional

Determines what should happen with the recording status on requeue transfers

Allowed values:

UNKNOWNKEEP_RECORDINGSTOP_RECORDINGSTART_RECORDING

open_transfer_recording_status

enum<string>

open_transfer_recording_status

optional

Determines what should happen with the recording status on open transfers

Allowed values:

UNKNOWNKEEP_RECORDINGSTOP_RECORDINGSTART_RECORDING

allowed

boolean

allowed

optional

show_filtering

boolean

show_filtering

optional

type

array[string]

type

optional

Allowed values:

UNKNOWNAGENTOPENREQUEUEVOICE_MAILPBX_EXTENSION

show_country_selector

boolean

show_country_selector

optional

has_custom_transfer_number

boolean

has_custom_transfer_number

optional

default_transfer_number

string

default_transfer_number

optional

has_custom_caller_id

boolean

has_custom_caller_id

optional

default_caller_id

string

default_caller_id

optional

show_transfers_phone_book

boolean

show_transfers_phone_book

optional

show_caller_id_phone_book

boolean

show_caller_id_phone_book

optional

hand_off_type

array[string]

hand_off_type

optional

Allowed values:

UNKNOWNCONFERENCEWARMCOLD

show_caller_id_country_selector

boolean

show_caller_id_country_selector

optional

default_filtering_include_all_online_agents

boolean

default_filtering_include_all_online_agents

optional

requeue_type_custom_value

string

requeue_type_custom_value

optional

agent_transfer_hunt_group_filter

boolean

agent_transfer_hunt_group_filter

optional

limit agent transfers to agents in hunt group

natural_compliance_override

boolean

natural_compliance_override

optional

Compliance Settings for call transfers

transfer_natural_compliance_rule_set_name

string

transfer_natural_compliance_rule_set_name

optional

compliance_metadata

array[object (ComplianceMetadata) {2}]

compliance_metadata

optional

call_whitelist

boolean

call_whitelist

optional

default_country_sid

integer <int64> | string

default_country_sid

optional

default_caller_id_country_sid

integer <int64> | string

default_caller_id_country_sid

optional

start_record_transfer_targets

array[string]

start_record_transfer_targets

optional

stop_record_transfer_targets

array[string]

stop_record_transfer_targets

optional

preview_dial

object (PreviewDialSettings)

preview_dial

optional

require_confirmation

boolean

require_confirmation

optional

allow_cancel

boolean

allow_cancel

optional

pause_on_cancel

boolean

pause_on_cancel

optional

timeout_minutes

integer <int64> | string

timeout_minutes

optional

phone_number_activity

object (PhoneNumberActivitySettings)

phone_number_activity

optional

allow_phone_number_activity

boolean

allow_phone_number_activity

optional

allow_export_phone_number_activity

boolean

allow_export_phone_number_activity

optional

allow_pna_recordings_download

boolean

allow_pna_recordings_download

optional

allow_pna_edit_responses

boolean

allow_pna_edit_responses

optional

dncl

object (DnclSettings)

dncl

optional

scrub_lists_expiration_limits

object (ScrubListsExpirationLimits)

scrub_lists_expiration_limits

optional

expiration time options when adding entry to scrub list

allow_dncl_add

boolean

allow_dncl_add

optional

manual_dial_auto_dncl_add

boolean

manual_dial_auto_dncl_add

optional

preview_dial_auto_dncl_add

boolean

preview_dial_auto_dncl_add

optional

agent_responses_auto_dncl_add

boolean

agent_responses_auto_dncl_add

optional

scrub_lists_auto_add_options

array[object (ScrubListsAutoAdd) {3}]

scrub_lists_auto_add_options

optional

scrub list ids and field values used in lookup

display_dncl_options_in_wrapup

boolean

display_dncl_options_in_wrapup

optional

Should Show DNCL Options in Agent Voice Wrapup state

allow_dncl_remove

boolean

allow_dncl_remove

optional

allows agent to remove scrub list entries

default_manual_dncl_expire_hours

integer <int64> | string

default_manual_dncl_expire_hours

optional

default_preview_dncl_expire_hours

integer <int64> | string

default_preview_dncl_expire_hours

optional

default_dncl_country

integer <int64> | string

default_dncl_country

optional

default_outbound_dncl_expire_hours

integer <int64> | string

default_outbound_dncl_expire_hours

optional

default_inbound_dncl_expire_hours

integer <int64> | string

default_inbound_dncl_expire_hours

optional

hunt_group_compliance_scrub_lists

array[string]

hunt_group_compliance_scrub_lists

optional

list of scrub lists to add dncls to

hunt_group_compliance_scrub_lists_removal_allowed

array[string]

hunt_group_compliance_scrub_lists_removal_allowed

optional

scrub list ids used in lookup for allowed entry removal

hold

object (AgentHoldSettings)

hold

optional

allowed

enum<string>

allowed

optional

Allowed values:

NONESIMPLEMULTIBOTH

auto_pause_on_multi_hold

boolean

auto_pause_on_multi_hold

optional

manual_approval

object (ManualApprovalSettings)

manual_approval

optional

allowed

boolean

allowed

optional

confirm

boolean

confirm

optional

sms_allowed

boolean

sms_allowed

optional

sms_number_confirmation

boolean

sms_number_confirmation

optional

disable_reject_option_for_approvers

boolean

disable_reject_option_for_approvers

optional

Control whether the reject option is available to the approvers.

schedule_callback

object (ScheduleCallBackSettings)

schedule_callback

optional

allow_callback_scheduling

boolean

allow_callback_scheduling

optional

allow_scheduled_callback_calling

boolean

allow_scheduled_callback_calling

optional

allow_automatic_callback_retrieval_mode

boolean

allow_automatic_callback_retrieval_mode

optional

allow_default_callback_routing

boolean

allow_default_callback_routing

optional

callbacks_retrieval_mode_settings

string

callbacks_retrieval_mode_settings

optional

default_callback_routing_settings

string

default_callback_routing_settings

optional

callbacks_service_id

string

callbacks_service_id

optional

has_custom_caller_id

boolean

has_custom_caller_id

optional

agent can edit caller id in scheduled callbacks

default_caller_id

string

default_caller_id

optional

default caller id for scheduled callbacks

allow_scheduled_callback_calendar

boolean

allow_scheduled_callback_calendar

optional

agent can view the scheduled callback calendar

recording

object (RecordingSettings)

recording

optional

display_indicator

boolean

display_indicator

optional

enable_pause

boolean

enable_pause

optional

enable_delay

boolean

enable_delay

optional

pause_recording_on_hold

boolean

pause_recording_on_hold

optional

determines if the recording will pause while the agent is on hold

delay

integer <int64> | string

delay

optional

display_data_settings

object (DisplayDataSettings)

display_data_settings

optional

display_data_dip

enum<string>

display_data_dip

optional

Allowed values:

NONEALLLIMITED

display_data_collect

boolean

display_data_collect

optional

display_ivr_navigation

boolean

display_ivr_navigation

optional

display_sip_header_data

boolean

display_sip_header_data

optional

display_data_dip_keys

array[string]

display_data_dip_keys

optional

keypad_enabled

boolean

keypad_enabled

optional

keypad_delimiter

string

keypad_delimiter

optional

end_call_confirmation

boolean

end_call_confirmation

optional

display_linkback_huntgroup

boolean

display_linkback_huntgroup

optional

display_phone_zip_metadata

boolean

display_phone_zip_metadata

optional

display_machine_deliver

boolean

display_machine_deliver

optional

allow_agent_intercom

boolean

allow_agent_intercom

optional

allow_change_hunt_group

boolean

allow_change_hunt_group

optional

agent_screen_recording

boolean

agent_screen_recording

optional

inbound_compliance_metadata

array[object (ComplianceMetadata) {2}]

inbound_compliance_metadata

optional

name

string

name

optional

required

boolean

required

optional

notify_queued_calls

boolean

notify_queued_calls

optional

display_journey_retrieved_data

boolean

display_journey_retrieved_data

optional

display_web_links

boolean

display_web_links

optional

determines if agent can see web links

display_skills

boolean

display_skills

optional

determines if agent can see skills

interrupt_peering

array[string]

interrupt_peering

optional

Array of interruptable call states (manual, preview, both manual and preview)

Allowed values:

InterruptPeeringStatus_MANUALInterruptPeeringStatus_PREVIEW

display_integration_data_map

boolean

display_integration_data_map

optional

phone_zip_metadata_keys

array[string]

phone_zip_metadata_keys

optional

limit_journey_retrieved_data

array[string]

limit_journey_retrieved_data

optional

initial_agent_status

integer <int64> | string

initial_agent_status

optional

initial agent status

limit_integration_data_map

array[string]

limit_integration_data_map

optional

Example

{
  "statistics": {
    "filter_call_history": "TODAY",
    "show_statistics": true,
    "show_call_history": true
  },
  "pause": {
    "allow_agent_pause": true,
    "allow_agent_pause_reset": true,
    "use_agent_pause_codes": true,
    "default_agent_pause_code": "string",
    "recording_pause_confirmation": true
  },
  "hqm": {
    "agent_routing": "UNKNOWN",
    "monitor": true,
    "required_group": 0,
    "preferred_group": 0
  },
  "manual_dial": {
    "use_timezone_validation_zip": "FALSE",
    "manual_dial_data_dip_result_handling": "NONE",
    "data_dip_manual_dial_integration_handling": "NONE",
    "enabled": true,
    "show_outbound_phone_book": true,
    "show_caller_id_phone_book": true,
    "has_custom_caller_id": true,
    "default_caller_id": "string",
    "show_country_selector": true,
    "timezone_restrictions": true,
    "scrub_cell_phones": true,
    "call_recording": true,
    "agent_override_cell": true,
    "agent_override_ccr": true,
    "agent_override_dncl": true,
    "agent_override_timezone": true,
    "use_white_list": true,
    "use_random_caller_id": true,
    "display_caller_id_country_select": true,
    "use_caller_id_bucket": true,
    "agent_override_natural_compliance": true,
    "natural_compliance_rule_set_name": "string",
    "compliance_metadata": [
      {
        "name": "string",
        "required": true
      }
    ],
    "enable_metadata": true,
    "enable_reject_option_for_approvers": true,
    "enable_sip_address": true,
    "mask_manual_dial_caller_id": true,
    "enable_manual_dial_data_dip": "string",
    "default_country_sid": 0,
    "random_caller_id_bucket": 0,
    "default_caller_id_country_sid": 0,
    "manual_dial_data_dip_config": 0,
    "data_dip_manual_dial_integration": {
      "property1": "string",
      "property2": "string"
    }
  },
  "transfer": {
    "requeue_type": "UNKNOWN",
    "recording_status": "UNKNOWN",
    "agent_transfer_recording_status": "UNKNOWN",
    "requeue_transfer_recording_status": "UNKNOWN",
    "open_transfer_recording_status": "UNKNOWN",
    "allowed": true,
    "show_filtering": true,
    "type": [
      "UNKNOWN"
    ],
    "show_country_selector": true,
    "has_custom_transfer_number": true,
    "default_transfer_number": "string",
    "has_custom_caller_id": true,
    "default_caller_id": "string",
    "show_transfers_phone_book": true,
    "show_caller_id_phone_book": true,
    "hand_off_type": [
      "UNKNOWN"
    ],
    "show_caller_id_country_selector": true,
    "default_filtering_include_all_online_agents": true,
    "requeue_type_custom_value": "string",
    "agent_transfer_hunt_group_filter": true,
    "natural_compliance_override": true,
    "transfer_natural_compliance_rule_set_name": "string",
    "compliance_metadata": [
      {
        "name": "string",
        "required": true
      }
    ],
    "call_whitelist": true,
    "default_country_sid": 0,
    "default_caller_id_country_sid": 0,
    "start_record_transfer_targets": [
      "string"
    ],
    "stop_record_transfer_targets": [
      "string"
    ]
  },
  "preview_dial": {
    "require_confirmation": true,
    "allow_cancel": true,
    "pause_on_cancel": true,
    "timeout_minutes": 0
  },
  "phone_number_activity": {
    "allow_phone_number_activity": true,
    "allow_export_phone_number_activity": true,
    "allow_pna_recordings_download": true,
    "allow_pna_edit_responses": true
  },
  "dncl": {
    "scrub_lists_expiration_limits": {
      "outbound_expiration_limit": [
        0
      ],
      "inbound_expiration_limit": [
        0
      ],
      "manual_dial_expiration_limit": [
        0
      ],
      "preview_dial_expiration_limit": [
        0
      ]
    },
    "allow_dncl_add": true,
    "manual_dial_auto_dncl_add": true,
    "preview_dial_auto_dncl_add": true,
    "agent_responses_auto_dncl_add": true,
    "scrub_lists_auto_add_options": [
      {
        "scrub_list": "string",
        "field_id": "string",
        "field_name": "string"
      }
    ],
    "display_dncl_options_in_wrapup": true,
    "allow_dncl_remove": true,
    "default_manual_dncl_expire_hours": 0,
    "default_preview_dncl_expire_hours": 0,
    "default_dncl_country": 0,
    "default_outbound_dncl_expire_hours": 0,
    "default_inbound_dncl_expire_hours": 0,
    "hunt_group_compliance_scrub_lists": [
      "string"
    ],
    "hunt_group_compliance_scrub_lists_removal_allowed": [
      "string"
    ]
  },
  "hold": {
    "allowed": "NONE",
    "auto_pause_on_multi_hold": true
  },
  "manual_approval": {
    "allowed": true,
    "confirm": true,
    "sms_allowed": true,
    "sms_number_confirmation": true,
    "disable_reject_option_for_approvers": true
  },
  "schedule_callback": {
    "allow_callback_scheduling": true,
    "allow_scheduled_callback_calling": true,
    "allow_automatic_callback_retrieval_mode": true,
    "allow_default_callback_routing": true,
    "callbacks_retrieval_mode_settings": "string",
    "default_callback_routing_settings": "string",
    "callbacks_service_id": "string",
    "has_custom_caller_id": true,
    "default_caller_id": "string",
    "allow_scheduled_callback_calendar": true
  },
  "recording": {
    "display_indicator": true,
    "enable_pause": true,
    "enable_delay": true,
    "pause_recording_on_hold": true,
    "delay": 0
  },
  "display_data_settings": {
    "display_data_dip": "NONE",
    "display_data_collect": true,
    "display_ivr_navigation": true,
    "display_sip_header_data": true,
    "display_data_dip_keys": [
      "string"
    ]
  },
  "keypad_enabled": true,
  "keypad_delimiter": "string",
  "end_call_confirmation": true,
  "display_linkback_huntgroup": true,
  "display_phone_zip_metadata": true,
  "display_machine_deliver": true,
  "allow_agent_intercom": true,
  "allow_change_hunt_group": true,
  "agent_screen_recording": true,
  "inbound_compliance_metadata": [
    {
      "name": "string",
      "required": true
    }
  ],
  "notify_queued_calls": true,
  "display_journey_retrieved_data": true,
  "display_web_links": true,
  "display_skills": true,
  "interrupt_peering": [
    "InterruptPeeringStatus_MANUAL"
  ],
  "display_integration_data_map": true,
  "phone_zip_metadata_keys": [
    "string"
  ],
  "limit_journey_retrieved_data": [
    "string"
  ],
  "initial_agent_status": 0,
  "limit_integration_data_map": [
    "string"
  ]
}

🔴500Server Error