Zoom App

You can configure a digital assistant to work within Zoom Meetings video conferences.

  • You access your digital assistant through the Oracle Digital Assistant for Zoom app, which you can install through Zoom's App Marketplace.
  • Users can then chat with your digital assistant within that app during an ongoing Zoom meeting.

Below are the steps for creating a Zoom App channel for Digital Assistant.

Step 1: Install Zoom's Digital Assistant App

  1. Go to the Oracle Digital Assistant for Zoom app in the Zoom App Marketplace.
  2. If you are not signed in to Zoom, click Sign in to Add.
  3. Click Authorize to install Oracle Digital Assistant for Zoom.

Step 2: Create a Channel in Digital Assistant

  1. In Digital Assistant, click Channels in the left menu and then choose Users.

  2. Click + Channel to open the Create Channel dialog.

  3. Give your channel a name.

  4. Choose Zoom App as the channel type.

  5. In the Allowed Domains field, enter any allowed domains from which users can connect.

    This field controls which domains can connect to the Zoom App channel. In most cases you'll probably want to enter the asterisk wildcard (*) to indicate all domains.

  6. Click Create.

  7. Click icon for the Route To ... dropdown and select the digital assistant or skill that you want to associate with the channel.

  8. In the Route To dropdown, select the digital assistant or skill that you want to associate with the channel.

  9. Switch on the Channel Enabled control.
  10. Keep the page open so that you can use the Secret Key and Channel ID values in the next step.

Step 3: Create a Connection to the Channel from the App in Zoom

Once the Zoom app is installed and the channel is created, you need to create a connection to between Zoom and the Zoom App channel to be able to use the digital assistant within the Zoom interface.

To create a new connection:

  1. Within your Zoom client, click the Connect Skill tab.
  2. Enter a name. We recommend it matches the one in your Oracle Digital Assistant instance.
  3. Enter the hostname of your Oracle Digital Assistant instance.

    This is the part of the Digital Assistant URL that comes after https:// and before /botsui

  4. Enter the channel ID of the Zoom App channel that you just created.
  5. Enter the secret key of the Zoom App channel.
  6. (Optional) If you want the connection to only be visible to you, select the Connect Privately checkbox.

    If unchecked, this connection will be visible to anyone under the same Zoom account as you.

  7. Press Connect.

    Once the connection is made, a chat widget for the digital assistant should appear within the Zoom interface.

  8. Test the digital assistant by entering text into the chat widget.

If the digital assistant works as expected, your connection is ready to go and you can close the chat widget.

When you are done interacting with the digital assistant, click the X at the top right-hand corner to exit.

Open the Connection to Your Digital Assistant

Once you have created a connection to a digital assistant through a Zoom App channel, you can open the digital assistant from your Zoom client at any time:

  1. In your Zoom client, click the Most Recent tab.

    This tab is only visible if you have one or more saved connections.

  2. To search for an existing connection, start typing the name of the connection in the search bar.
  3. Once you find the connection you are looking for, click it.

    A chat widget for the digital assistant will open.

Uninstall the Digital Assistant for Zoom App

If you need to uninstall the Oracle Digital Assistant for Zoom app, follow these steps:

  1. Sign in to your Zoom account
  2. Navigate to the Zoom App Marketplace.
  3. Click Manage > Added Apps and search for the Oracle Digital Assistant entry.
  4. Click the Oracle Digital Assistant for Zoom entry's Remove button.

Zoom App Channel Limitations

The Zoom App environment provided by Zoom is very similar to that of a web browser, with key differences:

  • You cannot access the microphone. That means that when interacting with your skill through the Zoom App channel, you can only type.
  • There isn't an API for accessing the user's location. If your skill requires obtaining a user's location, you can ask them to provide it manually.

Zoom App Channel Attributes Available to Skill

When a skill is connected through a Zoom App channel, you can get user profile information from Zoom for each piece of user input in the conversation. Here are expressions that you can use to get user profile information:

  • ${profile.user.value.id}: The current user's Zoom user ID.
  • ${profile.user.value.first_name}: The current user's first name.
  • ${profile.user.value.last_name}: The current user's last name.
  • ${profile.user.value.email}: The current user's email address.

For more information on the user attributes available through these expressions, see https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#tag/Users.

Zoom also has variables that enable you to get information about the meeting itself. To access them, the meeting must be created in the account of the current user. Here are the expressions that you can use to access that information:

  • ${profile.meeting.value.id}: The ID for the Zoom meeting. When the meeting is a recurring meeting, this value is the same for each occurrence of the meeting.
  • ${profile.meeting.value.uuid}: The ID for the occurrence of a Zoom meeting. This value is always unique, even between occurrences of the same meeting.
  • ${profile.meeting.value.created_at}: The date and time that the meeting was scheduled. If this meeting was initiated without being scheduled, its value will be identical to ${profile.meeting.value.started_at}.
  • ${profile.meeting.value.started_at}: The date and time that the meeting was started.
  • ${profile.meeting.value.host_id}: ID of the meeting host.
  • ${profile.meeting.value.host_email}: Email of the meeting host.
  • ${profile.meeting.value.topic}: Short meeting description.
  • ${profile.meeting.value.agenda}: Long meeting description.
  • ${profile.meeting.value.recurrence}: If the meeting is a recurring meeting, this expression accesses an object that details when the meeting starts, how many times it repeats, when it stops repeating (if applicable), the type of recurrence (monthly, weekly, daily, etc.) and when it recurs (e.g. which day it recurs if it's a weekly or monthly meeting).
  • ${profile.meeting.value.type}: An integer that indicates the type of meeting. (1 is an instant meeting, 2 is a scheduled meeting, 3 is a recurring meeting with no fixed time, and 8 is a recurring meeting with fixed time.)

If the current user is the meeting owner, you can get the following information on the participants. This information is actively maintained as participants join and leave, so each utterance will have the most up-to-date information on participants at that moment:

  • ${profile.meeting.participants}: An array that contains the meeting's current participants. Each array object contains the following objects:
    • participantUUID: The ID of the participant (unique in each meeting)
    • screenName: The particpant's screen name.
    • role: The participant's role (e.g., host, co-host, attendee).
    • active: A boolean indicating whether the participant is currently in the meeting or not.

For more information on the meeting profile variables, see https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#tag/Meetings.

Troubleshooting

If you have problems installing the Oracle Digital Assistant for Zoom app or have problems connecting with a digital assistant in a Zoom meeting, first follow the directions provided in any displayed error messages.

If you continue to have problems, check with the administrator of your team's Zoom account and/or the administrator of your team's Oracle Digital Assistant instance.

For questions or issues that cannot be addressed, please reach out to My Oracle Support.