Org_GetHuntGroupSettings

GetHuntGroupSettings returns the field masked hunt group settings for the
provided hunt group.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Request message for the GetHuntGroupSettings RPC method.

huntGroupSid

string

optional

Hunt group sid.

fieldMask

string <field-mask>

optional

Field mask containing the fields to retrieve.

Example

Responses

🟢200OK

application/json

Body

Response message for the GetHuntGroupSettings RPC method.

generalSettings

object

optional

Hunt group general settings to be retrieved.

enableAgentGatewayTitleBar

boolean

optional

Displays browser window tab information. UseAdvancedGatewayTitle

defaultAgentDialIn

string

optional

Default agent phone number dialing into IVR system. AgentDialInNumber

requireEndCallConfirmation

boolean

optional

Requires secondary confirmation to end call. DisconnectConfirmation

enableAuthorizationByIp

boolean

optional

Enables authorization and whitelist by IP. UseIpBasedAuth

initialAgentStatus

integer

optional

Initial agent status. Initial Agent Status

enableAgentPause

boolean

optional

Enable agents to pause calls. Allow Agent Pause

defaultAgentPauseOption

string

optional

Default agent pause code. Default Agent Pause Code

enablePauseOptionReset

boolean

optional

Enable agents to switch between pause options. Agent Pause Reset

triggeredPauseStatusPauseCodeWaiting

string

optional

Use this pause code instead of the trigger generated one.

triggeredPauseStatusPauseCodeWrapup

string

optional

Use this pause code instead of the trigger generated one.

displayRecordingIndicator

boolean

optional

Display recording indicator. Display Recording Indicator

enableCallRecordingPause

boolean

optional

Enable pausing of agent call recording. Enable Recording Pause

callRecordingPauseConfirmation

boolean

optional

Require call recording pause confirmation. Recording Pause Confirmation

callRecordingDelay

string

optional

Call recording delay in seconds. Recording Delay

enablePauseRecordingOnHold

boolean

optional

Automatically pauses recording when starting hold.
Pause Recording on Hold

enableEnvisionScreenRecording

boolean

optional

Enable envision agent screen recording. Use Agent Screen Recording

agentScreenRecording

boolean

optional

Read only- shows if the Agent Screen Recording is enabled for the Org

enableAgentSimpleHold

boolean

optional

Enable agent simple hold. Allow Agent Hold

enableAgentMultiAccept

boolean

optional

Enable agent multi-accept hold. Allow Agent Hold

pauseAgentAfterMultiAccept

boolean

optional

Automatically pause agent after multi-accept hold. AutoPauseOnMultiHold

displayMachineDeliver

boolean

optional

Whether to display the machine-deliver button on the UI.

displayLinkbackHuntGroup

boolean

optional

Whether to display the call's linkback Hunt Group in the data panel.

displaySipHeaderData

boolean

optional

Whether to display SIP header data in the data panel.

displayIvrNavigationKeys

boolean

optional

Whether to display the IVR navigation (Keys Pressed) in the data panel.

displayDataCollectData

boolean

optional

Whether to display Data Collect data in the data panel.

agentCallHistoryScope

integer

optional

Whether and what call history statistics to display in the UI.

displaySkills

boolean

optional

Whether to display the call and agent skills to the agent Display Skills

displayWebLinks

boolean

optional

Whether to display Web Links to the agent Display Web Links

enableAgentHuntGroupReassignment

boolean

optional

Enable agent to reassign hunt groups. Agent Skills Reassignment

enableManualApprovalOfCalls

boolean

optional

Enable manual approval of calls. Allow Manual Approval

requireManualApprovalNumber

boolean

optional

Require manual approval number confirmation. MAC Number Confirmation

enableManualApprovalOfSms

boolean

optional

Enable manual approval of SMS. Allow Manual Approval For Messaging

requireManualApprovalNumberSms

boolean

optional

Require manual approval number confirmation for SMS.
MAM Number Confirmation

disableRejectOptionForApprovers

boolean

optional

Control whether the reject option is available to the approvers.

enableCallDesktopNotifications

boolean

optional

Enable queued call desktop notifications. Allow Queued Call Notifications

enableAgentIntercom

boolean

optional

Whether to allow the agent to intercom with other agents.
AllowAgentIntercom

authorizedIpAddresses

array[string]

optional

Whitelisted IPs. AllowedIps

agentPauseOptionSet

object

optional

Pause option sets per hunt group. Use Agent Pause Codes

holdQueueMonitoring

object

optional

Agent hold queue monitoring.

displayDataDippedData

object

optional

Whether to display the Data Dip'ed data in the data panel.

integrationDataDisplay

object

optional

Payment Integration data display

journeyDataDisplay

object

optional

Whether to display the Journey Integration returned data in the data panel.

agentLoginGuiStatisticsDisplay

object

optional

Agent Login Gui Statistics display and template

phoneZipMetadataDisplay

object

optional

Phone / Postal Metadata display

disallowedHuntGroups

object

optional

Limited available hunt groups. Hunt Group Reassignment Disallowed

alphanumericKeypad

object

optional

Alphanumeric keypad properties. Alphanumeric Keypad

inboundComplianceMetadata

object

optional

Inbound natural language compliance metadata.
Optional Inbound Compliance Metadata
Required Inbound Compliance Metadata

prepareStateCallDelivery

object

optional

Enables the delivery of incoming calls to the agent
depending on the dial status prior to them clicking "Dial".

communicationSettings

object

optional

Hunt group communication compliance settings to be retrieved.

enableScrubListAdding

boolean

optional

Enable the ability to add valuess from the compliance scrub list.
doAllowAddDncl

enableScrubListRemoval

boolean

optional

Enable the ability to remove values from the compliance scrub lists.
doAllowRemoveDncl

complianceDefaultCountry

integer

optional

Select compliance default country. Default DNCL Country

displayOptionsInWrapup

boolean

optional

Display DNCL options in wrap up. Display DNCL Options In Wrapup

automateManuallyDialedScrubList

boolean

optional

Automate manually dialed number scrub list. Manual Dial Auto Dncl Add

automatePreviewDialedScrubList

boolean

optional

Automate preview dialed number scrub list. Preview Dial Auto Dncl Add

scrubLists

array[string]

optional

Hunt group compliance scrub lists. Hunt Group Compliance Scrub Lists

scrubListsRemovalAllowed

array[string]

optional

List of compliance scrub lists which can be removed.
Hunt Group Compliance Scrub Lists Removal Allowed

inboundScrubListExpiration

object

optional

Default inbound scrub list expiration. defaultIBCallDnclExpiration

manualScrubListExpiration

object

optional

Default manual scrub list expiration. defaultMDCallDnclExpiration

outboundScrubListExpiration

object

optional

Default outbound scrub list expiration. defaultOBCallExpiration

previewScrubListExpiration

object

optional

Default preview scrub list expiration. defaultPRCallDnclExpiration

automateResponseRules

object

optional

Automate response rules. AgentDispositionConditionalDncl

automateScrubListCallData

object

optional

Enable automatic addition of call data to scrub lists.
Call Data Scrub Lists Info

callbackSettings

object

optional

Hunt group scheduled callback settings to be retrieved.

enableCallbackScheduling

boolean

optional

Enable callback scheduling. Allow Callback Scheduling

enableCallbackCalling

boolean

optional

Enable callback calling Allow Scheduled Callback Calling

enableAutomaticRetrieval

boolean

optional

Enable automatic callback retrieval Callbacks Retrieval Mode

enableCustomizableCallerId

boolean

optional

Enable caller ID customization. 'Scheduled Callback Editable Caller ID'

defaultCallerId

string

optional

Default scheduled callback caller ID.
Scheduled Callback Default Caller ID

enableCallbackCalendar

boolean

optional

Enable viewing the Scheduled Callback calendar.
Allow Scheduled Callback Calendar

defaultCallbackRouting

object

optional

Default callback routing. Default Callback Routing

callbackRoutingDisallowed

object

optional

Indicates whether and how to limit callback routing.
Callback Routing Disallowed

previewDialSettings

object

optional

Hunt group Preview Dial settings to be retrieved.

enablePreviewDialCancel

boolean

optional

Enable cancelling of Preview Dialing. AllowPreviewDialCancel

enableAutoPauseOnCancel

boolean

optional

Enable automatic pausing when cancelling a Preview Dial call.
AutoPauseOnPreviewDial

timeoutMinutes

string

optional

Indicates when queued preview dial calls should no longer be presented
to agents.
Preview Dial Call Time-out

requireNumberConfirmation

boolean

optional

Indicates if agents must confirm numbers before calling.
Preview Dial Confirmation

previewQueueConfig

string

optional

The name of the Call Queue Configuration (folder name).
PreviewQueueConfig

manualDialSettings

object

optional

Hunt group Manual Dial settings to be retrieved.

enableManualDial

boolean

optional

Allow the agent to make manual dial calls.

queueConfigurationName

string

optional

ACD queue configuration folder name.

defaultCallRecording

integer

optional

The default setting for recording manual dial calls.

cellPhoneScrub

integer

optional

Determines whether to scrub cell phone calls.

timeZoneRestriction

integer

optional

Determines whether to scrub calls by time zone.

timeZoneValidationPostalCode

integer

optional

Determines whether to allow or require collection of ZIP/postal
for compliance.

enableWhitelist

boolean

optional

Allow toll-free white list for manual dial calls.

defaultOutboundCountry

integer

optional

The default selected country for outbound number.

displayOutboundCountrySelection

boolean

optional

Determines whether to display the country select menu to the agent.

displayOutboundNumberPhoneBook

boolean

optional

Determines whether to display the outbound number phone book to the agent.

defaultCallerIdCountry

integer

optional

Indicates the default Country to use with the caller ID number.
Manual Dial Default Caller ID Country

displayCallerIdCountrySelection

boolean

optional

Determines whether to display the caller ID country select menu to
the agent.
Manual Dial Display Caller ID Country Select

displayCallerIdPhoneBook

boolean

optional

Determines whether to display the caller ID phone book to the agent.
Manual Dial Display Phone Book

enableCustomizableCallerId

boolean

optional

Determines whether the agent may customize/edit the caller ID.
Manual Dial Editable Caller ID

enableCallerIdBucket

boolean

optional

Determines whether to allow the use of caller ID buckets in the agent app.
Manual Dial Caller Id Bucket Enabled

randomCallerIdBucket

string

optional

Indicates which caller ID bucket to use.
Manual Dial Random Caller Id Bucket

automateRandomCallerId

boolean

optional

Determines whether to automatically select a random caller ID.
Manual Dial Random Caller Id Enabled

enableMaskCallerId

boolean

optional

Determines whether to mask the caller ID from the agent.
Mask Manual Dial Caller ID

enableSipAddress

boolean

optional

Determines whether to enable SIP addresses as an optional outbound
number and/or caller ID format.
Enable SIP Address

dataDipScope

integer

optional

Application scope; disabled, standard calls, scheduled callbacks or all.

dataDipConfigSid

string

optional

The ID of the data dip config to execute.

dataDipResultHandling

integer

optional

The action to take if data dip execution fails.

dataDipIntegrationMappings

array[object (api.commons.org.ManualDialSettings_DataDipIntegrationMapping) {3}]

optional

Map data dip values to manual dial call values.

dataDipIntegrationHandling

integer

optional

The action to take if the integration mapping fails.

enableRejectOptionForApprovers

boolean

optional

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

naturalComplianceScrub

object

optional

Use Natural Language Compliance and rule set.

scrubOverride

object

optional

Allow agent to override scrub options

defaultCallerId

object

optional

Indicates the default number to use as the caller ID.
Manual Dial Default Caller ID

naturalLanguageComplianceMetadata

object

optional

Manual Dial natural language compliance metadata.
Optional Inbound Compliance Metadata
Required Inbound Compliance Metadata

transferCallSettings

object

optional

Transfer Call hunt group settings.

enableTransfer

boolean

optional

Allow the agent to make transfer calls.

recordingStatus

integer

optional

Indicates start, stop or keep current recording status on transfer.

displayTransferNumberPhoneBook

boolean

optional

Indicates whether or not to display.

enableTransferNumberEditing

boolean

optional

Indicates whether to allow the agent to edit the transfer number.

defaultTransferNumber

string

optional

The default transfer number prepopulated in the text box.

transferNumberCountry

integer

optional

The default country to use with the transfer number.

displayTransferCountrySelection

boolean

optional

Indicate whether to display the country select menu.

displayCallerIdPhoneBook

boolean

optional

Indicate whether to display the caller ID phone book.

enableCallerIdEditing

boolean

optional

Indicates whether to allow the agent to edit the caller ID.

callerIdCountry

integer

optional

The default country to use with the caller ID.

displayCallerIdCountrySelection

boolean

optional

Indicates whether to display the caller ID country select menu.

displayAgentTransferFiltering

boolean

optional

Indicates whether to display agent transfer filtering to the agent.

defaultAgentTransferFiltering

boolean

optional

Indicates whether to filter agents by default.

enableHuntGroupFiltering

boolean

optional

Indicates whether to limit transferring to agents in the same hunt group.

enableScrubOverride

boolean

optional

Allow agent to override scrub decisions.

enableWhitelist

boolean

optional

Indicates whether to apply the whitelist to transfer call scrubbing.

handOffTypes

object

optional

Allowed hand-off types for transfer calls.

transferTypes

object

optional

Indicates type of allowed transfer types.

startRecordingNumbers

array[string]

optional

Transfer numbers which will initiate recording the call.

stopRecordingNumbers

array[string]

optional

Transfer numbers which will stop recording the call.

defaultCallerId

object

optional

The default caller ID prepopulated in the text box.

requeueQueueConfig

object

optional

The name of the Requeue Transfer Queue Configuration.

requeueTransferDisallowed

object

optional

Disallow specific agent skills for requeue transfer routing.

pbxTransferDisallowed

object

optional

Disallow specific PBX extensions for PBX transfers.

naturalComplianceScrub

object

optional

Whether and what NLC compliance rule to apply.

naturalLanguageComplianceMetadata

object

optional

Transfer call natural language compliance metadata.
Optional Transfer Compliance Metadata
Required Transfer Compliance Metadata

numberHistorySettings

object

optional

Number History hunt group settings.

enableSearch

boolean

optional

Allow the agent to access number history search.

enableReportDownload

boolean

optional

Allow the export of the number history report.

enableRecordingsDownload

boolean

optional

Allow the export of the number history related call recordings.

enableAgentResponseEditing

boolean

optional

Allow the agent to edit number history related agent call responses.

Example

{
  "generalSettings": {
    "enableAgentGatewayTitleBar": true,
    "defaultAgentDialIn": "string",
    "requireEndCallConfirmation": true,
    "enableAuthorizationByIp": true,
    "initialAgentStatus": 0,
    "enableAgentPause": true,
    "defaultAgentPauseOption": "string",
    "enablePauseOptionReset": true,
    "triggeredPauseStatusPauseCodeWaiting": "string",
    "triggeredPauseStatusPauseCodeWrapup": "string",
    "displayRecordingIndicator": true,
    "enableCallRecordingPause": true,
    "callRecordingPauseConfirmation": true,
    "callRecordingDelay": "string",
    "enablePauseRecordingOnHold": true,
    "enableEnvisionScreenRecording": true,
    "agentScreenRecording": true,
    "enableAgentSimpleHold": true,
    "enableAgentMultiAccept": true,
    "pauseAgentAfterMultiAccept": true,
    "displayMachineDeliver": true,
    "displayLinkbackHuntGroup": true,
    "displaySipHeaderData": true,
    "displayIvrNavigationKeys": true,
    "displayDataCollectData": true,
    "agentCallHistoryScope": 0,
    "displaySkills": true,
    "displayWebLinks": true,
    "enableAgentHuntGroupReassignment": true,
    "enableManualApprovalOfCalls": true,
    "requireManualApprovalNumber": true,
    "enableManualApprovalOfSms": true,
    "requireManualApprovalNumberSms": true,
    "disableRejectOptionForApprovers": true,
    "enableCallDesktopNotifications": true,
    "enableAgentIntercom": true,
    "authorizedIpAddresses": [
      "string"
    ],
    "agentPauseOptionSet": {
      "enabled": true,
      "setSid": "string"
    },
    "holdQueueMonitoring": {
      "enabled": true,
      "agentRouting": 0,
      "requiredHuntGroupRouting": "string",
      "preferredHuntGroupRouting": "string"
    },
    "displayDataDippedData": {
      "displayDataDipData": true,
      "dataDipDisplayKeys": [
        "string"
      ]
    },
    "integrationDataDisplay": {
      "displayIntegrationData": true,
      "integrationDisplayKeys": [
        "string"
      ]
    },
    "journeyDataDisplay": {
      "displayJourneyData": true,
      "journeyDisplayKeys": [
        "string"
      ]
    },
    "agentLoginGuiStatisticsDisplay": {
      "displayAgentLoginGuiStatistics": true,
      "agentLoginGuiStatisticsTemplate": "string"
    },
    "phoneZipMetadataDisplay": {
      "displayPhoneZipMetadata": true,
      "phoneZipMetadataKeys": [
        0
      ]
    },
    "disallowedHuntGroups": {
      "enabled": true,
      "huntGroups": [
        "string"
      ]
    },
    "alphanumericKeypad": {
      "enabled": true,
      "delimiter": 0
    },
    "inboundComplianceMetadata": {
      "enabled": true,
      "optionalData": [
        "string"
      ],
      "requiredData": [
        "string"
      ]
    },
    "prepareStateCallDelivery": {
      "manualDial": true,
      "previewDial": true
    }
  },
  "communicationSettings": {
    "enableScrubListAdding": true,
    "enableScrubListRemoval": true,
    "complianceDefaultCountry": 0,
    "displayOptionsInWrapup": true,
    "automateManuallyDialedScrubList": true,
    "automatePreviewDialedScrubList": true,
    "scrubLists": [
      "string"
    ],
    "scrubListsRemovalAllowed": [
      "string"
    ],
    "inboundScrubListExpiration": {
      "defaultExpiration": 0,
      "limitExpiration": true,
      "limitedExpirations": [
        0
      ]
    },
    "manualScrubListExpiration": {
      "defaultExpiration": 0,
      "limitExpiration": true,
      "limitedExpirations": [
        0
      ]
    },
    "outboundScrubListExpiration": {
      "defaultExpiration": 0,
      "limitExpiration": true,
      "limitedExpirations": [
        0
      ]
    },
    "previewScrubListExpiration": {
      "defaultExpiration": 0,
      "limitExpiration": true,
      "limitedExpirations": [
        0
      ]
    },
    "automateResponseRules": {
      "enabled": true,
      "ruleSid": "string"
    },
    "automateScrubListCallData": {
      "enabled": true,
      "scrubListDataFields": [
        {
          "scrubList": "string",
          "callDataField": "string"
        }
      ]
    }
  },
  "callbackSettings": {
    "enableCallbackScheduling": true,
    "enableCallbackCalling": true,
    "enableAutomaticRetrieval": true,
    "enableCustomizableCallerId": true,
    "defaultCallerId": "string",
    "enableCallbackCalendar": true,
    "defaultCallbackRouting": {
      "routingMode": 0,
      "agentSid": "string",
      "agentSkillsets": [
        "string"
      ],
      "huntGroupSids": [
        "string"
      ]
    },
    "callbackRoutingDisallowed": {
      "useRoutingLimiting": true,
      "agentSids": [
        "string"
      ],
      "huntGroupSids": [
        "string"
      ],
      "agentSkillSids": [
        "string"
      ]
    }
  },
  "previewDialSettings": {
    "enablePreviewDialCancel": true,
    "enableAutoPauseOnCancel": true,
    "timeoutMinutes": "string",
    "requireNumberConfirmation": true,
    "previewQueueConfig": "string"
  },
  "manualDialSettings": {
    "enableManualDial": true,
    "queueConfigurationName": "string",
    "defaultCallRecording": 0,
    "cellPhoneScrub": 0,
    "timeZoneRestriction": 0,
    "timeZoneValidationPostalCode": 0,
    "enableWhitelist": true,
    "defaultOutboundCountry": 0,
    "displayOutboundCountrySelection": true,
    "displayOutboundNumberPhoneBook": true,
    "defaultCallerIdCountry": 0,
    "displayCallerIdCountrySelection": true,
    "displayCallerIdPhoneBook": true,
    "enableCustomizableCallerId": true,
    "enableCallerIdBucket": true,
    "randomCallerIdBucket": "string",
    "automateRandomCallerId": true,
    "enableMaskCallerId": true,
    "enableSipAddress": true,
    "dataDipScope": 0,
    "dataDipConfigSid": "string",
    "dataDipResultHandling": 0,
    "dataDipIntegrationMappings": [
      {
        "mappingType": 0,
        "dataDipReturnKey": "string",
        "contactFieldDescriptionSid": "string"
      }
    ],
    "dataDipIntegrationHandling": 0,
    "enableRejectOptionForApprovers": true,
    "naturalComplianceScrub": {
      "complianceScrub": 0,
      "ruleSetId": "string"
    },
    "scrubOverride": {
      "enableDnclOverride": true,
      "enableCellScrubOverride": true,
      "enableTimeZoneScrubOverride": true,
      "naturalComplianceOverride": true
    },
    "defaultCallerId": {
      "usage": 0,
      "customCallerId": "string"
    },
    "naturalLanguageComplianceMetadata": {
      "enabled": true,
      "optionalData": [
        "string"
      ],
      "requiredData": [
        "string"
      ]
    }
  },
  "transferCallSettings": {
    "enableTransfer": true,
    "recordingStatus": 0,
    "displayTransferNumberPhoneBook": true,
    "enableTransferNumberEditing": true,
    "defaultTransferNumber": "string",
    "transferNumberCountry": 0,
    "displayTransferCountrySelection": true,
    "displayCallerIdPhoneBook": true,
    "enableCallerIdEditing": true,
    "callerIdCountry": 0,
    "displayCallerIdCountrySelection": true,
    "displayAgentTransferFiltering": true,
    "defaultAgentTransferFiltering": true,
    "enableHuntGroupFiltering": true,
    "enableScrubOverride": true,
    "enableWhitelist": true,
    "handOffTypes": {
      "enableConference": true,
      "enableWarm": true,
      "enableCold": true
    },
    "transferTypes": {
      "enableAgentTransfer": true,
      "enableOpenTransfer": true,
      "enableRequeueTransfer": true,
      "enablePbxExtensionTransfer": true,
      "enableVoicemailTransfer": true
    },
    "startRecordingNumbers": [
      "string"
    ],
    "stopRecordingNumbers": [
      "string"
    ],
    "defaultCallerId": {
      "usage": 0,
      "customCallerId": "string"
    },
    "requeueQueueConfig": {
      "usage": 0,
      "customName": "string"
    },
    "requeueTransferDisallowed": {
      "enable": true,
      "agentSkillSids": [
        "string"
      ],
      "huntGroupSids": [
        "string"
      ]
    },
    "pbxTransferDisallowed": {
      "enable": true,
      "extensions": [
        "string"
      ]
    },
    "naturalComplianceScrub": {
      "complianceScrub": 0,
      "ruleSetId": "string"
    },
    "naturalLanguageComplianceMetadata": {
      "enabled": true,
      "optionalData": [
        "string"
      ],
      "requiredData": [
        "string"
      ]
    }
  },
  "numberHistorySettings": {
    "enableSearch": true,
    "enableReportDownload": true,
    "enableRecordingsDownload": true,
    "enableAgentResponseEditing": true
  }
}

🔴500Server Error

Org_GetHuntGroupSettings

Request

Request samples

Responses