Merge pull request #409 from elopezanaya/extend-getchat-token

Extend getchat token : pass Ms-Oc-Bot-Application-Id

Author: elopezanaya

README.md

@@ -243,6 +243,47 @@ const optionalParams = {
 await chatSDK.initialize(optionalParams);
 ```
 
+## Passing cpsBotId on initialization
+
+cpsBotId in UUID format, when present will use v4 for GetchatToken. (Limited to enabled orgs) establishing the connection with Copilot Bot specified.
+
+### Scenarios
+
+- if bot id is present and valid, SDK will use `V4` for `GetchatToken` establishing the connection with the dessired Copilot Bot.
+- if bot Id is not present, flow will continue using `V2` for `GetchatToken`
+- if bot Id is not in valid format, expect a `400 HTTP Response Error Code`
+- if bot Id is not enabled for the workstream, expect `403 HTTP Response Error Code`
+
+```ts
+
+import OmnichannelChatSDK from '@microsoft/omnichannel-chat-sdk';
+
+const omnichannelConfig = {
+    orgUrl: "",
+    orgId: "",
+    widgetId: "",
+    cpsBotId: ""
+};
+
+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);
+
+```
+
 ### Start Chat
 
 It starts an Omnichannel conversation.

package-lock.json

@@ -48,7 +48,7 @@
     "@azure/communication-chat": "1.5.4",
     "@azure/communication-common": "2.3.1",
     "@microsoft/botframework-webchat-adapter-azure-communication-chat": "^0.0.1-beta.2",
-    "@microsoft/ocsdk": "^0.5.13",
+    "@microsoft/ocsdk": "^0.5.14",
     "@microsoft/omnichannel-amsclient": "^0.1.8",
     "@microsoft/omnichannel-ic3core": "^0.1.5"
   }

package.json

@@ -153,6 +153,7 @@ class OmnichannelChatSDK {
     private AMSClientLoadCurrentState: AMSClientLoadStates = AMSClientLoadStates.NOT_LOADED;
     private isMaskingDisabled = false;
     private maskingCharacter = "#";
+    private botCSPId: string | null = null;
     private isAMSClientAllowed = false;
 
     constructor(omnichannelConfig: OmnichannelConfig, chatSDKConfig: ChatSDKConfig = defaultChatSDKConfig) {
@@ -208,6 +209,10 @@ class OmnichannelChatSDK {
             this.maskingCharacter = this.chatSDKConfig.dataMasking.maskingCharacter;
         }
 
+        if (omnichannelConfig.cpsBotId) {
+            this.botCSPId = omnichannelConfig.cpsBotId;
+        }
+
         loggerUtils.setRequestId(this.requestId, this.ocSdkLogger, this.acsClientLogger, this.acsAdapterLogger, this.callingSdkLogger, this.amsClientLogger, this.ic3ClientLogger);
     }
 
@@ -1148,6 +1153,10 @@ class OmnichannelChatSDK {
                     getChatTokenOptionalParams.refreshToken = optionalParams?.refreshToken;
                 }
 
+                if (this.botCSPId) {
+                    getChatTokenOptionalParams.MsOcBotApplicationId = this.botCSPId;
+                }
+
                 const chatToken = await this.OCClient.getChatToken(this.requestId, getChatTokenOptionalParams);
                 this.setChatToken(chatToken)
                 this.scenarioMarker.completeScenario(TelemetryEvent.GetChatToken, {

src/OmnichannelChatSDK.ts

@@ -2,4 +2,5 @@ export default interface OmnichannelConfig {
     orgId: string;
     orgUrl: string;
     widgetId: string;
+    cpsBotId?: string;
 }