@microsoft/omnichannel-chat-sdk
Advanced tools
❗ We recommend using official release versions in production as listed here. Support will be provided only on official versions.
📢 Try out our new React component library omnichannel-chat-widget with Chat SDK
Headless Chat SDK to build your own chat widget against Dynamics 365 Omnichannel Services.
Please make sure you have a chat widget configured before using this package or you can follow this link
Omnichannel offers a live chat widget (LCW) by default. You can use the Chat SDK to build your custom chat widget if:
| Feature | Live Chat Widget | Chat SDK | Notes |
|---|---|---|---|
| Bring Your Own Widget | ❌ | ✔ | |
| Web Support | ✔ | ✔ | |
| React Native Support | ❌ | ✔ | |
| Escalation to Voice & Video | ✔ | ✔ | Only supported on Web |
| Co-browse | ✔ | 3rd party add-on | Only supported on Web |
| Screen Sharing | ✔ | 3rd party add-on | Only supported on Web |
| Authenticated Chat | ✔ | ✔ | |
| Pre-chat Survey | ✔ | ✔ | |
| Post-chat Survey | ✔ | ✔ | |
| Download Transcript | ✔ | ✔ | |
| Email Transcript | ✔ | ✔ | |
| Data Masking | ✔ | ✔ | |
| File Attachments | ✔ | ✔ | |
| Custom Context | ✔ | ✔ | |
| Proactive Chat | ✔ | BYOI * | |
| Persistent Chat | ✔ | ✔ | |
| Chat Reconnect | ✔ | ✔ | |
| Operating Hours | ✔ | ✔ | |
| Get Agent Availability | ✔ | ✔ | |
| Queue Position | ✔ | ✔ | No SDK method. Handled as system message |
| Average Wait Time | ✔ | ✔ | No SDK method. Handled as system message |
* BYOI: Bring Your Own Implementation
New releases are published on a regular basis to ensure the product quality.
| Version | Docs | Release Date | End of Support | Deprecated |
|---|---|---|---|---|
| 1.9.0 | Release Notes | May 22nd 2024 | May 22nd 2025 | |
| 1.8.3 | Release Notes | May 15th 2024 | Mar 15th 2025 | |
| 1.8.2 | Release Notes | May 7th 2024 | May 7th 2025 | |
| 1.8.1 | Release Notes | Apr 24th 2024 | Apr 24th 2025 | |
| 1.8.0 | Release Notes | Mar 29th 2024 | Mar 29th 2025 | |
| 1.7.2 | Release Notes | Mar 20th 2024 | Mar 20th 2025 | |
| 1.7.1 | Release Notes | Mar 19th 2024 | Mar 19th 2025 | |
| 1.7.0 | Release Notes | Mar 7th 2024 | Mar 7th 2025 | |
| 1.6.3 | Release Notes | Jan 30th 2024 | Jan 30th 2025 | |
| 1.6.2 | Release Notes | Dec 12th 2023 | Dec 12th 2024 | |
| 1.6.1 | Release Notes | Dec 7th 2023 | Dec 7th 2024 | |
| 1.6.0 | Release Notes | Dec 4th 2023 | Dec 4th 2024 | |
| 1.5.7 | Release Notes | Nov 20th 2023 | Nov 20th 2024 | |
| 1.5.6 | Release Notes | Nov 11th 2023 | Nov 11th 2024 | |
| 1.5.5 | Release Notes | Oct 31st 2023 | Oct 31st 2024 | |
| 1.5.4 | Release Notes | Oct 20th 2023 | Oct 20th 2024 | |
| 1.5.3 | Release Notes | Oct 18th 2023 | Oct 18th 2024 | |
| 1.5.2 | Release Notes | Oct 14th 2023 | Oct 14th 2024 | |
| 1.5.1 | Release Notes | Oct 10th 2023 | Oct 10th 2024 | |
| 1.5.0 | Release Notes | Sep 29th 2023 | Sep 29th 2024 | |
| 1.4.7 | Release Notes | Sep 13th 2023 | Sep 13th 2024 | |
| 1.4.6 | Release Notes | Aug 15th 2023 | Aug 15th 2024 | |
| 1.4.5 | Release Notes | Aug 2nd 2023 | Aug 2nd 2024 | |
| 1.4.4 | Release Notes | Jul 19th 2023 | Jul 19th 2024 | |
| 1.4.3 | Release Notes | Jun 15th 2023 | Jun 15th 2024 | |
| 1.4.2 | Release Notes | May 19th 2023 | May 19th 2024 | ✔️ |
| 1.4.1 | Release Notes | May 5th 2023 | May 5th 2024 | ✔️ |
| 1.4.0 | Release Notes | May 2nd 2023 | May 2nd 2024 | ✔️ |
| 1.3.0 | Release Notes | Apr 5th 2023 | Apr 5th 2024 | ✔️ |
| 1.2.0 | Release Notes | Nov 11th 2022 | Nov 11th 2023 | ✔️ |
| 1.1.0 | Release Notes | Apr 15th 2021 | Apr 15th 2022 | ✔️ |
| 1.0.0 | Release Notes | Oct 8th 2021 | Oct 8th 2022 | ✔️ |
| 0.3.0 | Release Notes | Sep 3rd 2021 | Sep 3rd 2022 | ✔️ |
| 0.2.0 | Release Notes | Apr 30th 2021 | Apr 30th 2022 | ✔️ |
| 0.1.0 | Release Notes | Oct 26th 2020 | Oct 26th 2021 | ✔️ |
npm install @microsoft/omnichannel-chat-sdk --save
The following steps will be required to run Omnichannel Chat SDK on React Native:
Install node-libs-react-native
npm install node-libs-react-native --save-dev
Install react-native-randomBytes
npm install react-native-randombytes --save-dev
Install react-native-get-random-values
npm install react-native-get-random-values --save-dev
Install react-native-url-polyfill
npm install react-native-url-polyfill --save-dev
Install @azure/core-asynciterator-polyfill
npm install @azure/core-asynciterator-polyfill --save-dev
Update metro.config.js to use React Native compatible Node Core modules
module.exports = {
// ...
resolver: {
extraNodeModules: {
...require('node-libs-react-native'),
net: require.resolve('node-libs-react-native/mock/net'),
tls: require.resolve('node-libs-react-native/mock/tls')
}
}
};
Add the following import on top of your entry point file
import 'node-libs-react-native/globals';
import 'react-native-get-random-values';
import 'react-native-url-polyfill/auto';
import '@azure/core-asynciterator-polyfill';
It handles the initialization of ChatSDK internal data.
import OmnichannelChatSDK from '@microsoft/omnichannel-chat-sdk';
const omnichannelConfig = {
orgUrl: "",
orgId: "",
widgetId: ""
};
const chatSDKConfig = { // Optional
dataMasking: {
disable: false,
maskingCharacter: '#'
}
};
const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
const optionalParams = {
getLiveChatConfigOptionalParams: {
sendCacheHeaders: false // Whether to send Cache-Control HTTP header to GetChatConfig call
}
};
await chatSDK.initialize(optionalParams);
It starts an Omnichannel conversation.
const customContext = {
'contextKey1': {'value': 'contextValue1', 'isDisplayable': true},
'contextKey2': {'value': 12.34, 'isDisplayable': false},
'contextKey3': {'value': true}
};
const optionalParams = {
preChatResponse: '', // PreChatSurvey response
liveChatContext: {}, // EXISTING chat context data
customContext, // Custom Context
sendDefaultInitContext: true // Send default init context ⚠️ Web only
};
await chatSDK.startChat(optionalParams);
It ends the current Omnichannel conversation.
await chatSDK.endChat();
It gets the Pre-Chat Survey from Live Chat Config. Pre-Chat Survey is in Adaptive Card format.
Option 1
const preChatSurvey = await getPreChatSurvey(); // Adaptive Cards JSON payload data
Option 2
const parseToJSON = false;
const preChatSurvey = await getPreChatSurvey(parseToJSON); // Adaptive Cards payload data as string
It fetches the Live Chat Config.
const liveChatConfig = await chatSDK.getLiveChatConfig();
It gets the current live chat context information to be used to reconnect to the same conversation.
const liveChatContext = await chatSDK.getCurrentLiveChatContext();
It gets the active data masking rules from Live Chat Config.
const dataMaskingRules = await chatSDK.getDataMaskingRules();
It gets the current reconnectable chat context information to connect to a previous existing chat session.
Reconnection options is required. See documentation
const optionalParams = {
reconnectId: '', // reconnect Id
};
const chatReconnectContext = await chatSDK.getChatReconnectContext(optionalParams);
It gets the details of the current conversation such as its state & when the agent joined the conversation.
const optionalParams = {
liveChatContext: {}, // EXISTING chat context data
};
const conversationDetails = await chatSDK.getConversationDetails(optionalParams);
It gets the chat token used to initiate a chat with Omnichannel messaging client.
const chatToken = await chatSDK.getChatToken();
It gets the calling token used to initiate a Voice & Video Call.
const callingToken = await chatSDK.getCallingToken();
It gets all the messages of the current conversation.
const messages = await chatSDK.getMessages();
It sends a message to Omnichannel.
import {DeliveryMode, MessageContentType, MessageType, PersonType} from '@microsoft/omnichannel-chat-sdk';
...
const displayName = "Contoso"
const message = "Sample message from customer";
const messageToSend = {
content: message
};
await chatSDK.sendMessage(messageToSend);
It subscribes to new incoming messages of the current conversation such as system messages, client messages, agent messages, adaptive cards and attachments.
const optionalParams = {
rehydrate: true, // Rehydrate all previous messages of existing conversation (false by default)
}
chatSDK.onNewMessage((message) => {
console.log(`[NewMessage] ${message.content}`);
console.log(message);
}, optionalParams);
It subscribes to an agent typing event.
chatSDK.onTypingEvent(() => {
console.log("Agent is typing...");
})
It subscribes to an agent ending the session of the conversation.
chatSDK.onAgentEndSession(() => {
console.log("Session ended!");
});
It sends a customer typing event.
await chatSDK.sendTypingEvent();
It sends an email of the live chat transcript.
const body = {
emailAddress: 'contoso@microsoft.com',
attachmentMessage: 'Attachment Message'
};
await chatSDK.emailLiveChatTranscript(body);
It fetches the current conversation transcript data in JSON.
const optionalParams = {
liveChatContext: {}, // EXISTING chat context data
};
await chatSDK.getLiveChatTranscript(optionalParams);
It sends a file attachment to the current conversation.
const fileInfo = {
name: '',
type: '',
size: '',
data: ''
};
await chatSDK.uploadFileAttachment(fileInfo);
It downloads the file attachment of the incoming message as a Blob response.
const blobResponse = await chatsdk.downloadFileAttachment(message.fileMetadata);
...
// React Native implementation
const fileReaderInstance = new FileReader();
fileReaderInstance.readAsDataURL(blobResponse);
fileReaderInstance.onload = () => {
const base64data = fileReaderInstance.result;
return <Image source={{uri: base64data}}/>
}
:warning: Currently supported on web only
It creates a chat adapter to use with BotFramework-WebChat.
const chatAdapter = await chatSDK.createChatAdapter();
:warning: Currently supported on web only
:warning: Please ensure voice & video call is stopped before leveraging endChat SDK method
It fetches the SDK for Escalation to Voice & Video.
try {
const VoiceVideoCallingSDK = await chatSDK.getVoiceVideoCalling();
console.log("VoiceVideoCalling loaded");
} catch (e) {
console.log(`Failed to load VoiceVideoCalling: ${e}`);
if (e.message === 'UnsupportedPlatform') {
// Voice Video Calling feature is not supported on this platform
}
if (e.message === 'FeatureDisabled') {
// Voice Video Calling feature is disabled on admin side
}
}
It gets the participant type that should be used for the survey and both the default and bot survey details.
const postChatSurveyContext = await chatSDK.getPostChatSurveyContext();
It gets information on whether a queue is available, and whether there are agents available in that queue, as well as queue position and average wait time. This call only supports authenticated chat.
const agentAvailability = await chatSDK.getAgentAvailability();
See https://docs.microsoft.com/en-us/dynamics365/customer-service/configure-pre-chat-survey?tabs=customerserviceadmincenter on how to set up pre-conversation surveys
import * as AdaptiveCards, { Action } from "adaptivecards";
...
const preChatSurvey = await chatSDK.getPreChatSurvey();
...
// Web implementation
const renderPreChatSurvey = () => {
const adaptiveCard = new AdaptiveCards.AdaptiveCard();
adaptiveCard.parse(preChatSurvey); // Parses Adaptive Card JSON data
adaptiveCard.onExecuteAction = async (action: Action) => { // Adaptive Card event handler
const preChatResponse = (action as any).data;
const optionalParams: any = {};
if (preChatResponse) {
optionalParams.preChatResponse = preChatResponse;
}
await chatSDK.startChat(optionalParams);
}
const renderedCard = adaptiveCard.render(); // Renders as HTML element
return <div ref={(n) => { // Returns React element
n && n.firstChild && n.removeChild(n.firstChild); // Removes duplicates fix
renderedCard && n && n.appendChild(renderedCard);
}} />
}
See https://docs.microsoft.com/en-us/dynamics365/customer-service/configure-post-conversation-survey?tabs=customerserviceadmincenter on how to set up post-conversation surveys
❗
chatSDK.getPostChatSurveyContext()needs to be called beforechatSDK.endChat()is called
// 1. Start chat
await chatSDK.startChat();
// 2. Save post chat survey context before ending chat
try {
const context = await chatSDK.getPostChatSurveyContext();
if (context.participantJoined) { // participantJoined will be true if an agent has joined the conversation, or a bot has joined the conversation and the bot survey flag has been turned on the admin side.
// formsProLocale is the default language you have set on the CustomerVoice portal. You can override this url parameter with any locale that CustomerVoice supports.
// If "&lang=" is not set on the url, the locale will be English.
const link = context.participantType === "Bot" ? context.botSurveyInviteLink : context.surveyInviteLink;
const locale = context.participantType === "Bot" ? context.botFormsProLocale : context.formsProLocale;
const linkToSend = link + "&lang=" + locale;
// This link is accessible and will redirect to the survey page. Use it as you see fit.
}
} catch (ex) {
// If the post chat should not be shown for any reason (e.g. post chat is not enabled), promise will be rejected.
}
// 3. End chat
await chatSDK.endChat();
// 4. Display Post Chat
await chatSDK.startChat(); // Starts NEW chat
const liveChatContext = await chatSDK.getCurrentLiveChatContext(); // Gets chat context
cache.saveChatContext(liveChatContext); // Custom logic to save chat context to cache
...
// Page/component reloads, ALL previous states are GONE
...
const liveChatContext = cache.loadChatContext() // Custom logic to load chat context from cache
const optionalParams = {};
optionalParams.liveChatContext = liveChatContext;
await chatSDK.startChat(optionalParams); // Reconnects to EXISTING chat
...
const messages = await chatSDK.getMessages(); // Gets all messages from EXISTING chat
messages.reverse().forEach((message: any) => renderMessage(message)); // Logic to render all messages to UI
See https://docs.microsoft.com/en-us/dynamics365/customer-service/create-chat-auth-settings?tabs=customerserviceadmincenter#create-a-chat-authentication-setting-record on how to set up an authenticated chat
const chatSDKConfig = {
getAuthToken: async () => {
const response = await fetch("http://contosohelp.com/token");
if (response.ok) {
return await response.text();
}
else {
return null
}
}
}
const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
await chatSDK.initialize();
// from this point, this acts like a regular chat widget
See https://docs.microsoft.com/en-us/dynamics365/customer-service/persistent-chat on how to set up persistent chat
const chatSDKConfig = {
persistentChat: {
disable: false,
tokenUpdateTime: 21600000
},
getAuthToken: async () => {
const response = await fetch("http://contosohelp.com/token");
if (response.ok) {
return await response.text();
}
else {
return null
}
}
}
const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
await chatSDK.initialize();
// from this point, this acts like a persistent chat
See https://docs.microsoft.com/en-us/dynamics365/customer-service/configure-reconnect-chat?tabs=customerserviceadmincenter#enable-reconnection-to-a-previous-chat-session on how to set up chat reconnect
const chatSDKConfig = {
chatReconnect: {
disable: false,
},
getAuthToken: async () => {
const response = await fetch("http://contosohelp.com/token");
if (response.ok) {
return await response.text();
}
else {
return null
}
}
}
const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
await chatSDK.initialize();
...
const chatReconnectContext = await chatSDK.getChatReconnectContext();
if (chatReconnectContext.reconnectId) {
// Add UX with options to reconnect to previous existing chat or start new chat
}
// Reconnect chat option
const optionalParams = {};
optionalParams.reconnectId = chatReconnectContext.reconnectId;
chatSDK.startChat(optionalParams);
// Start new chat option
chatSDK.startChat();
See https://docs.microsoft.com/en-us/dynamics365/customer-service/configure-reconnect-chat?tabs=customerserviceadmincenter#enable-reconnection-to-a-previous-chat-session on how to set up chat reconnect
const chatSDKConfig = {
chatReconnect: {
disable: false,
},
}
const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
await chatSDK.initialize();
....
const optionalParams: any = {};
// Retrieve reconnect id from the URL
const urlParams = new URLSearchParams(window.location.search);
const reconnectId = urlParams.get('oc.reconnectid');
const params = {
reconnectId
};
// Validate reconnect id
const chatReconnectContext = await chatSDK.getChatReconnectContext(params);
// If the reconnect id is invalid or expired, redirect URL if there is any URL set in the configuration
if (chatReconnectContext.redirectURL) {
window.location.replace(chatReconnectContext.redirectURL);
}
// Valid reconnect id, reconnect to previous chat
if (chatReconnectContext.reconnectId) {
await chatSDK.startChat({
reconnectId: chatReconnectContext.reconnectId
});
} else { // Reconnect id from URL is not valid, start new chat session
await chatSDK.startChat();
}
See https://docs.microsoft.com/en-us/dynamics365/customer-service/create-operating-hours?tabs=customerserviceadmincenter on how to set up operating hours
const chatConfig = await chatSDK.getLiveChatConfig();
const {LiveWSAndLiveChatEngJoin: liveWSAndLiveChatEngJoin} = liveChatConfig;
const {OutOfOperatingHours: outOfOperatingHours} = liveWSAndLiveChatEngJoin;
if (outOfOperatingHours === "True") {
// Handles UX on Out of Operating Hours
} else {
await chatSDK.startChat();
// Renders Custom Chat Widget
}
:warning: Currently supported on web only
Minimum Requirement Checklist
import OmnichannelChatSDK from '@microsoft/omnichannel-chat-sdk';
import ReactWebChat, {createStore} from 'botframework-webchat';
// 1. ChatSDK Initialization
const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig);
await chatSDK.initialize();
// 2. Start new conversation
await chatSDK.startChat();
// 3. Create chat adapter
const chatAdapter = await chatSDK.createChatAdapter();
// 4. Create WebChat store with middlewares
const store = createStore(
{}, // initial state
sendDefaultMessagingTagsMiddleware // ❗ Required
);
// 5. Render WebChat
<ReactWebChat
store={store}
userID="teamsvisitor"
directLine={chatAdapter}
sendTypingIndicator={true}
/>
:warning: Currently supported on web only
See https://docs.microsoft.com/en-us/dynamics365/customer-service/call-options-visual-engagement on how to set up calling options
import OmnichannelChatSDK from '@microsoft/omnichannel-chat-sdk';
...
const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
await chatSDK.initialize();
let VoiceVideoCallingSDK;
try {
VoiceVideoCallingSDK = await chatSDK.getVoiceVideoCalling();
console.log("VoiceVideoCalling loaded");
} catch (e) {
console.log(`Failed to load VoiceVideoCalling: ${e}`);
if (e.message === 'UnsupportedPlatform') {
// Voice Video Calling feature is not supported on this platform
}
if (e.message === 'FeatureDisabled') {
// Voice Video Calling feature is disabled on admin side
}
}
await chatSDK.startChat();
const chatToken: any = await chatSDK.getChatToken();
// Initialize only if VoiceVideoCallingSDK is defined
if (VoiceVideoCallingSDK) {
try {
await VoiceVideoCallingSDK.initialize({
chatToken,
selfVideoHTMLElementId: 'selfVideo', // HTML element id where video stream of the agent will be rendered
remoteVideoHTMLElementId: 'remoteVideo', // HTML element id where video stream of the customer will be rendered
OCClient: chatSDK.OCClient
});
} catch (e) {
console.error("Failed to initialize VoiceVideoCalling!");
}
// Triggered when there's an incoming call
VoiceVideoCallingSDK.onCallAdded(() => {
...
});
// Triggered when local video stream is available (e.g.: Local video added succesfully in selfVideoHTMLElement)
VoiceVideoCallingSDK.onLocalVideoStreamAdded(() => {
...
});
// Triggered when local video stream is unavailable (e.g.: Customer turning off local video)
VoiceVideoCallingSDK.onLocalVideoStreamRemoved(() => {
...
});
// Triggered when remote video stream is available (e.g.: Remote video added succesfully in remoteVideoHTMLElement)
VoiceVideoCallingSDK.onRemoteVideoStreamAdded(() => {
...
});
// Triggered when remote video stream is unavailable (e.g.: Agent turning off remote video)
VoiceVideoCallingSDK.onRemoteVideoStreamRemoved(() => {
...
});
// Triggered when current call has ended or disconnected regardless the party
VoiceVideoCalling.onCallDisconnected(() => {
...
});
// Check if microphone is muted
const isMicrophoneMuted = VoiceVideoCallingSDK.isMicrophoneMuted();
// Check if remote video is available
const isRemoteVideoEnabled = VoiceVideoCallingSDK.isRemoteVideoEnabled();
// Check if local video is available
const isLocalVideoEnabled = VoiceVideoCallingSDK.isLocalVideoEnabled();
// Accepts incoming call
const acceptCallConfig = {
withVideo: true // Accept call with/without video stream
};
await VoiceVideoCallingSDK.acceptCall(acceptCallConfig);
// Rejects incoming call
await VoiceVideoCallingSDK.rejectCall();
// Ends/Stops current call
await VoiceVideoCallingSDK.stopCall();
// Mute/Unmute current call
await VoiceVideoCallingSDK.toggleMute()
// Display/Hide local video of current call
await VoiceVideoCallingSDK.toggleLocalVideo()
// Clean up VoiceVideoCallingSDK (e.g.: Usually called when customer ends chat session)
VoiceVideoCallingSDK.close();
}
| Custom Control | WebChat Control | |
|---|---|---|
| Features | ||
| Chat Widget UI | Not provided | Basic chat client provided |
| Data Masking | Embedded | Requires Data Masking Middleware implementation |
| Send Typing indicator | Embedded | Requires sendTypingIndicator flag set to true |
| PreChat Survey | Requires Adaptive Cards renderer | Requires Adaptive Cards renderer |
| Display Attachments | Requires implementation | Basic interface provided & Customizable |
| Incoming messages handling | IC3 protocol message data | DirectLine activity data |
| Custom Control | Gifted Chat Control | WebChat Control | |
|---|---|---|---|
| Features | Currently not supported | ||
| Chat Widget UI | Not provided | Basic chat client provided | X |
| Data Masking | Embedded | Embedded | X |
| Send Typing indicator | Embedded | Requires Implementation | X |
| PreChat Survey | Requires Adaptive Cards renderer | Requires Adaptive Cards renderer | X |
| Display Attachments | Requires implementation | Embedded | X |
| Incoming messages handling | IC3 protocol message data | IC3 protocol message data | X |
Omnichannel Chat SDK collects telemetry by default to improve the feature’s capabilities, reliability, and performance over time by helping Microsoft understand usage patterns, plan new features, and troubleshoot and fix problem areas.
Some of the data being collected are the following:
| Field | Sample |
|---|---|
| Organization Id | e00e67ee-a60e-4b49-b28c-9d279bf42547 |
| Organization Url | org60082947.crm.oc.crmlivetie.com |
| Widget Id | 1893e4ae-2859-4ac4-9cf5-97cffbb9c01b |
| Browser Name | Edge |
| Os Name | Windows |
| Anonymized IP Address (last octet redacted) | 19.207.000.000 |
If your organization is concerned about the data collected by the Chat SDK, you have the option to turn off automatic data collection by adding a flag in the ChatSDKConfig.
const omnichannelConfig = {
orgUrl: "",
orgId: "",
widgetId: ""
};
const chatSDKConfig = {
telemetry: {
disable: true // Disable telemetry
}
};
const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
await chatSDK.initialize();
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
FAQs
Microsoft Omnichannel Chat SDK
The npm package @microsoft/omnichannel-chat-sdk receives a total of 13,018 weekly downloads. As such, @microsoft/omnichannel-chat-sdk popularity was classified as popular.
We found that @microsoft/omnichannel-chat-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.