Get Started with the Quick Start Partner Telephony Package

You can explore the partner telephony features in your partner telephony-enabled org. We’ve published a sample quick start package that you can install in your org, create a contact center, and get started.

The quick-start-partner-telephony package has a ConversationVendorInfo record. You can reference it while creating a contact center. It contains a connector URL which points to a Visualforce page (quickStartPT__quickStartPTVFConnector). You can change it to localhost (127.0.0.1). Both options require you to run a local server. For localhost, host the connector from http://127.0.0.1. For the Visualforce page, you need the server to call SCRT APIs.

The package also includes a Lightning Message Service (LMS) channel and Lightning Web Component (LWC)/Aura record home and bridge components. The Visualforce (VF) page connector uses the AuraBridgeComponent. The localhost connector uses the lwcBridge component.

Installing the quick-start-partner-telephony package automatically enables MyDomain, Omni-Channel, and the external Salesforce Voice telephony system.

The package includes these components:

NameTypeDescription
AuraLmsSampleAura Component BundleVoice Call Record Home Aura component to demonstrate LMS
AuraMessageBridgeAura Component BundleAura bridge component needed for LMS messages
ServiceCloudVoiceMessageChannelLightning Message ChannelLMS channel
connectorPageVisualforce PageConnector page used as the connector URL
demoConnectorStatic ResourceJS script referenced in the Connector VF page
loginPageVisualforce PageDemo login page used in Omni-Channel for partner login
login_pageStatic ResourceJS script referenced in the login VF page
logoStatic ResourceImage icon
lwcBridgeLightning Web Component BundleLWC bridge component needed for LMS messages
lwcLmsSampleLightning Web Component BundleVoice Call record home Lightning web component (LWC) to demonstrate LMS
quickStartPTVFConnectorConversation Vendor InformationConversationVendorInfo record for VF page connector
quickStartPartnerTelephonyConversation Vendor InformationConversationVendorInfo record for localhost connector
remote_controlStatic ResourceVF page used for simulator page (also known as “remote”)
simulatorPageVisualforce PageJS script referenced in simulator VF page
slds_stylesheetStatic ResourceCSS for simulator VF page
symbolsStatic ResourceImage icons
Service_Cloud_Voice (applications)ApplicationApplication containing components used for Salesforce Voice with Partner Telephony
SampleIntegrationImpl.clsApex ClassClass that implements interfaces for automated setup
SampleIntegrationImplTest.clsApex ClassTests for Apex integration class
Service_Cloud_Voice (FlexiPage)FlexiPageLightning page for customized Salesforce Voice page
Service_Cloud_Voice_UtilityBarFlexiPageUtility base with common tools for Salesforce Voice
sampleCustomConfig__c-sampleCustomConfig LayoutLayoutLayout to define display for custom config object
sampleNamedCredentialNamed CredentialNamed credential to authenticate server-to-server communication for automated setup
sampleCustomConfig__cCustom ObjectCustom object for defining custom settings for contact centers
VoiceCallVoice CallVoice Call object
MyDomainSettingVerifies that My Domain is enabled
OmniChannelSettingTurns on Omni-Channel in the org
ServiceCloudVoiceSettingTurns on the external Salesforce Voice telephony system.
If you’ve already installed the quick-start-partner-telephony package, you can turn on the external Salesforce Voice telephony system by copying the ServiceCloudVoice.settings-meta.xml file from the quick-start-partner-telephony package and adding it to the force-app/main/default/settings folder.
  1. Install the quick-start-partner-telephony package in your org.

  2. After installing the quick-start-partner-telephony package, follow the Partner Telephony Setup instructions to create a contact center and assign permission sets.

  3. Import a contact center XML (see the sample XML in Set Up Salesforce Voice with Partner Telephony in Your Org).

  4. Set reqVendorInfoApiName as needed.

    • For the connector from localhost:

      1<item sortOrder="2"
      2        name="reqVendorInfoApiName" label="Conversation Vendor Info Developer
      3        Name">quickStartPT__quickStartPartnerTelephony</item>

      quickStartPartnerTelephony is the developer name of the ConversationVendorInfo record where the connector URL is pointing to localhost (that is, https://127.0.0.1:8080). Make sure the connector is running on localhost 8080.

    • For the connector from the Visualforce page:

      1<item sortOrder="2"
      2        name="reqVendorInfoApiName" label="Conversation Vendor Info Developer
      3          Name">quickStartPT__quickStartPTVFConnector</item>

      Start a server for SCRT server calls (such as inbound call, transcription, and call recording) and one initial call to set org details. The VF page included in the package uses localhost:3030 for SCRT calls (that is, http://127.0.0.1:3030/). Configure the org details using the configureTenantInfo call. Enable Cors on the server to enable calls to the other domain from the VF connector.

      • Run npm install cors in the demo connector.

      • Add the following two lines in server.js.

        1import cors from 'cors';
        2app.use(cors());
  5. Set reqVendorInfoApiName as needed.