[Index]

Model: relation/WebexTeamsPlace

Webex Teams Workspaces

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

Workspaces of various types - such as Meeting rooms or open spaces can be defined in VOSS Automate.

The data entered on this input form is formatted as a sequence of steps in an email message to be carried out on the Webex Teams Control Hub. See: Global Settings for an email message example.

  1. Provide a workspace Name, Capacity and select a workspace Type.

  2. Use the Send Device Activation Code To field for the email address(es) where the device type code is sent. This code is unique to this created workspace and is entered into the device itself.

    Once the code is created, the Device Activation Code (read only) value is returned and shown, as well as its Device Activation Code Expiration Date. A VOSS Automate schedule checks the expiration date and generates a new code. The SIP Address of the workspace is also shown.

    The Calling group has options for the Calling Behavior (free or hybrid) The hybrid calling option allows for a Site to be selected, as well as a Directory Number that is available.

    The Mail ID input is then generated, using:

    wt_ + <random-number> + the email hostname set up for the Webex Teams service, for example wt_886821663180@myhost.com.

    A subscriber user for the device is then added at the selected site (Site), with:

Once the device code is entered, the VOSS Automate form also shows the details of the device associated with the workspace in the Devices group, for example: Product, Connection Status and IP Address. A link to the device is then also available, to show details (read only) as listed under the Devices menu for Webex Teams.

The added workspace is listed on the Workspaces menu.

This implements the relationship between a Webex Teams place and associated devices.

Model Details: relation/WebexTeamsPlace

Title Description Details
Place Settings Group Assigned by FDP
  • Field Name: Place Settings
  • Type: Object
Name * Unique name for this place.
  • Field Name: Place Settings.name
  • Type: String
Capacity How many people is the Workspace suitable for?
  • Field Name: Place Settings.capacity
  • Type: Integer
Type What type best describes the Workspace?
  • Field Name: Place Settings.type
  • Type: String
  • Choices: ["No workspace type set", "Desk - individual", "Focus - high concentration", "Huddle - brainstorm/collaboration", "Meeting Room - dedicated meeting space", "Open Space", "Other"]
SIP Address The unique SIP address this place.
  • Field Name: Place Settings.sip_address
  • Type: String
Contains The product type of the devices associated with this place.
  • Field Name: Place Settings.wt_device_product
  • Type: String
Device Activation Code The activation code for registering and associating a device with this place.
  • Field Name: Place Settings.wt_device_code
  • Type: String
Device Activation Code Expiration Date The expiration date for the activation code.
  • Field Name: Place Settings.wt_device_code_expiry_date
  • Type: String
Send Device Activation Code To A comma separated list of email addresses the activation code will be sent to via a Webex Teams message.
  • Field Name: Place Settings.wt_device_code_email
  • Type: String
  • Pattern: ^(\s?[^\s,]+@[^\s,]+\.[^\s,]+\s?,)*(\s?[^\s,]+@[^\s,]+\.[^\s,]+)$
Calling
  • Field Name: calling
  • Type: Object
Calling Behaviour This determines how calls are made from this place. Default: Free Calling (default)
  • Field Name: Place Settings.calling.calling_behaviour
  • Type: String
  • Default: Free Calling (default)
  • Choices: ["Free Calling (default)", "Hybrid Calling"]
Site Select the Site where the associated Unifed CM user will be created. The Webex Teams places and devices will automatically be moved to this site.
  • Field Name: Place Settings.calling.site
  • Type: String
Site Pkid
  • Field Name: Place Settings.calling.site_pkid
  • Type: String
Directory Number Enter the DN to be used with the Unified CM account. This DN is used for hybrid calling.
  • Field Name: Place Settings.calling.directory_number
  • Type: String
Mail ID from Unified CM Enter the Mail ID below to connect this place to the existing Unified CM account. This Mail ID ensures that the correct user account is connected with this place for hybrid calling. A default domain must be configured on the Webex Teams account to dervice this email address.
  • Field Name: Place Settings.calling.mailid
  • Type: String
  • Pattern: (^$|^([^.@]+)(\.[^.@]+)*@([^.@]+\.)+([^.@]+)$)
Subscriber PKID Internal field for the subscriber ID.
  • Field Name: Place Settings.calling.subscriber_pkid
  • Type: String
Link to Subscriber Jump to the associated subscriber page.
  • Field Name: Place Settings.calling.subscriber_link
  • Type: String
  • Format: link
Calendar
  • Field Name: calendar
  • Type: Object
Calendar Calendar service enables One Button To Push for this place.
  • Field Name: Place Settings.calendar.calendar
  • Type: Boolean
Hybrid Calendar Service Which calendar provider do you want to use?.
  • Field Name: Place Settings.calendar.hybrid_calendar_service
  • Type: String
  • Choices: ["Microsoft Exchange / Office 365", "Google Calendar"]
Email address of the calendar mailbox This is the email address that will be used to connect to the hybrid calendar service.
  • Field Name: Place Settings.calendar.email
  • Type: String
Devices
  • Field Name: devices.[n]
  • Type: Array
Link Link to jump to the device details.
  • Field Name: Place Settings.devices.[n].link
  • Type: String
  • Format: link
Product The product name.
  • Field Name: Place Settings.devices.[n].product
  • Type: String
Connection Status The connection status of the device.
  • Field Name: Place Settings.devices.[n].connectionStatus
  • Type: String
IP Address The current IP address of the device.
  • Field Name: Place Settings.devices.[n].ip
  • Type: String
Primary SIP URL The primary SIP address to dial this device.
  • Field Name: Place Settings.devices.[n].primarySipUrl
  • Type: String