Sample Call Center Definition File

Each call center definition file looks different. This example shows you what a call center definition file looks like for an org using Salesforce Classic and Lightning Experience.

The way you implement Open CTI depends on your org’s user interface. There are separate Open CTI APIs for Salesforce Classic and Lightning Experience. The reqSalesforceCompatibilityMode item in your call center definition file identifies the user interface you plan to use—Salesforce Classic, Lightning Experience, or both. If no value is specified, the default is Classic. This item is optional, but to make calls in Lightning Experience you must specify Lightning or Classic_and_Lightning.

Important

Sample XML for an Org Using Salesforce Classic

1<!--
2     All sections and items whose name value begins with "req" are
3     required in a valid call center definition file. The sortOrder
4     and label attributes can be changed for all required sections
5     and items except reqGeneralInfo, reqInternalName, and
6     reqDisplayName, in which only the label attribute can be altered.
7
8     Note that the value for the reqInternalName item is limited to
9     40 alphanumeric characters and must start with an alphabetic
10     character. reqInternalName must be unique for all call centers
11     that you define.
12-->
13<callCenter>
14   <section sortOrder="0" name="reqGeneralInfo" label="General Information">
15    <item sortOrder="0" name="reqInternalName" label="InternalName">DemoAdapter</item>
16    <item sortOrder="1" name="reqDisplayName" label="Display Name">Demo Call Center Adapter</item>
17    <item sortOrder="2" name="reqAdapterUrl" label="CTI Adapter URL">https://domain:port/softphone</item>
18    <item sortOrder="3" name="reqUseApi" label="Use CTI API">true</item>
19    <item sortOrder="4" name="reqSoftphoneHeight" label="Softphone Height">300</item>
20    <item sortOrder="5" name="reqSoftphoneWidth" label="Softphone Width">500</item>
21    <item sortOrder="6" name="reqSalesforceCompatibilityMode" label=" Salesforce Compatibility Mode">Classic</item>
22   </section>
23   <section sortOrder="1" name="reqDialingOptions" label="Dialing Options">
24    <item sortOrder="0" name="reqOutsidePrefix" label="Outside Prefix">9</item>
25    <item sortOrder="1" name="reqLongDistPrefix" label="Long Distance Prefix">1</item>
26    <item sortOrder="2" name="reqInternationalPrefix" label="International Prefix">01</item>
27   </section>
28</callCenter>

Sample XML for an Org Using Lightning Experience

1<callCenter>
2   <section sortOrder="0" name="reqGeneralInfo" label="General Information">
3    <item sortOrder="0" name="reqInternalName" label="InternalName">OpenCTI</item>
4    <item sortOrder="1" name="reqDisplayName" label="Display Name">OpenCTI</item>
5    <item sortOrder="2" name="reqAdapterUrl" label="CTI Adapter URL">https://domain:port/softphone</item>
6    <item sortOrder="3" name="reqUseApi" label="Use CTI API">true</item>
7    <item sortOrder="4" name="reqSoftphoneHeight" label="Softphone Height">300</item>
8    <item sortOrder="5" name="reqSoftphoneWidth" label="Softphone Width">500</item>
9    <item sortOrder="6" name="reqSalesforceCompatibilityMode" label="Salesforce Compatibility Mode">Lightning</item>
10   </section>
11   <section sortOrder="1" name="reqDialingOptions" label="Dialing Options">
12    <item sortOrder="0" name="reqOutsidePrefix" label="Outside Prefix">9</item>
13    <item sortOrder="1" name="reqLongDistPrefix" label="Long Distance Prefix">1</item>
14    <item sortOrder="2" name="reqInternationalPrefix" label="International Prefix">01</item>
15   </section>
16</callCenter>