ConversationVendorInfo

Represents the connection between the partner vendor system and the Service Cloud feature. For example, for Service Cloud Voice, this type contains information about the partner telephony system or Contact Center as a Service (CCaaS) system. For Bring Your Own Channel for Messaging or Bring Your Own Channel for CCaaS, this type contains information about the partner messaging system or CCaaS system.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ConversationVendorInfo components have the suffix .ConversationVendorInformation and are stored in the ConversationVendorInformation folder.

Version

ConversationVendorInfo components are available in API version 52.0 and later.

Special Access Rules

This type requires an add-on license for Service Cloud Voice for Partner Telephony or Digital Engagement.

Fields

The fields in the ConversationVendorInfo type apply to all Service Cloud features unless otherwise stated in the field description. For example, if a field applies to just one Service Cloud Voice telephony model setup or is applied differently by different partner systems, this is stated in the field description.

Field Name	Description
agentSSOSupported	Field Type boolean Description If set to `true`, agents can single sign-on (SSO) into their contact center using Salesforce as the identity provider (IdP). Behind the scenes, Salesforce is used as the SAML IdP in the Single Sign-On connected app for the contact center. If set to `false`, an IdP other than Salesforce is used or an IdP isn’t used at all. The default value is `false`. If this value is set to `false` and you want to use Salesforce as the IdP for your contact center, set this value and the `namedCredentialSupported` value to `true` and configure the `service_cloud_voice.PartnerSSO` interface in your Apex integration class. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
awsAccountKey	Field Type string Description The 12-digit AWS subaccount ID that’s automatically provisioned for you when Service Cloud Voice was turned on. Available in API version 55.0 and later. Applies to the following implementation: Service Cloud Voice with Amazon Connect
awsRootEmail	Field Type string Description The email address used by Salesforce to create the root user for the provisioned AWS subaccount when Service Cloud Voice was turned on. Available in API version 55.0 and later. Applies to the following implementation: Service Cloud Voice with Amazon Connect
awsTenantVersion	Field Type double Description The version number of the SVCTenantStack AWS CloudFormation stack that’s deployed. The stack is deployed in AWS region "us-east-1". Available in API version 55.0 and later. Applies to the following implementation: Service Cloud Voice with Amazon Connect
bridgeComponent	Field Type string Description The Lightning component used to communicate between the telephony or messaging system and other Lightning components. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
clientAuthMode	Field Type ClientAuthMode (enumeration of type string) Description The client authentication mode. Values are: `Custom` `Mixed` `SSO` Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect
connectorUrl	Field Type string Description The URL that hosts your Service Cloud Voice or Bring Your Own Channel for CCaaS connector. This value could be a Visualforce page or a public URL. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
customConfig	Field Type string Description The foreign key to the CustomEntityDefinition, which contains partner-specific custom settings. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
customIcon	Field Type string Description ID of the static resource used to identify the contact center integration, such as a Contact Center as a Service (CCaaS) provider logo. The static resource must be in SVG format. This field is optional. Available in API version 62.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Bring Your Own Channel for CCaaS
customLoginUrl	Field Type string Description The URL that hosts your telephony system or CCaaS system login page. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
developerName	Field Type string Description The unique name of the type in the API.
einsteinConversationInsightsSupported	Field Type boolean Description If set to `true`, Einstein Conversation Insights is turned on. The default value is `false`. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect
integrationClass	Field Type string Description The foreign key to the partner Apex class implementing supported interfaces. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
integrationClassName	Field Type string Description Deprecated in API version 53.0. Don't set this field. Instead, use `integrationClass`. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect
intelligenceSupported	Field Type boolean Description If set to `true`, Salesforce ingests real-time signals sent from a partner telephony system. If set to `false`, Salesforce won't ingest real-time intelligence signals from a partner telephony system. The default value is `false`. Available in API version 59.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony
isTaxCompliant	Field Type boolean Description Indicates whether the Amazon tax settings for the AWS subaccount provisioned for Service Cloud Voice have been confirmed (`true`). The default value is `false`. Available in API version 55.0 and later. Applies to the following implementation: Service Cloud Voice with Amazon Connect
keyProvisioningSupported	Field Type boolean Description If set to `true`, key provisioning and renewal are automated. The default value is `false`. Available in API version 54.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect
masterLabel	Field Type string Description The partner vendor's display name as it appears in the UI. This name appears in several places in the UI, so include the partner vendor name for easy identification. For Service Cloud Voice, this label also represents the telephony provider name in the contact center record. For Service Cloud Voice with Amazon Connect, this field is always set to `Service Cloud Voice`.
namedCredential	Field Type string Description A sample-named credential that can be used for Apex callouts to the partner system. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
namedCredentialSupported	Field Type boolean Description A sample-named credential that can be used for Apex callouts to the partner system. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
partnerContactCenterListSupported	Field Type boolean Description If set to `true`, enables the customer to select one contact center from a list of multiple contact centers to connect with Salesforce. The default value is `false`. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
partnerPhoneNumbersSupported	Field Type boolean Description If set to `true`, displays a list of phone numbers used to create contact center channels. The default value is `false`. Available in API version 54.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect
partnerTransferDestinationsSupported	Field Type boolean Description If set to `true`, allows Salesforce to fetch contact center queues so that Salesforce and contact center queues can be mapped. The default value is `false`. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
queueManagementSupported	Field Type boolean Description If set to `true`, support queue management. The default value is `false`. Available in API version 56.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
serverAuthMode	Field Type ServerAuthMode (enumeration of type string) Description Deprecated in API 53.0. Server authentication mode. Set this value to `None`. Values are: `None` `OAuth` Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect
telephonySettingsComponent	Field Type string Description The name of the Lightning Web Component (LWC) that is used to display additional agent settings in the Omni-Channel widget. This value is in the format `mynamespace:componentName`, where `mynamespace` is the namespace associated with the Service Cloud Voice package that was created, and `componentName` is the FQDN of the Lightning component. Available in API version 54.0 and later. Applies to the following implementation: Service Cloud Voice with Partner Telephony
unifiedRoutingSupported (Beta)	Field Type boolean Description Indicates whether unified routing is supported (`true`) or not supported (`false`) for voice calls in voice channels. The default value is `false`. Once this value is set to `true`, it can’t be changed to `false`. Available in API version 63.0 and later. Applies to the following implementation: Service Cloud Voice with Partner Telephony
universalCallRecordingAccessSupported	Field Type boolean Description If set to `true`, Universal Call Recording Access is turned on. The default value is `false`. If this value is set to `false` and you want to turn on Universal Call Recording, set this value to `true` and configure the service_cloud_voice.RecordingMediaProvider interface in your Apex integration class. Available in API version 54.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect
userSyncingSupported	Field Type boolean Description If set to `true`, supports automated user syncing whenever a user is added to or removed from a contact center. The default value is `false`. Available in API version 53.0 and later. Applies to the following implementations: Service Cloud Voice with Partner Telephony Service Cloud Voice with Partner Telephony from Amazon Connect Bring Your Own Channel for CCaaS
vendorType	Field Type ConversationVendorType (enumeration of type string) Description The Service Cloud feature the partner vendor supports. Possible values are: `Amazon_Connect` — For Service Cloud Voice with Amazon Connect. `BringYourOwnChannelPartner` — For Bring Your Own Channel for Messaging. Available in API version 60.0 and later. `BringYourOwnContactCenter` — For Bring Your Own Channel for Contact Center as a Service (CCaaS). Available in API version 60.0 and later. `ServiceCloudVoicePartner` — For Service Cloud Voice with Partner Telephony or Service Cloud Voice with Partner Telephony from Amazon Connect. Available in API version 53.0 and later.

Declarative Metadata Sample Definition

The following is an example of a ConversationVendorInfo component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ConversationVendorInfo xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <einsteinConversationInsightsSupported>true</einsteinConversationInsightsSupported>
4    <partnerContactCenterListSupported>true</partnerContactCenterListSupported>
5    <namedCredentialSupported>true</namedCredentialSupported>
6    <partnerTransferDestinationsSupported>true</partnerTransferDestinationsSupported>
7    <agentSSOSupported>true</agentSSOSupported>
8    <keyProvisioningSupported>true</keyProvisioningSupported>
9    <universalCallRecordingAccessSupported>true</universalCallRecordingAccessSupported>
10    <partnerPhoneNumbersSupported>true</partnerPhoneNumbersSupported>
11    <queueManagementSupported>true</queueManagementSupported>
12    <clientAuthMode>SSO</clientAuthMode>
13    <connectorUrl>https://exampleconnectorurl.com</connectorUrl>
14    <customConfig>exampleCustomConfig__c</customConfig>
15    <customLoginUrl>testurl</customLoginUrl>
16    <integrationClass>ExampleIntegrationImpl</integrationClass>
17    <masterLabel>Example Partner Name</masterLabel>
18    <developerName>exampledevname</developerName>
19    <namedCredential>exampleNamedCredential</namedCredential>
20    <userSyncingSupported>true</userSyncingSupported>
21    <vendorType>BringYourOwnContactCenter</vendorType>
22</ConversationVendorInfo>

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

1<Package xmlns="http://soap.sforce.com/2006/04/metadata">
2    <types>
3        <members>*</members>
4        <name>ConversationVendorInfo</name>
5    </types>
6    <version>59.0</version>
7</Package>

Wildcard Support in the Manifest File

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.

Metadata API Developer Guide