[Index]

Model: relation/SparkCustomer

Webex Application Access (Webex Organization)

Full HTML Help

Tip

Use the Action search to navigate Automate

This procedure adds the Cisco Webex service (Webex Control Hub instance).

Prerequisites:

Note

You won't need to create Network Device Lists (NDL). When importing from Webex Control Hub the first time, the VOSS workflow creates a blank NDL at the customer if no other NDL exists. When the sites are auto created based on the imported Webex Locations, the sites will use this new blank NDL.

Create the Cisco Webex service:

  1. Log in to the VOSS UI as a provider or reseller administrator.

  2. Select the relevant customer hierarchy.

  3. Go to Webex Application Access or Webex Organization to open the list view of all configured Webex organizations.

    Note

    Existing accounts added before Automate 21.4-PB3 will show the internal account ID as the Organization Account Number, while accounts added from Automate 21.4-PB3 onwards, show the external account ID.

  4. Click the Plus icon (+), then, on the new record page:

    Note

    You'll need to add the Webex organization account details to VOSS before access tokens can be obtained.

  5. Click Save.

    Note

    When adding a new Webex Control Hub Access entry for a customer, data syncs and schedules are automatically created. Deleting a customer's Webex Control Hub Access automatically deletes these data syncs and schedules.

  6. Once the new Webex organization is saved, return to the created account to view (in the Access Tokens section), the Connect to Webex Control Hub link that is used to request the tokens.

  7. Click the Connect to Webex Control Hub link to obtain the access tokens (Webex Wholesale tokens for Customers and Users if Wholesale Customer is enabled) for the Webex Control Hub account, and to be redirected to the VOSS Transactions page.

    Note

    When first using this link, a Webex admin user (with sufficient privileges) must log in and accept the API authorization scope that VOSS requires for integration.

  8. On the Transactions page, monitor progress for retrieving the access tokens.

    Note

    • Roles and licenses are synced in to VOSS.

    • When the transaction completes, view expiry times for the access token and refresh token.

      • VOSS automatically refreshes the access tokens every 7 days for 90 days, that is, until the expiry of the Refresh Token.

      • The Refresh Token is valid for 90 days. Use the Connect to Webex Control Hub link to refresh it. VOSS General Settings provide options for Webex App Tab to send impending expiry notifications and messages. See: Global Settings.

        For more information around access token management, see https://developer.webex.com/docs/integrations

  9. If Wholesale Customer was enabled, the Wholesale Customer section of the Webex Control Hub Access form shows Wholesalecustomer instance(s) associated with the Webex organization account.

    Customer details and associated calling and collaboration packages can then be managed if needed:

    The list view item for the Webex for Wholesale control hub will show Wholesale Status as true.

Related topics

Introduction to Cisco Webex App in the Core Feature Guide

Webex App licenses in the Core Feature Guide

"Webex onboarding best practices" chapter of the Best Practices Guide.

Network Device Lists (NDLs) topic in the Core Feature Guide.

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
  • MaxLength: 1024
Wholesale Customer Select this option if the customer is a wholesale customer.
  • Field Name: wholesale_status
  • Type: Boolean
Contact Center Customer Select this option if the customer is a Webex Contact Center customer.
  • Field Name: webex_contact_center
  • Type: Boolean
Contact Center Region Select an option in the following list to map the API endpoints for your region.
  • Field Name: base_url_setting
  • Type: String
  • MaxLength: 1024
Organization Account Number This can be found when logging into the Webex Control Hub portal under the Account menu. E.g. 000fd0e4-83ef-d398-be23-d06998580fed
  • Field Name: account_number_external
  • Type: String
  • MaxLength: 1024
Admin Account Email This is the email address of the account used to generate the access token.
  • Field Name: account_email
  • Type: String
  • MaxLength: 1024
Organization Account Number (Internal) This is the internal API id for the organization. This is automatically resolved from the external account number.
  • Field Name: account_number
  • Type: String
  • MaxLength: 1024
Default Calling Behaviour This is the default calling behaviour for the organization.
  • Field Name: default_calling_behaviour
  • Type: String
  • MaxLength: 1024
  • Choices: ["Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app", "Third-Party app"]
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 App Control Hub for hybrid calling.
  • Field Name: email_domain
  • Type: String
  • MaxLength: 1024
Directory Synchronization Enabled This setting must be enabled if the Organization has been enabled for Directory Synchronization on the Webex Control Hub side.
  • Field Name: dirsync_enabled
  • Type: Boolean
Please Note Field to display notes to the user.
  • Field Name: notes
  • Type: String
  • MaxLength: 1024
Authorize Webex This is the link to initiate the Webex OAuth flow to obtain tokens.
  • Field Name: token_link
  • Type: String
  • MaxLength: 32768
  • Format: link
Admin Access Token This is the Access Token provided when logging into Webex App 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
  • MaxLength: 1024
Refresh Token This is the Refresh Token provided when logging into Webex App 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
  • MaxLength: 1024
Access Token Expires At Time when the Access Token will expire.
  • Field Name: access_token_expires
  • Type: String
  • MaxLength: 1024
Refresh Token Expires At Time when the Refresh Token will expire.
  • Field Name: refresh_token_expires
  • Type: String
  • MaxLength: 1024
HTTP Proxy Specifies an outbound internet proxy server for HTTP traffic to the public Internet. The format should be (http(s)://[user:password]@host:port). Note that this is the location of the proxy and the URL scheme is not necessarily "http" just because the traffic being forwarded to it is HTTP traffic. Please consult the administrator of the proxy server for the correct URL. Special characters in either the user or password must be URL encoded.
  • Field Name: http_proxy
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 1024
HTTPS Proxy Specifies an outbound internet proxy server for HTTPS traffic to the public Internet. The format should be (http(s)://[user:password]@host:port). Note that this is the location of the proxy and the URL scheme is not necessarily "https" just because the traffic being forwarded to it is HTTPS traffic. Please consult the administrator of the proxy server for the correct URL. Special characters in either the user or password must be URL encoded.
  • Field Name: https_proxy
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 1024
Sync on Create Sync this organization's roles and licenses from Control Hub on creation.
  • Field Name: sync
  • Type: Boolean
Wholesalecustomer
  • Field Name: wholesalecustomer.[n]
  • Type: Array
  • Cardinality: [0..1]
Id
  • Field Name: wholesalecustomer.[n].id
  • Type: String
  • MaxLength: 1024
Org ID
  • Field Name: wholesalecustomer.[n].orgId
  • Type: String
  • MaxLength: 1024
Org Name
  • Field Name: wholesalecustomer.[n].orgName
  • Type: String
  • MaxLength: 1024
External Id
  • Field Name: wholesalecustomer.[n].externalId
  • Type: String
  • MaxLength: 1024
Address
  • Field Name: address
  • Type: Object
Address Line 1
  • Field Name: wholesalecustomer.[n].address.addressLine1
  • Type: String
  • MaxLength: 1024
Address Line 2
  • Field Name: wholesalecustomer.[n].address.addressLine2
  • Type: String
  • MaxLength: 1024
City
  • Field Name: wholesalecustomer.[n].address.city
  • Type: String
  • MaxLength: 1024
State or Province
  • Field Name: wholesalecustomer.[n].address.stateOrProvince
  • Type: String
  • MaxLength: 1024
ZIP or Postal Code
  • Field Name: wholesalecustomer.[n].address.zipOrPostalCode
  • Type: String
  • MaxLength: 1024
Country
  • Field Name: wholesalecustomer.[n].address.country
  • Type: String
  • MaxLength: 1024
Status
  • Field Name: wholesalecustomer.[n].status
  • Type: String
  • MaxLength: 1024
Packages
  • Field Name: packages.[n]
  • Type: Array
Resource Details
  • Field Name: resourceDetails
  • Type: Object
Packages
  • Field Name: packages.[n]
  • Type: Array
Name
  • Field Name: wholesalecustomer.[n].resourceDetails.packages.[n].name
  • Type: String
  • MaxLength: 1024
Status
  • Field Name: wholesalecustomer.[n].resourceDetails.packages.[n].status
  • Type: String
  • MaxLength: 1024
Warnings
  • Field Name: warnings.[n]
  • Type: Array
errorCode
  • Field Name: wholesalecustomer.[n].resourceDetails.packages.[n].warnings.[n].errorCode
  • Type: Integer
description
  • Field Name: wholesalecustomer.[n].resourceDetails.packages.[n].warnings.[n].description
  • Type: String
  • MaxLength: 1024
Errors
  • Field Name: errors.[n]
  • Type: Array
errorCode
  • Field Name: wholesalecustomer.[n].resourceDetails.packages.[n].errors.[n].errorCode
  • Type: Integer
description
  • Field Name: wholesalecustomer.[n].resourceDetails.packages.[n].errors.[n].description
  • Type: String
  • MaxLength: 1024