ConversationVendorInfo Metadata Type in SFDX

Architectural Overview#

Whether you are integrating an enterprise CTI platform via Service Cloud Voice for Partner Telephony (such as Genesys Cloud, Avaya, or Cisco Webex) or building a Bring Your Own Channel (BYOC) messaging connector, Salesforce requires a registered vendor definition before any contact center (CallCenter) or messaging channel (ConversationChannelDefinition) can be provisioned.

The ConversationVendorInfo metadata type represents this partner registration artifact. It stores the vendor’s identity (masterLabel, developerName), integration classification (vendorType), authentication bridge (clientAuthMode), and optional partner telephony connector links (integrationClass, telephonySettings). ISV partners package ConversationVendorInfo in their AppExchange solutions, and enterprise architects create custom ConversationVendorInfo records when building bespoke BYOC messaging adapters.

SFDX Directory and File Suffix#

Key Metadata Fields#

ConversationVendorInfo defines the vendor’s identity, authentication mode, and supported channel capabilities.

Declarative XML Example#

Below is a production Line_Messaging_Vendor.conversationVendorInfo-meta.xml registering a custom BYOC messaging provider that authenticates via NamedCredential and OAuth.

<?xml version="1.0" encoding="UTF-8"?>
<ConversationVendorInfo xmlns="http://soap.sforce.com/2006/04/metadata">
    <clientAuthMode>OAuth</clientAuthMode>
    <masterLabel>LINE Enterprise Messaging Connector</masterLabel>
    <namedCredentialSupported>true</namedCredentialSupported>
    <partnerContactCenterListSupported>false</partnerContactCenterListSupported>
    <serverKeySupported>false</serverKeySupported>
    <vendorType>BringYourOwnChannel</vendorType>
</ConversationVendorInfo>

package.xml Manifest#

Deploy ConversationVendorInfo alongside its dependent ConversationChannelDefinition:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Line_Messaging_Vendor</members>
        <name>ConversationVendorInfo</name>
    </types>
    <types>
        <members>Line_Enterprise_Channel</members>
        <name>ConversationChannelDefinition</name>
    </types>
    <version>68.0</version>
</Package>

Querying via SOQL and SFDX CLI#

ConversationVendorInfo is queryable via SOQL and Tooling API, making it easy to verify installed Partner Telephony and BYOC vendors in any org.

1. Query Installed Conversation Vendors via SOQL#

SELECT Id, DeveloperName, MasterLabel, VendorType, ClientAuthMode,
       NamedCredentialSupported, NamespacePrefix
FROM ConversationVendorInfo
ORDER BY VendorType, MasterLabel ASC

2. SFDX CLI Retrieve and Deploy Commands#

# Retrieve a specific ConversationVendorInfo component
sf project retrieve start --metadata ConversationVendorInfo:Line_Messaging_Vendor

# Deploy ConversationVendorInfo to a target org
sf project deploy start --metadata ConversationVendorInfo:Line_Messaging_Vendor

Architect Best Practices and Gotchas#

• Scratch Org Prerequisites: Deploying ConversationVendorInfo to a scratch org requires Digital Engagement / Messaging ("LiveMessage") or Service Cloud Voice ("ServiceCloudVoice") features enabled in config/project-scratch-def.json.
• Deletion Protection: You cannot delete a ConversationVendorInfo component while any active or inactive ConversationChannelDefinition or MessagingChannel record still references it.

Frequently asked questions

What is the role of ConversationVendorInfo in Service Cloud?

ConversationVendorInfo defines the partner or vendor identity record required to configure Service Cloud Voice Partner Telephony contact centers or Bring Your Own Channel (BYOC) messaging channels.

Where are ConversationVendorInfo files stored in SFDX?

They are stored in force-app/main/default/conversationVendorInfos/ with the file suffix .conversationVendorInfo-meta.xml.

How does ConversationVendorInfo connect to ConversationChannelDefinition?

Every ConversationChannelDefinition requires a conversationVendorInfo field referencing the DeveloperName of a ConversationVendorInfo record that identifies the messaging or CCaaS provider.

Can ConversationVendorInfo reference an Apex adapter class?

Yes, for Partner Telephony and custom vendor integrations, the customConfig or integrationClass fields bind the vendor record to the partner's Apex implementation or managed package namespace.