Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Bridge Phonism’s cloud-based device management with Webex by Cisco.

...

Webex integration

Phonism’s Webex by Cisco integration serves as a robust bridge between Phonism’s cloud-based device management and Webex by Cisco. Its primary objective is to assist Webex partners in the ability to deploy, manage, secure, and migrate VoIP devices at scale.

...

By integrating Phonism with Webex by Cisco, users can enjoy a cohesive device management experience, reducing manual efforts and ensuring their device ecosystem is always optimized and up-to-date.

...

Prerequisites

Phonism requirements

  • Active Phonism account. If you don’t have a Phonism account, contact sales@phonism.com.

  • Account-level super admin user access.

  • Email Template:

...

Info

Once your email is validated, you will be asked to accept the Terms & Conditions and be prompted to change password.

Webex by Cisco requirements

  • Access to partner-managed devices for Webex with a full-admin Partner account.

  • Full admin for the owned organization.

  • Authorization to add integrations from Webex App Hub.

  • Authorization to create Service Apps in Webex.

  • Webex Calling 

  • Feature enablement request required. To request enablement, follow these steps:

    • Log in to Control Webex Partner Hub with the Webex Partner Full Administrative credentials for your Partner Managed Organization.

    • Select Launch my organization. Your Partner Managed Organization’s Webex Control Hub launches.

      CleanShot 2024-11-08 at 10.31.27-20241108-153218.png
    • Select Account.

    • Copy the Organization name and Organization ID.

...

Info
  • Make sure the ORG ID is the highest level of the Partner ORG in Control Hub and NOT a Customer org ID.

...

SUBJECT: Partner Managed Device Feature Enablement - Toggle Enablement

BODY Content:

Dear Cisco Webex Wholesale Team:

I'm writing to request Partner Managed Device Feature Enablement - Toggle Enablement for the following Organization:

Organization Name: < Your company Name>

Organization ID: <Your Orginization ID>

Feature Toggle: wxc-partner-managed-devices-scopes 

Scope Name: spark-admin:devices_config_read

Direct Email Address to reply to: <Your email Address>

Additional technical requirements

  • Your Webex region must be known.

  • Device managed and device feature enabled for the partner account.

Third-party security requirements

The partnerPartner-managed devicesManaged Devices solution allows Webex partners and customers to support any non-Cisco SIP device (phones and gateways) on the Webex platform that complies with Cisco’s security and support requirements as listed below.

  • Support for TLS 1.2

  • Support for the IdenTrust certification authority

  • Basic failover capabilities (single primary/secondary)

  • Support Cisco’s minimum password security requirements

  • Active support from the device vendor

  • Webex Cloud Certification

  • Webex Calling

INSTALLATION AND SETUP

Phonism integrates with Webex by using two Webex applications.

  1. A Phonism Webex Integration app that is available through information can be found on the Webex App Hub. This app integration is responsible for syncing all the assets between Phonism and Webex.

...

  1. A Webex Service App that has to be created and owned by the Webex Partner Managed Organization’s Partner Full Admin. A Service App User will need to be created to manage the Webex Service App. This app is responsible for creating the API Tokens for accessing and refreshing the config device info file of each partner managed device.

App Hub integration 

  1. Once you have a Phonism account and have successfully logged in, select the following link to start, depending on your region: some text

    1. US integration: https://app.phonism.com/integration/webex/wizard

    2. EUW integration:https://app.euw1.phonism.com/integration/webex

...

Click Manage Phones / Start Managing Devices to be redirected to Phonism.

Create a Service App user in Control Hub

Before you begin:

  • This user must be a Partner Full admin who can create users and Service Apps for the Partner Managed Org.

  • Additionally, you’ll need a Service App User who can log in to the http://developer.webex.com portal.

  • The Service App User needs a valid e-mail address. This must be a new user and you must be able to activate the email address and set the password.

  • You can’t add existing users in your organization or users who already have a Webex account.

...

Now that your Service App user is created, use these credentials to log in to the Webex Developer Portal to create and authorize the Service App.

...

Create and authorize the Service App

  1. Use the Service App User’s credentials created and activated in the previous steps to sign in to the Webex Developer Portal (shown above).

  2. Select My Webex Apps from the menu under your avatar.

...

  1. Enter the following information:

  2. App name: Phonism ServiceApp

  3. Icon: Select a Favicon and double click on the Favicon or add you can add your own 

  4. Description: Type a description such as:  “ServiceApp for Phonism Integration and creation for API Tokens.”

  5. Contact Email: Enter the email address of the Service App user.

  6. Select the scope: spark-admin:devices_config_read

...

  1. Next, select Request admin authorization. When this request is accepted, a new field appears under Authorization called Org Authorizations, where you’ll be able to select which org you’d like to apply the authorized Client Secret to. You may need to refresh the page to see the new field.

...

  1. Next, add the Service App integration app in via Webex Partner Hub into Webex Control Hub.

    1. Login into Webex Partner Hub and Click 'Launch my organization' (this will redirect you to Webex Control Hub)

...

  1. Under Management, select Apps

  2. Select Service Apps

...

  1. Find and select (click) the app you’ve just created in Webex Developer Portal

  2. Select the toggle to authorize and click Save.

...

  1. Next, login into Phonism with your Phonism Super Admin account:

    1. North America: https://app.phonism.com/

    2. Europe: https://app.euw1.phonism.com/

Add the Service App in Phonism

Once your Service App is created, you can add the Service App information to your Webex integration in Phonism.

...

Info

Note: Partner-managed devices and users transfer to Phonism. Once synchronized, information from Webex Partner Hub should be visible from Phonism. The sync process starts when you click Import Webex Data into Phonism after the API Token is added. You can sync all assets on demand by clicking Sync next to the integration. By default, each enabled Webex integration is synchronized every 24 hours. 

...

REMOVE WEBEX INTEGRATION

If you need to remove the integration for any reason, follow these steps.

  1. First, remove the link. This keeps any assets administered in the Webex instance intact. 

    1. Log in to Phonism and select Account.

    2. Select Service Provider and then Enterprise.

    3. Select the Trash icon on the right side.

  2. Next, delete the items in Phonism or submit a ticket for us to fully delete the instance and its data.

...

USE CASES AND FUNCTIONS

Hierarchy synchronization

Phonism syncs the Webex hierarchy into Phonism, beginning from the Enterprise automatically created by adding the Webex integration. Each Webex Organization corresponds to the respective domain in Phonism and each Webex location corresponds to the respective tenant in Phonism.

...

Device info file per organization

...

SIP credentials management

For partner-managed devices, SIP registration credentials must be managed by the Partner. By using our integration, Phonism manages SIP credentials on your behalf and ensures both Webex and the device are in sync.

...

  • Create a new phone at the appropriate tenant in Phonism using the MAC in Webex.

  • Create a new user (Phonism treats Common Areas as Users) and associate it with the new phone.

  • Retrieve and store device configuration metadata from Webex.

  • Create VoIP credentials for each SIP registration defined in Webex for the device.

  • Generate passwords for corresponding SIP registrations and update them in Webex.

  • Assign relevant VoIP credentials to the phone's corresponding lines in Phonism.

Automatic device redirection

When a redirect service account is associated with Phonism, all related MACs added to your Phonism account are configured for automatic redirection to Phonism for a Zero-Touch Provisioning experience. This includes devices added through the Webex integration.

...

More information on setup can be found here: Zero-Touch Provisioning

Automatic device redirection

For select devices, when a Webex integration is added to your Phonism account, Phonism templates are automatically added at the root of your Webex integration. These templates are optimized for Webex service, incorporating best practices and ensuring the device is configured to a ring-ready state. For automatic template application to occur, you must do the following:

  • Navigate to the root of your Webex integration in Phonism.

  • Go to the Templates tab.

  • Review each template that was automatically imported.

  • Update the Template State and set it to Auto Apply so that all relevant devices under this hierarchy will have these templates applied to them.

...

Info

Additional Template Information can be found here: Phonism Template Information

BEHAVIOR CHANGES IN PHONISM

The following applies to hierarchies and assets associated with a Webex integration.

Asset creation, updates, and deletions

Domains / Organizations:

  • Must be created in Webex Control Hub; can’t be created in Phonism.

  • New organizations are periodically synchronized into Phonism.

  • Organizations are read-only in Phonism.

...

  • SIP usernames and authorization IDs are pulled from Webex and both values remain read-only in Phonism.

  • The password of each VoIP username is auto-generated and pushed to Webex any time that the integration pulls a new SIP registration.

  • Updating a VoIP credential password updates the password of the corresponding SIP registration in Webex.

Device configuration from Webex

Webex provides a generic configuration file for partner-managed devices. Phonism retrieves, parses, and stores these configuration values. For select phone models, these generic values are auto-converted into phone-compatible configurations. For other phones, these values are accessible in Phonism through Phonism tags for phone and template configuration.

Device synchronization interval

Phonism checks periodically for asset updates due to Webex API limitations.

  • Asset creations, updates, moves, and deletions are reflected in Phonism.

  • Updates of organizations, locations, users, workspaces, and devices are polled every 24 hours by default.

  • If a device requests a configuration file from Phonism, an on-demand synchronization check is performed, given that we haven’t done a synchronization check within a certain period.

TROUBLESHOOTING

Common issues and resolutions

Problem: Integration isn't syncing.

Solution: Verify that your Webex Service App's permissions are correctly set in Webex Control Hub. Also, check if your account has the correct access level in Phonism.

Locate logs and error messages

  1. Log in to Phonism.

  2. Select the Logs tab.

  3. Filter by date, device, or error code.

...

Frequently asked questions

Q: Does the integration auto-update?

...