Live Chat Worker

Type: Live Chat Worker

A worker for all live chat providers.

Note: live chat workers cannot be interacted with directly by users, they must be transferred from another worker first.

Worker Configs

{
  "Data": {
    "Provider": "newProvider", // The provider, should be camelCase.
    "SlashCommand": {}, // Configuration that is not specific to the provider should exist at the top level of the Data object
    "BotConversationHistory": true, // if enabled, the conversation history will be sent to the agent when the live chat starts
    "BotConversationSummary": true, // if enabled, an AI generated summary of the conversation will be sent to the agent when the live chat starts. OpenAI secret must me configured for the organization.
    "ProviderConfiguration": {  // Object for Provider specific configuration 
      "ProviderApiUrl": "some-url",
    },
    "ConversationMute": true // if enabled, we do not persist the conversation with the agent into Dynamo. CHS will still persist.
  },
  "Config": {}, // Default worker config fields
  "Enabled": true,
  "Type": "live-chat-worker",
  "Name": "LiveChatWorkerEdgetier",
}

Creating a live chat worker through CLI

Save this JSON to a file and create a worker using the CLI command sb-cli worker create file.json.

Conversation Mute

The Conversation Mute feature lets you configure a chatbot worker (such as an EdgeTier or Five9 worker) to prevent live chat messages from being saved. When the Conversation Mute option is enabled in the worker settings, any messages sent during live chat conversations handled by that worker will not be stored. This feature is useful for keeping certain chat interactions private

EdgeTier

{
  "Data": {
    "Language": "en",
    "Provider": "edgetier",
    "ProviderConfiguration": {
      "SetupId": 1,
      "FormsId": 1,
      "Api": "url"
    },
    "ConversationMute": true
  },
  "Config": {},
  "Enabled": true,
  "Type": "live-chat-worker",
  "Name": "LiveChatWorkerEdgetier"
}

Five9

{
  "Data": {
    "DefaultDisplayName": "LiveChatWorkerFive9",
    "Provider": "five9",
    "ProviderConfiguration": {
      "CampaignName": "campaignName",
      "TenantName": "tenantName",
      "Url": "url"
    },
    "ConversationMute": true
  },
  "Config": {},
  "Enabled": true,
  "Type": "live-chat-worker",
  "Name": "LiveChatWorkerFive9"
}