Setting up Zoom Contact Center chat bot integration

Last Updated:

Contact center admins can integrate Zoom Contact Center with Google Dialogflow ES or Amazon Lex to enable consumers to interact with these chat bots.

This article covers:

Prerequisites for setting up chat bot integration

Note: For more information on setting up a Solvvy, Google Dialogflow ES, or Amazon Lex chat bot, visit the following support sites. Zoom doesn’t provide support for Dialogflow ES or Amazon Lex configurations.

How to set up a chat bot integration

Solvvy

  1. Sign in to the Solvvy dashboard.
  2. In the navigation menu, click Settings.
  3. Click the Connections tab.
  4. Click the name of the pre-existing Zoom Contact Center connection.
  5. Copy the Zoom Contact Center Bot Authentication JSON field.
  6. Sign in to the Zoom web portal.
  7. In the navigation menu, click Contact Center then AI Management.
  8. Click Bots.
  9. Click Add Bot, then specify these settings:
    • Name: Enter an internal display name to help identify the chat bot.
    • Integration Source: Select Solvvy.
    • Authentication: Paste the JSON you copied and remove the orgID field so that only the connectId and authentication fields remain.

      Example:
      {

      "connectorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",

      "authentication": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

      }

    • Link to Bot Settings: Enter an external link URL to link to. This will insert a shortcut link from the Zoom web portal to the third-party bot settings.
  10. Click Test Connection to make sure the connection is authenticated.
  11. Click Save.

Google Dialogflow ES

  1. Sign in to the Google Dialogflow console.
  2. Sign in to the Zoom web portal.
  3. In the navigation menu, click Contact Center then AI Management.
  4. Click Add Bot, then specify these settings:
    • Name: Enter an internal display name to help identify the chat bot.
    • Integration Source: Select Google..
    • Authentication: Obtain the authentication information from Google Cloud > APIs & Services Credentials > Credentials.
      Example:

      {

      "type": "service_account",

      "project_id": "victor-bot-ej9b",

      "private_key_id": "*****",

      "private_key": "-----BEGIN PRIVATE KEY-----\n*******\n-----END PRIVATE KEY-----\n",

      "client_email": "victor@victor-bot-ej9b.iam.gserviceaccount.com",

      "client_id": "100891150127753595672",

      "auth_uri": "https://accounts.google.com/o/oauth2/auth",

      "token_uri": "https://oauth2.googleapis.com/token",

      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",

      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/victor%40victor-bot-ej9b.iam.gserviceaccount.com"

      }

      • Link to Bot Settings: Enter an external link URL to link to. This will insert a shortcut link from the Zoom web portal to the third-party bot settings.
  5. Click Test Connection to make sure the connection is authenticated.
  6. Click Save.

Amazon Lex

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click Contact Center then AI Management.
  3. Click Add Bot, then specify these settings:
    • Name: Enter an internal display name to help identify the chat bot.
    • Integration Source: Select Amazon Lex.
    • Authentication

      {

      "botId": "SPU6D5LYEE",

      "botAliasId": "TSTALIASID",

      "localeId": "en_US",

      "region": "us-west-2",

      "access_key": "******",

      "secret_key": "*******"

      }

    • Link to Bot Settings: Enter an external link URL to link to. This will insert a shortcut link from the Zoom web portal to the third-party bot settings.
  4. Click Test Connection to make sure the connection is authenticated.
  5. Click Save.

Obtain Amazon Lex authentication information

Note: If you encounter issues, refer to the Amazon AWS support site.

Field How to obtain the fieldin AWS
botId
  1. Sign in to the AWS account.
  2. In the left-side navigation menu, click Amazon Lex then select a bot.
  3. In the Bot details section, find the ID field.
botAliasId
  1. Sign in to the AWS account.
  2. In the left-side navigation menu, click Amazon Lex then select a bot.
  3. In the left-side navigation menu, click Deployment then Aliases.
  4. In the Details section, find the ID field.
localeId
  1. Sign in to the AWS account.
  2. In the left-side navigation menu, click Amazon Lex then select a bot.
  3. In the left-side navigation menu, click All languages.
  4. Take note of the language, then find the relevant language code.
region
  1. Sign in to the AWS account.
  2. In the top-right corner, select a region.
  3. Take note of the region code next to the region name. Example region code: us-west-2.

access_key

secret_key

  1. Sign in to the AWS account as a root user.
  2. Select your account.
  3. In the top-right corner, click the account name then click Security credentials.
  4. The Access keys (access key ID and secret access key) section, click Create New Access Key.

If you have IAM access and want to generate security credential for a user:

  1. Sign in to the AWS account.
  2. In the left-side navigation menu, click Access management then Users.
  3. Select a user.
  4. Click the Security credentials tab.
  5. Click Create access key.

 

How to add a chat bot integration to a Zoom Contact Center flow

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click Contact Center Management then Flows.
  3. Click a flow's display name to edit it.
  4. In the left-side widgets panel, click and drag Bot onto the preferred location in the flow.
  5. Select the Bot widget.
  6. (Optional) Click Rename to change the display name of the widget.
  7. In the Settings tab, customize these options:
    • Bot: Select the bot you want to add to the flow.
    • Max Wait Time: Enable the toggle to apply a max wait time to every message sent by the bot to a consumer. Specify the max wait time in seconds. Once this is exceeded after the bot sends a message to a consumer, the flow will route to the widget specified in the exit setting. If an exit is not specified, the engagement will end.
  8. Click the Exits tab to customize these options:
    • Transfer to Staff Service: Specify the route if the consumer requests to be transferred to a live agent. You can route to any widget in the flow. For example, you can route to a chat queue.
    • End: Select the widget for when the chat engagement ends.

Example

Note: This section shows an example configuration and is not meant to be a complete configuration guide.

This example shows a simple chat bot flow. If the consumer requests to be transferred to a live agent, the flow routes to a chat queue. If the chat engagement ends, a message is displayed to the consumer.

Flow layout

Bot widget

Settings

  • Bot: Select the chat bot integration.

Exits

  • Transfer to Staff Service: Select the Route to widget.
  • End: Select Send Media widget.

Route to widget

  • Route to: Select Queue.
  • Queue: Select the chat queue with agents to route to.

Send Media widget

  • Media Type: Select Text.
  • Text 1: Enter Thanks for contacting us.

How to configure Amazon Lex to route a consumer back to the Zoom Contact Center flow

Important: If you encounter issues, refer to the Amazon Lex support site for help. Zoom doesn’t provide support for Amazon Lex configurations.

Once the Zoom Contact Center flow sends a consumer to the Amazon Lex third party bot, the consumer will remain inside Lex until Lex signals back to the Zoom Contact Center that the consumer should be returned to the Zoom Contact Center flow.

Routing from Amazon Lex to the Zoom Contact Center Transfer to Staff Service exit:

  1. Sign in to the Amazon Lex Portal.
  2. Configure an intent; for example, TransferToAgent.
  3. Configure some Sample utterances such as connect to an agent.
  4. Configure the intent to go to the Closing response step. In the Closing Response step, configure the custom payload {"liveAgentHandoff":true}.

Routing from Amazon Lex to the Zoom Contact Center End exit:

  1. Sign in to the Amazon Lex Portal.
  2. Configure an intent, for example EndChat.
  3. Configure some Sample utterances such as goodbye.
  4. Configure the intent to go to the Closing response step. In the Closing Response step, configure the custom payload {"sessionEnd":true}.

How to configure Google Dialogflow to route a consumer back to the Zoom Contact Center flow

Important: If you encounter issues, refer to the Google Dialogflow ES site for help. Zoom doesn’t provide support for Google Dialogflow configurations.

Once the Zoom Contact Center flow sends a consumer to the Dialogflow third party bot, the consumer will remain inside Dialogflow until Dialogflow signals back to the Zoom Contact Center that the consumer should be returned to the Zoom Contact Center flow.

Routing from Google Dialogflow to the Zoom Contact Center Transfer to Staff Service exit:

  1. Sign in to the Dialogflow Portal.
  2. Configure an intent, for example TransferToAgent.
  3. Configure some Training Phrases such as connect to an agent.
  4. Save the intent and download the intent as a .JSON file.
  5. Edit the JSON file locally and set liveAgentHandoff to true.
  6. Delete the intent from the Dialogflow website and then recreate the intent by uploading the modified .json file. This will create the intent with the liveAgentHandoff set to true.

Routing from Google Dialogflow to the Zoom Contact Center End exit:

  1. Sign in to the Dialogflow Portal.
  2. Configure an intent, for example TransferToEnd.
  3. Configure some Training Phrases such as goodbye.
  4. In the Responses section, enable the Set this intent as end of conversation. Do not configure any text response or custom payload on this intent.

Zoom Community

Join the 100K+ other members in the Zoom Community! Login with your Zoom account credentials and start collaborating.