Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Salesforce Voice Lightning Web Component (LWC) Toolkit API

The Salesforce Voice Toolkit API allows you to build Lightning web components that have access to Salesforce Voice features.

This component is supported in Lightning Experience. It requires API version 52.0 or later.

To use the Salesforce Voice Toolkit API in your component:

  1. Add the lightning__ServiceCloudVoiceToolkitApi component to your component’s HTML template file.
    1// yourComponent.html
    2      
    3<template>
    4  <lightning-service-cloud-voice-toolkit-api>
    5  </lightning-service-cloud-voice-toolkit-api>
    6  ...
    7</template>
  2. Include the lightning__ServiceCloudVoiceToolkitApi target in your component’s configuration file.
    1// yourComponent.js-meta.xml
    2
    3<?xml version="1.0" encoding="UTF-8"?>
    4<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    5  <apiVersion>52.0</apiVersion>
    6  <isExposed>true</isExposed>
    7  <capabilities>
    8    <capability>lightning__ServiceCloudVoiceToolkitApi</capability>
    9  </capabilities>
    10</LightningComponentBundle>
For more information about configuration files, see XML Configuration File Elements.