[Index]

Model: relation/SparkCustomer

Customer Access

Webex Teams Feature Reference

Before You Begin

For VOSS-4-UC to connect to the Webex Teams Cloud API you need:

Both are obtained from the Cisco Webex page.

Procedure

See procedure below for clarity if required:

  1. Log in as provider or reseller administrator.

  2. Make sure that the hierarchy path is set to the correct customer node.

  3. Choose Services > Webex Teams > Access Token to open the Webex Teams Account form on a separate tab, i.e it opens the following URL:

    https://us-central1-webex-teams-auth-token.cloudfunctions.net/webex_teams_oauth

  4. Click the GET TOKENS link.

  5. Enter a valid Email address in the Email address field on the Cisco Webex page and click Next. An Email address and password are only required the first time you login to the Cisco Webex site.

  6. Enter a valid password in the Password field on the Cisco Webex page, and click Sign In. The following codes/tokens are generated and displayed on the form:

    Note

    • VOSS-4-UC automatically refreshes the access tokens every 7 days. To manually refresh the access tokens, click GET TOKENS on the Webex Teams Account form or Action > Refresh Access Token on the Customer Access form.
    • The Refresh Token is valid for 90 days. The number of valid days remaining for the access token is displayed in the Refresh Token Expires in counter on the Webex Teams Access Token Management for VOSS4UC page.
    • Refer to https://developer.webex.com/docs/integrations for more details on access token management.

  7. Click on each Copy button in turn to copy the item, return to the VOSS-4-UC 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.

  8. Complete at minimum the other mandatory fields on the Customer Access form:

  9. Click Save to add the Webex Teams Service.

What to Do Next

Sync the Webex Teams Users for the customer by clicking Action > Sync Webex Teams Users on the Customer Access form.

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

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

Model Details

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
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
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024
API reference for relation/SparkCustomer