VirtualVisitConfig

Represents an external video provider configuration, which relays events from Salesforce to the provider.

This type extends Metadata and inherits its fields.

VirtualVisitConfig components have the suffix .virtualVisitConfig and are stored in the VirtualVisitConfigs folder.

Introduced in API version 54.0.

Access to this metadata type requires at least one of these preferences:

• Video Calls: Org Pref (VideoVisits) Org preference
• Industries Einstein: Intelligent Form Reader (EinsteinDocReader)
• Industries Einstein: Sentiment Insights Account (IESentimentAnalysis)
• Natural Language Processing: Key phrase extraction and entity detection (NLPServiceEnabled) Org Preference and the NLP: Key phrase extraction (KeyPhrasePrefEnabled) Org Preference
• Natural Language Processing (NLPServicePrefEnabled) Org Preference

• Type: VirtualVisitComprehendServiceType (enumeration of type string)
• Required: No
• Description: Specifies the type of service used to convert speech into text or to analyze the converted speech text.
• Possible values:
  • ComprehendMedicalService
  • ComprehendService

• Type: string
• Required: No
• Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

• Type: string
• Required: No
• Description: The URL of the Digital Experience site where the Video Call component is available to portal or guest users.

• Type: string
• Required: No
• Description: For internal use only.

• Type: string
• Required: No
• Description: The ID of the role that’s used to allow users to join a video call and to grant them temporary access to certain functions needed to participate in the call.

• Type: string
• Required: No
• Description: For internal use only.

• Type: string
• Required: No
• Description: The full name of the VirtualVisitConfig type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

• Type: boolean
• Required: No
• Description: An auto-generated value that doesn’t currently impact the behavior of the metadata type.

• Type: string

• Required: Yes

• Description: Required.

  A user-friendly name for VirtualVisitConfig, which is defined when the VirtualVisitConfig is created.

• Type: string
• Required: No
• Introduced: API version 57.0
• Description: The region where the waiting room and messaging channel data is processed and stored.

• Type: string
• Required: No
• Description: The named credential record used to authenticate and authorize a video call vendor’s account.

• Type: string
• Required: No
• Description: The name of the storage bucket that stores the meeting transcript.

• Type: VirtualVisitUsageType (enumeration of type string)
• Required: No
• Description: The name of the Salesforce feature for which the video call configuration record is created.
• Possible values:
  • CHIME
  • ENTITY_DETECTION
  • INTELLIGENT_FORM_READER
  • KEY_PHRASE_EXTRACTION
  • SENTIMENT_ANALYSIS

• Type: string
• Required: No
• Description: The default Appointment Type picklist values from the Service Appointment object that represent a video appointment type. Use semicolons to separate multiple values.

• Type: string
• Required: No
• Introduced: API version 57.0
• Description: The region where API calls related to Video Calls are made.

• Type: VirtualVisitVisitRegion (enumeration of type string)
• Required: No
• Description: The region where the Video Call audio and video data is processed.
• Possible values:
  • af-south-1
  • ap-east-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-northeast-3
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ca-central-1
  • eu-central-1
  • eu-north-1
  • eu-south-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • me-south-1
  • sa-east-1
  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2

This is an example of a VirtualVisitConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2 <VirtualVisitConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3     <usageType>CHIME</usageType>
4     <visitRegion>us-east-1</visitRegion>
5     <masterLabel>vvconfig1</masterLabel>
6     <experienceCloudSiteUrl>videocall_c@testcloudurl.com</experienceCloudSiteUrl>
7     <namedCredential>SampleNamedCredential</namedCredential>
8     <comprehendServiceType>ComprehendService</comprehendServiceType>
9     <storageBucketName>comprehendbucket</storageBucketName>
10     <isProtected>false</isProtected>
11 </VirtualVisitConfig>

This 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     <namespacePrefix>[namespacePrefix]</namespacePrefix>
4     <fullName>deployPackage</fullName>
5     <types>
6         <members>*</members>
7         <name>VirtualVisitConfig</name>
8     </types>
9     <types>
10         <members>*</members>
11         <name>NamedCredential</name>
12     </types>
13     <version>55.0</version>
14 </Package>

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.