Open CTI Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Sample Code for Using Lightning Message Service with Open CTI
To use Open CTI, you must reference either opencti.js or opencti_min.js version 47.0 on your softphone adapter page. If you don't have these files, your Salesforce representative can provide them.
In the <head> of the HTML file, include the filepath for opencti_min.js.
First, define a variable for the name of your message channel in the JavaScript section of your code. Here, we assign the message channel string SAMPLEMC_c to the variable SAMPLEMC.
Next, create the variable SAMPLEMC_SUBSCRIPTION to hold the subscription object and assign it a null value.
The subscribeToSampleMC() method first checks whether the subscription variable is empty. If the method is empty, it calls the sforce.opencti.subscribe() method.
- channelName
- The name of the message channel.
- listener
- The listener function that’s invoked when a message is sent on the message channel.
- callback
- The function that receives the subscription object. Assign this value to a variable such as SAMPLEMC_SUBSCRIPTION.
The subscribeToSampleMC() method sets the <span> tag in the HTML to true.
- subscription
- The subscription object that you want to unsubscribe from.
- callback
- The function that handles the success or error output.
The publishSampleMC() method is passed the message content that we want to publish. A message is a serialized JSON object. You can pass data such as strings, numbers, objects, and Boolean values. A message cannot contain functions and symbols.
- Name of the sender, “LightningMessageService_OpenCTI_TestPage”
- Type of message, “SampleMC”
- Time when the message was sent
- channelName
- The name of the message channel to publish to.
- message
- The message to publish as a serialized JSON object.
- callback
- The function that handles the success or error output.
The HTML markup displays the message channel’s name, indicates whether the channel is subscribed, and shows buttons to subscribe, unsubscribe, and publish on the channel. When clicked, these buttons call the respective subscribeToSampleMC(), unsubscribeToSampleMC(), and publishSampleMC() functions. The text area with the id set to opencti_testMessageTextArea shows the message text.
Example
<html>
<head>
<script type="text/javascript" src="https://domain:port/support/api/47.0/lightning/opencti_min.js"></script>
<script type="text/javascript">
<script type="text/javascript">
var SAMPLEMC = "SAMPLEMC__c";
var SAMPLEMC_SUBSCRIPTION = null;
function subscribeToSampleMC() {
if (!SAMPLEMC_SUBSCRIPTION) {
sforce.opencti.subscribe({channelName: SAMPLEMC, listener: onPublishMessage, callback: subscribeSampleMCCallback});
let mcSubscribedToggle = document.querySelector("#opencti_mcSubscribedToggle");
mcSubscribedToggle.innerHTML = "true";
}
}
function unsubscribeToSampleMC() {
if (SAMPLEMC_SUBSCRIPTION) {
sforce.opencti.unsubscribe({subscription: SAMPLEMC_SUBSCRIPTION, callback: lightningMessageServiceCallback});
let mcSubscribedToggle = document.querySelector("#opencti_mcSubscribedToggle");
mcSubscribedToggle.innerHTML = "false";
SAMPLEMC_SUBSCRIPTION = null;
}
}
function publishSampleMC() {
const message = {
from: "LightningMessageService_OpenCTI_TestPage",
type: "SampleMC",
time: new Date().toLocaleTimeString()
};
sforce.opencti.publish({channelName: SAMPLEMC, message: message, callback: lightningMessageServiceCallback});
}
function lightningMessageServiceCallback(result) {
if (result.success) {
console.log(result.returnValue);
} else {
console.log(result.errors);
}
}
function subscribeSampleMCCallback(result) {
if (result.success) {
SAMPLEMC_SUBSCRIPTION = result.subscription;
} else {
console.log(result.errors);
}
}
function onPublishMessage(message) {
var textArea = document.querySelector("#opencti_testMessageTextArea");
textArea.innerHTML = message ? JSON.stringify(message, null, '\t') : 'no message payload';
}
</script>
</head>
<body>
<div>
<p>MessageChannel: SampleMC</p>
<p>Subscribed: <span id="opencti_mcSubscribedToggle">false</span></p>
<br/>
<input value="Subscribe" type="button" onclick="subscribeToSampleMC()"/>
<input value="Unsubscribe" type="button" onclick="unsubscribeToSampleMC()"/>
<input value="Publish" type="button" onclick="publishSampleMC()"/>
<br/>
<p>Received message:</p>
<textarea id="opencti_testMessageTextArea" class="opencti_testMessageTextArea" rows="10" style="disabled:true;resize:none;width:100%;"/>
</div>
</body>
</html>Use Message Channels Created Within Your Org
<apex:page>
<script>
var SAMPLEMC = "SAMPLEMC__c";
</script>
</apex:page>Here, a custom Lightning Message Channel is referenced by its name SAMPLEMC__c. The syntax refers to a custom instance of the LightningMessageChannel metadata type. The __c suffix indicates that it’s a custom, but note that it is not a custom object. For more information, see Create a Message Channel.
If your org has a namespace, don’t include it in your message channel name. For example, if your org’s namespace is MyNamespace, then the message channel name remains SAMPLEMC__c.
Use Message Channels Created Outside Your Org
To use Lightning Message Channels from packages created by developers outside of your org, reference them with the syntax Namespace_name__c. For example, if SAMPLEMC was not local to your org and came from a package with the namespace SamplePackageNamespace, the syntax would be SamplePackageNamespace_SAMPLEMC_c.