Newer Version Available

This content describes an older version of this product. View Latest

VirtualVisitConfig

Store the configuration values for an external video call service. This object is available in API version 56.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

Access to the Virtual Call feature requires an add on license.

Fields

Field Details
ComprehendServiceType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of service used to convert speech into text or to analyze the converted speech text. This text is displayed in the video player during the call.
Possible values are:
  • ComprehendMedicalService—Transcribe Medical
  • ComprehendService—Transcribe
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the developer creating the configuration.
ExperienceCloudSiteUrl
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The URL of the Experience Cloud site where the video call component is available to portal or guest users.
ExternalRoleIdentifier
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
Enter 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.
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the labels in the video call player.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Label that identifies the video call application throughout the Salesforce user interface.
MessagingRegion
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the region in which the waiting room and messaging channel data is processed and stored. Available in API version 57.0 and later.
NamedCredentialId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The named credential record that's used to authenticate and authorize an account of the video call vendor.
This field is a relationship field.
Relationship Name
NamedCredential
Relationship Type
Lookup
Refers To
NamedCredential
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Specifies the namespace of the application config, if installed with a managed package.
StorageBucketName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the storage bucket that stores the meeting transcript.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The unique name of the Salesforce feature for which the video call configuration record is created.
Possible values are:
  • CHIME—Chime
  • INTELLIGENT_FORM_READER—Intelligent Form Reader
  • SENTIMENT_ANALYSIS—Sentiment Analysis
VideoCallApptTypeValue
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Enter Default Appointment Type picklist values from the Service Appointment object that represent a video appointment type. Use semicolons to separate multiple values.
VideoControlRegion
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the region through which API calls related to Video Calls are made. Available in API version 57.0 and later.
VisitRegion
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the region through which the Video Call video and audio data are processed.
Possible values are:
  • af-south-1—Africa (Cape Town)
  • ap-east-1—Asia Pacific (Hong Kong)
  • ap-northeast-1—Asia Pacific (Tokyo)
  • ap-northeast-2—Asia Pacific (Seoul)
  • ap-northeast-3—Asia Pacific (Osaka)
  • ap-south-1—Asia Pacific (Mumbai)
  • ap-southeast-1—Asia Pacific (Singapore)
  • ap-southeast-2—Asia Pacific (Sydney)
  • ca-central-1—Canada (Central)
  • eu-central-1—Europe (Frankfurt)
  • eu-north-1—Europe (Stockholm)
  • eu-south-1—Europe (Milan)
  • eu-west-1—Europe (Ireland)
  • eu-west-2—Europe (London)
  • eu-west-3—Europe (Paris)
  • me-south-1—Middle East (Bahrain)
  • sa-east-1—South America (São Paulo)
  • us-east-1—US East (N. Virginia)
  • us-east-2—US East (Ohio)
  • us-west-1—US West (N. California)
  • us-west-2—US West (Oregon)