Configuring the Zoom-Avaya Aura integration
The Zoom-Avaya Aura integration enables users to leverage the benefits of Zoom Workplace while connecting from the Zoom Phone tab to an Avaya Aura system for telephony features. This integration is ideal for users who are currently utilizing Zoom and want to add more Zoom Phone features, and who also have an Avaya Aura Communication Manager or Avaya Enterprise Cloud in their environment.
This integration allows the Zoom Phone tab to become a SIP Softphone that registers to Avaya, using the Avaya Session Manager (SM) and Avaya SBC (ASBCE), if accessed over the Internet. It will also leverage the Avaya Aura Device Services (AADS) for a simplified login from Zoom to the Avaya Aura system. Users will be required to have all of these Avaya components in their environment to support this integration.
Notes:
- This feature must be enabled by Zoom.
- Avaya setup and detailed requirements will not be covered in this documentation. Please contact Avaya or your Avaya partner for additional information.
This article covers:
Prerequisites for configuring the Zoom-Avaya Aura integration
Note: The customer account must be enabled for the Zoom-Avaya Aura integration during the customer account setup.
Zoom
Avaya
- Avaya Aura version 10.x or Avaya Enterprise Cloud
- Avaya Aura Session Manager
- Avaya Aura Device Services
- Avaya license for Zoom Workplace Clients
Note: Contact Avaya for more info - Avaya SBC (ASBCE) for external registration
Notes:
- The Zoom Workplace app uses the standard Firewall ports and IP ranges.
- Phone signaling/media are determined by the Avaya Aura configuration and may differ from standards. Please contact Avaya or your Avaya Partner for additional information.
How to configure Zoom user management
First, you must add users to your Zoom account and assign licenses to them before setting up users for the Zoom-Avaya Aura integration.
- Complete the initial Zoom Phone setup.
Note: The main company number is not needed and should not be filled out. A test extension and emergency address will need to be added but won't be used for Avaya users. These steps are to enable access to Zoom Phone menus. - Disable the Automatic Phone Assignment for Zoom Workplace Licenses setting.
- Add users to Zoom (manual, SSO, AD Sync, etc.).
- Assign licenses to users.
How to set up the Avaya Aura integration
Add client ID mapping
- Sign in to the Avaya Aura Device Service (AADS) admin web portal.
- In the left navigation menu, click Security Settings, then click Client ID Mapping.
- Click Add.
A window will appear. - In the window, enter the following information:
- Click OK.
Export the Session Manager Key
- On the System Manager web console, click Elements then Session Manager.
- In the left navigation menu, click Network Configuration, then click Push Notification.
- Click Notification Provider.
The Provider Settings page will appear. - In the Key to Export field, view the key.
- To the right of Session Manager to Verify Settings, click the dropdown menu to select a session manager.
- At the top of the page, click Verify Settings to confirm a successful connection.
Note: If the key hasn't been exported to the user's Avaya cloud account, the Verify Settings Status will display an error message.
How to configure Phone System Integration settings
After configuring Zoom user management, you can set up users for the Zoom-Avaya Aura integration.
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Account Management then Phone System Integration.
- Click the Settings tab.
- Configure the following settings:
- Zoom discovery URL: Click the copy icon to copy the URL, then paste it into your Avaya system. This URL is provided by Zoom, and you will always see this when you log in.
- Avaya Aura Device Service domains: View the list of Avaya Aura Device Service (AADS) domains.
Note: You must complete this section before adding users in the Integrated Users tab. Ensure that the client names match those in the client mapping of the AADS.
- Click Manage.
A pop-up window will appear. - In the window, create an AADS domain by specifying the Client name and the AADS domain (which is the AADS URL that is found in the Avaya system).
Note: A maximum of 10 AADS integrations can be added to Zoom. - (Optional) Click + Add to add another row.
- (Optional) Click the trash icon to delete a row.
- Click Save to save your changes.
- Session manager key for Avaya push notification: View or enter the session manager key for Avaya push notifications.
Note: You must copy and paste this from the Settings tab in the Avaya System Manager. - Integrated calling on Zoom mobile: Click the Allow use the integrated phone system to phone call on Zoom mobile client toggle to enable or disable it.
Notes:
- Ensure that this setting is always enabled.
- If this option is turned on and the users are on the list of Phone System Integration, these users can use a third-party phone system to place a call.
How to manage users for the Zoom-Avaya Aura integration
Add Zoom users to the Avaya Aura integration
Manually add users
Note: You can add a maximum of 50 users.
- Configure Phone System Integration settings.
- After configuring Phone System Integration settings, click the Integrated Users tab at the top of the page.
- In the top-right corner, click Add AADS user.
A pop-up window will appear, presenting a list of Zoom users with the appropriate licenses. - Select the checkboxes of the users that you want.
- Under Assign AADS domain, click the dropdown, then select an AADS domain for the selected user(s).
- Click Add.
The user will be added to the Integrated Users tab.
Import users
To add users, ensure that the email address matches the email address that was used while creating the Zoom user and the assigned license. Updated users can only be applied to the AADS domain, so do not modify the email address in the existing data. Ensure that the AADS domain matches the domain registered in the Settings tab.
Note: The maximum number of users is 10,000.
- Configure Phone System Integration settings.
- After configuring Phone System Integration settings, click the Integrated Users tab at the top of the page.
- At the top of the page, click Import from CSV, then choose Import PSI users with AADS.
- In either the Add users tab or the Update users tab, download and edit the CSV template, then upload the template.
Export users to a CSV file
- Add Zoom users to the Avaya Aura integration.
- Click the Integrated Users tab at the top of the page.
- At the top of the page, click Export to CSV file.
The list of users and their information will be exported to a CSV file.
Use additional actions for Zoom users
- Add Zoom users to the Avaya Aura integration.
- To the right of the users you want to manage, click the ellipsis icon , then click from the following options:
- Choose an AADS domain: To edit the AADS domain, click the dropdown menu to select an AADS domain to assign to the user, then click Update.
- Reprovision to Zoom Phone: Reprovision the user to Zoom Phone. This will move the user and license to Zoom Phone.
- If you need this user to be able to use Zoom Phone, access Phone System Management to continue configuring the user.
- If you want to remove the user completely from your Zoom account, access User Management to complete the action. This will release the license.
Security considerations for the Zoom-Avaya Aura integration
When using encrypted channels, the root certificates used for your Avaya deployment will also need to be added to the local trust store on the machines running the Zoom Workplace app. This will help ensure that connectivity can be established with your Session Manager for internal registration and the ASBCE for external registration. Many organizations will leverage MDM to manage trusted root certificates across enterprise devices for both internal and external certificate authorities, but they can also be manually added to the trust store for your specific operating system.
Zoom recommends encrypting signaling and media, especially for external registrations. The Zoom Workplace app will always first try to register using TLS and leverage SRTP for media. However, the app will also fall back to SIP and RTP if your Avaya deployment does not have this configured.
How to manage external contacts (non-Zoom contacts)
Create and upload external contacts
Contact Zoom Support to have BYOC/BYOP features enabled.
Note: After contacting Zoom Support, please allow up to 3 business days for the feature to be enabled.
Account owners and admins can create a shared directory of external contacts. The shared directory is accessible by Zoom Phone users using the Zoom Workplace desktop or mobile app. External contacts are displayed in the contact group Imported Contacts under the All Contacts section in the Contacts tab. Imported contacts are searchable and callable via Phone, Team Chat, and Contacts in the Zoom Workplace app.
Status of the Phone System Integration (PSI) user
Status | Description |
---|
Idle | The SIP credential has already been synchronized with Zoom, but the user has not yet registered with the Zoom Workplace app. |
Syncing | Waiting for Zoom to load SIP credentials, which is dependent on the sync queue workload. |
Sync failed | Unable to load SIP credentials from the AADS. |
Register failed | The Zoom Workplace app is unable to register with the SIP credential. You can check the error code and detailed errors on the PSI page. |
Registered | The Zoom Workplace app has successfully registered with the SIP server. |