ServiceCloudVoiceSettings

Represents an organization’s Service Cloud Voice settings.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

ServiceCloudVoiceSettings values are stored in the ServiceCloudVoice.settings file in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version 

Introduced in API version 52.0.

Fields 

disableSCVTaskCreationForHVS 

  • Type: boolean
  • Required: No
  • Introduced: API version 61.0
  • Description: Indicates whether to prevent the Sales Engagement automatic task creation feature from generating tasks from voice calls except click-to-dial calls initiated from Sales Engagements, To Do List, and Work Queue. The default value is false. This field is optional.

enableAFVHeaderEnhancements 

  • Type: boolean
  • Required: No

enableAmazonQueueManagement 

  • Type: boolean
  • Required: No
  • Introduced: API version 55.0
  • Description: Indicates whether to enable the Amazon Connect queue management integration for Service Cloud Voice. When enabled, the system automatically synchronizes contact center queues across Salesforce and Amazon Connect, including voice groups and users. The default value is false. This field is optional.

enableDefaultChannelForSCV 

  • Type: boolean
  • Required: No
  • Introduced: API version 53.0
  • Description: Indicates whether Service Cloud Voice uses the default phone channel for all end user identification. The default value is false. This field is optional.

enableDigitalVoiceWhatsapp 

  • Type: boolean
  • Required: No
  • Version: Removed in API version 65.0 and later.
  • Description: Reserved for internal use.

enableEndUserForSCV 

  • Type: boolean
  • Required: No
  • Introduced: API version 53.0
  • Description: Indicates whether Service Cloud Voice matches callers to end user records. The default value is false. This field is optional.

enableOmniCapacityForSCV 

  • Type: boolean
  • Required: No
  • Introduced: API version 54.0
  • Description: Indicates whether to enable Omni-Channel capacity management for Service Cloud Voice. If enabled, Service Cloud Voice Agentwork honors Omni-Channel capacity. The default value is false. This field is optional.

enablePhoneNumberMaskingForSCV 

  • Type: boolean
  • Required: No
  • Introduced: API version 61.0
  • Description: Indicates whether to enable phone number masking functionality in Service Could Voice to protect sensitive data by redacting inbound and outbound phone numbers. When enabled, phone numbers are masked in Omni-Channel views, call recordings, and call transcripts. Masking doesn’t apply to numbers used in rep-to-rep calls managed by partner telephony providers. The default value is false. This field is optional.

enablePTQueueManagement 

  • Type: boolean
  • Required: No
  • Introduced: API version 56.0
  • Description: Indicates whether to enable queue management for Service Cloud Voice with Partner Telephony. When enabled, the system automatically synchronizes contact center queues across Salesforce and partner telephony services, including groups and users. The default value is false. This field is optional.

enableRZoneCloudVoiceOptIn 

  • Type: boolean

  • Required: No

  • Description: Indicates whether you agree to the terms of using Service Cloud Voice with Amazon Connect in a Salesforce Government Cloud environment. The default value is false. This field is optional.

    Amazon Connect is a third-party Amazon service that sits outside the Salesforce Government Cloud FedRAMP environment. Amazon Connect is a separate service offered by Amazon and not a FedRAMP authorized service. Therefore, Amazon Connect’s processing environment falls outside the Government Cloud FedRAMP authorization boundary. To learn more, see Amazon Connect.

enableSCVASAContextLinking 

  • Type: boolean
  • Required: No

enableScvAutoHangup 

  • Type: boolean
  • Required: No

enableSCVBYOT 

  • Type: boolean
  • Required: No
  • Description: Indicates whether to enable Service Cloud Voice with Partner Telephony. The default value is false. This field is optional. For API version 52.0 and later, we recommend using enableSCVExternalTelephony instead.

enableSCVExternalTelephony 

  • Type: boolean
  • Required: No
  • Description: Indicates whether to enable a third-party telephony service to work with Service Cloud Voice with Partner Telephony. The default value is false. This field is optional.

enableSCVOpenVCAsNewTabHVS 

  • Type: boolean
  • Required: No
  • Introduced: API version 62.0
  • Description: Indicates whether to open the Service Cloud Voice Console in a new tab for Sales Engagement scenarios. The default value is false. This field is optional.

enableSCVSupportBannerDisplayed 

  • Type: boolean
  • Required: No
  • Introduced: API version 59.0
  • Description: Indicates whether to display the Service Cloud Voice support banner. The default value is false. This field is optional.

enableServiceCloudVoice 

  • Type: boolean
  • Required: No
  • Description: Indicates whether to enable Service Cloud Voice with Amazon Connect. The default value is false. This field is optional.

Declarative Metadata Sample Definition 

The following is an example of a ServiceCloudVoice.settings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ServiceCloudVoiceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3	<enableServiceCloudVoice>true</enableServiceCloudVoice>
4</ServiceCloudVoiceSettings>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>ServiceCloudVoice</members>
5        <name>Settings</name>
6    </types>
7    <version>52.0</version>
8</Package>