[Index]

Model: relation/SparkCustomer

Customer Access

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

This procedure adds a Webex App service.

Prerequisites:

To allow VOSS Automate to connect to the Webex App Cloud API, obtain the following from the Cisco Webex page:

Perform these steps:

  1. Log in to the Admin GUI as a provider or reseller administrator.

  2. Select the hierarchy path to the correct customer node.

  3. Select Services > Webex App > Access Token to display Webex App Account.

    The form opens on a separate tab, at the following URL: https://us-central1-webex-teams-auth-token.cloudfunctions.net/webex_teams_oauth

  4. Click the GET TOKENS link.

  5. In the Email address field on the Cisco Webex page, enter a valid email address; then, click Next.

    An email address and password are only required the first time you log in to the Cisco Webex site.

  6. In the Password field on the Cisco Webex page, enter a valid password; then, click Sign In.

  7. View the codes/tokens generated and displayed on the form:

  8. Click on each Copy button in turn to copy the item, return to the VOSS Automate tab, and paste in the appropriate field on the Customer Access form. Note that the access tokens must also be pasted into the 'Repeat' fields.

  9. Fill out, at minimum, the other mandatory fields on the Customer Access form under Account Details:

Field Description
Webex App Customer Name Populated automatically, using the customer name.
Default Calling Behavior Can be applied to synced in users, if also set in Global Settings (Automatically apply default calling behavior on Webex App user data sync)
Use Organization's Domain

Can be enabled if you select option Calling in Webex Teams (Unified CM) (same as Webex App Control Hub behavior)

When selected, you may also enable Default UC Manager Profile
Email Domain for Hybrid Calling in Workspaces When hybrid calling is enabled for a workspace, a dummy subscriber email domain can be added.
Subscription ID Fill out the subscription ID (as seen on the Control Hub portal) to selectively manage multiple subscriptions in multiple sites. If required, fill out the newly managed subscription ID here.
Site URL The site URL for Webex Enterprise Edition meeting services. When syncing licenses and subscriptions, VOSS Automate only syncs in subscriptions matching the ID and services from the site.
Enterprise Content Management Enabled and Jabber Team Messaging Mode Enabled

These settings match the configuration setting on the user user feature of the Webex App Control Hub, and apply to the corresponding Default Calling Behavior selection: Calling in Webex App (Unified CM) and Cisco Jabber app.

Note that with these calling behavior options, Quick Add Group Templates for Jabber devices under the Webex App group are applied.
UC Manager Profiles Added for use when managing users.
HTTP Proxy String Required only if a proxy server is required to connect to the Webex App cloud, for example: http://[ip address]:port
HTTPS Proxy String Required only if a proxy server is required to connect to the Webex App cloud, for example: https://[ip address]:port

  1. Click Save. The Webex App Service is added.

  2. Sync the Webex App Users for the customer. To do this, click Action > Sync Webex App Users on the Customer Access form.

    Note

    Webex App Users can also be synced from Administration Tools > Data Sync, and then running the SyncSpark[Customer] data.

Related Topics

Workflow Animation

The animation demonstrates how to create a Webex App service.

This relation implements the workflows to manage Spark Customer connection parameters and enabled services.

Model Details: relation/SparkCustomer

Title Description Details
Customer Name * Name of this customer
  • Field Name: name
  • Type: String
Organization Account Number * This can be found when logging into the Webex Teams Admin portal under the My Company Info section
  • Field Name: account_number
  • Type: String
Default Calling Behaviour This is the default calling behaviour for the organization.
  • Field Name: default_calling_behaviour
  • Type: String
  • Choices: ["Calling in Webex Teams", "Calling in Webex Teams (Unified CM)", "Cisco Jabber app"]
Use Organization's Domain This is the global setting that determines whether to use the Webex Teams organization domain for Calling in Webex Teams (Unified CM).
  • Field Name: calling_behaviour_use_org_domain
  • Type: Boolean
Default UC Manager Profile This is the default UC Manager Profile for when the calling behaviour is Calling in Webex Teams (Unified CM).
  • Field Name: default_calling_behaviour_uc_manager_profile
  • Type: String
Subscription ID This is the Subscription ID to be used for license selection e.g. Sub160730. Only licenses of this Subscription ID will be synced into VOSS Automate and be assignable to users.
  • Field Name: subscription_id
  • Type: String
Site URL This is the Site URL to use for assigning 'Meeting - Webex Enterprise Edition' licenses. If this is not set, the license will not be synced into VOSS Automate and will not be assignable to users
  • Field Name: site_url
  • Type: String
Email Domain for Hybrid Calling in Workspaces This is the email domain that will be used when creating a Unified CM user associated with a Workspace in Webex Teams Control Hub for hybrid calling.
  • Field Name: email_domain
  • Type: String
Directory Synchronization Enabled This setting must be enabled if the Organization has been Directory Synchronization has been enabled on the Webex Control Hub side.
  • Field Name: dirsync_enabled
  • Type: Boolean
Enterprise Content Management Enabled This setting must be enabled if Content Management is enabled in Webex Teams Control Hub.
  • Field Name: enterprise_content_management
  • Type: Boolean
Jabber Team Messaging Mode Enabled This setting must be enabled if Jabber Team Messaging Mode is enabled in Webex Teams Control Hub.
  • Field Name: jabber_team_messaging_mode
  • Type: Boolean
UC Manager Profiles This list of UC Manager profiles must be configured to match the list of profiles in Webex Teams Control Hub.
  • Field Name: uc_manager_profiles.[n]
  • Type: Array
Admin Access Token This is the Access Token provided when logging into Webex Teams Developer portal. This token is valid for 14 days. The Refresh token can be used to generate a new Access Token.
  • Field Name: token
  • Type: String
  • Is Password: True
Refresh Token This is the Refresh Token provided when logging into Webex Teams Developer portal. This token will be used to create a new access token. The refresh token is valid for 90 dyas.
  • Field Name: refresh_token
  • Type: String
  • Is Password: True
Access Token Expires In Time when the Access Token will expire.
  • Field Name: access_token_expires
  • Type: String
Refresh Token Expires In Time when the Refresh Token will expire.
  • Field Name: refresh_token_expires
  • Type: String
HTTP Proxy String HTTP Proxy string e.g. http://10.10.10.10:8123
  • Field Name: http_proxy
  • Type: String
HTTPS Proxy String HTTPS Proxy string e.g. https://10.10.10.10:8123
  • Field Name: https_proxy
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Sync on Create Sync this organization's roles and licenses from Control Hub on creation.
  • Field Name: sync
  • Type: Boolean
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024