[Index]

Model: relation/SparkUser

Webex App

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

Overview

Webex App is a cloud-based business collaboration service that allows employees to message, meet, and call instantly in order to strengthen relationships and increase productivity.

Webex App combines mobile devices and other communications tools to provide instant communications and live meetings to ensure a professional and effective collaboration experience.

The table describes the main Webex App features:

Messaging Business messaging allows users to prepare, share, and repeat content, and it facilitates one-on-one or team messaging facilities in virtual rooms.
Meeting Connect teams and meet customers easily with the added benefits of messaging and content sharing before, during, and after a meeting.
Call The service enables voice and video communications via mobile, desktop, and room-based devices. Connect your existing PSTN1 services to Webex App to enjoy one-touch directory dialing and join meetings from anywhere on any device. Mobile users get features such as single number reach, single voicemail service, video services, and the ability to seamlessly move between devices during a call.

Note

Configure a specific Subscription for organizations with multiple License Subscriptions, in other words where there is a single organization with more than one entitlement for a specific license, such as "Messaging".

Webex App Workflow

To access the flowcharts, view the topic via Documentation and Resources at: https://voss.portalshape.com

Note

Only steps 1 and 2 are mandatory for Webex App to function in VOSS Automate. The other steps are dependent on your particular requirements.

The table describes the high-level Webex App workflow steps outlined in the flowchart above:

Steps Description
  1. Create Webex App service
 
  1. Enable Webex App in Entitlement

Select the Webex App checkbox (at the appropriate hierarchy level, in the entitlement catalog and entitlement profile:

  • Entitlement > Catalogs
  • Entitlement > Profiles
  1. Sync existing Webex App users for the customer

Two methods for syncs:

  • On the Customer Access page, click Action > Sync Webex App Users
  • Run a sync by executing SyncSpark[Customer] (via Administration Tools > Data Sync.
  1. Add a Webex App user in VOSS Automate

Two methods to add Webex users:

  • Via Subscriber Management > Subscribers
  • Via Subscriber Management > Quick Add Subscriber

To add a Webex App user using Quick Add Subscriber (QAS), choose the Webex Teams User Template to use for the user. This selection overrides the default user template referenced in the Quick Add Subscriber Groups* associated with the user.

If a Webex Teams User Template is not selected from the drop-down, selection falls back to the Webex Teams User Template referenced in the associated Quick Add Subscriber Groups. If you want customized values, clone the Webex Teams User Template (via Customizations > Configuration Templates), and edit as required.

  1. Provision Webex App for an existing user
 

Related Topics

Add a Webex App User

This procedure adds a new Webex App user in VOSS Automate.

  1. Log in to the Admin Portal as a Provider, Reseller, Customer, or Site administrator.

  2. Go to (default menus) Subscriber Management > Webex App > Users.

  3. View existing Webex App users (synced, or added in VOSS Automate).

  4. Click Add.

  5. Choose the hierarchy where you want to add the Webex App user.

  6. Fill out fields on the Account Details tab:

  7. On the Services tab, select relevant services:

    If the user has calling enabled, the Services tab displays Calling settings.

  8. On the Roles tab, select relevant roles:

  9. Click Save. The Webex App user is added.

Delete a Webex App User

This procedure deletes an existing Webex App user (synced, or added via VOSS Automate).

  1. Log in to the Admin Portal as a Provider, Reseller, Customer, or Site administrator.
  2. Set the hierarchy to the Customer or Site level.
  3. Go to (default menus) Subscriber Management > Webex App Users.
  4. Choose the Webex users you wish to delete (one or more).
  5. Click Delete.
  6. Click Yes to confirm.

Provisioning Subscribers with Webex App

This section describes how to provision Webex App for a subscriber, either via the Subscriber list view, or via Quick Add Subscriber (QAS).

Related Topics

Provision Webex App via Subscriber list view

This procedure provisions a subscriber with Webex App, via the Subscriber list view.

Prerequisite:

Perform these steps:

  1. In the Admin Portal, go to (default menus) Subscriber Management > Subscribers.

  2. From the Subscribers list, click on a subscriber you wish to provision with Webex App.

  3. On the subscriber configuration screen, select the Webex App tab.

  4. In the Webex App User field, click the Plus icon (+) to display the Webex App User configuration fields.

    Note

    The following checkboxes are read-only, indicating the user's status (whether their Webex account is active): Login Enabled, Invite Pending

    Options in the Services and Roles sections depend on the Webex App Server to which the Webex App Service is synced.

  5. In the Services section, select the required check boxes:

    Message Webex App Messaging. Allows a user to exchange messages and share files with another person or a group of people.
    Meeting
    • Webex App 25 Party Meetings. Allows a user to host up to 25-party meetings in Webex App cloud spaces.
    • Webex Enterprise Edition 200. Webex Enterprise Edition.
    • Webex Collaboration Meeting Rooms. Allows users to come together for one meeting experience irrespective of the devices and software they use, whether video conferencing services like Webex, or other systems, such as Polycom.
    Hybrid Calendar Services
    • Microsoft Exchange/Office 365. Enable for users who have mailboxes in on-premises Exchange or Office 365.
    • Google Calendar. Enable for users using Google Calendar.
    Hybrid Call Services
    • Aware. Makes Webex App aware of all calls across your existing UC system. Hybrid Call Services Connect depends on Hybrid Call Services Aware.
    • Connect. Deployed on top of Hybrid Call Services Aware and amongst other things, connects Webex App with VOSS Automate so that they work together. Enabled = Remote Device created. Note that with Hybrid Call Service Aware and Hybrid Call Service Connect together, users can make the same calls from either their desk phones or the Webex App app as well as hear incoming calls ring both their desk phones and the Webex App app and answer the call on either.
  6. In the Roles section, select the relevant checkboxes to configure the required roles:

    No administrator privileges .
    Full administrator privileges

    Access to all of Portal features, including:

    • Assign roles
    • Company policy and templates
    • Device management licenses and upgrades
    Read-only administrator privileges View only access to privileges available to a full administrator.
    Support Administrator Access to user information and support logs.
    User and Device Administrator .
    Device Administrator .
  7. Click OK. Webex App is provisioned for the subscriber.

    To verify that Webex App is enabled for the subscriber, ensure the Webex App column in the Subscribers list view displays the text, Enabled.

Provision Webex App via Quick Add Subscriber

This procedure enables Webex App for a subscriber via Quick Add Subscriber (QAS).

Prerequisite:

Perform these steps:

  1. Go to (default menus) Subscriber Management > Quick Add Subscriber.

  2. From the Username drop-down list, choose the name of the subscriber to be provisioned with Webex App.

  3. Select the Webex App checkbox to enable Webex App for the subscriber.

  4. From the Webex Teams User Template drop-down list, choose the template you want to assign to the user.

  5. Click Save. Webex App is provisioned for the subscriber.

    To verify that Webex App is enabled for the subscriber, ensure the Webex App column in the Subscribers list view displays the text, Enabled.

This relation implements the workflows to manage Spark Users.

Model Details: relation/SparkUser

Title Description Details
Id
  • Field Name: id
  • Type: String
First Name
  • Field Name: firstName
  • Type: String
Last Name
  • Field Name: lastName
  • Type: String
Email Address *
  • Field Name: email
  • Type: String
Phone Numbers Phone numbers for the person. Only settable for Webex Calling. Needs a Webex Calling license.
  • Field Name: phoneNumbers.[n]
  • Type: Array
Type The type of phone number.
  • Field Name: phoneNumbers.[n].type
  • Type: String
  • Choices: ["Work", "Mobile", "Fax"]
Number The phone number e.g. +1 408 526 7209
  • Field Name: phoneNumbers.[n].value
  • Type: String
Extension Webex Calling extension of the person. This is only settable for a person with a Webex Calling license.
  • Field Name: extension
  • Type: String
Line
  • Field Name: line
  • Type: String
Status
  • Field Name: status
  • Type: String
Invite Pending
  • Field Name: invitePending
  • Type: Boolean
Login Enabled
  • Field Name: loginEnabled
  • Type: Boolean
Services
  • Field Name: services
  • Type: Object
Message
  • Field Name: message
  • Type: Object
Webex App Messaging Named User License
  • Field Name: services.message.messaging
  • Type: Boolean
Meeting
  • Field Name: meeting
  • Type: Object
Webex App 25 Party Meetings Named User License. Each Named User license allows 1 user to be entitled as a meeting host. Named users can hold unlimited meetings.
  • Field Name: services.meeting.meeting
  • Type: Boolean
Webex Enterprise Edition 200 Named User License. Each Named User license allows 1 user to be entitled as a meeting host. Named users can hold unlimited meetings.
  • Field Name: services.meeting.webex_enterprise_200
  • Type: Boolean
Calling
  • Field Name: calling
  • Type: Object
Webex Calling - Basic
  • Field Name: services.calling.calling_standard_enterprise
  • Type: Boolean
Webex Calling - Standard Enterprise
  • Field Name: services.calling.calling_basic
  • Type: Boolean
Webex Calling - Common Area
  • Field Name: services.calling.calling_common_area
  • Type: Boolean
Hybrid Calendar Services Add @spark to an invitation to create a Cisco Spark room for your meeting. Add @webex to attach your WebEx Personal Room.
  • Field Name: hybrid_calendar_services
  • Type: Object
Microsoft Exchange/Office 365
  • Field Name: services.hybrid_calendar_services.microsoft_exchange
  • Type: Boolean
Google Calendar
  • Field Name: services.hybrid_calendar_services.google
  • Type: Boolean
Hybrid Call Services
  • Field Name: hybrid_call_services
  • Type: Object
Aware Users can share content from the Cisco Spark app during a call from their work phones and view their call history in the app.
  • Field Name: services.hybrid_call_services.aware
  • Type: Boolean
Connect Users' incoming calls will ring their work phones and the Cisco Spark app. Users can call their colleagues from either their phones or the app, too. Aware must be enabled before the user can be enabled for Connect.
  • Field Name: services.hybrid_call_services.connect
  • Type: Boolean
Hybrid Message Services
  • Field Name: hybrid_message_services
  • Type: Object
Hybrid Message Service Hybrid Message Services
  • Field Name: services.hybrid_message_services.message
  • Type: Boolean
Roles
  • Field Name: roles
  • Type: Object
No administrator privileges Default: true
  • Field Name: roles.none
  • Type: Boolean
  • Default: true
Full administrator privileges - User Management - Company Policy & Templates - Analytics & Reports - Support Metrics & Notifications - Licenses & Upgrades - Assign Roles
  • Field Name: roles.full
  • Type: Boolean
Read-only administrator privileges Read-only view of the portal. No changes will be accepted.
  • Field Name: roles.readonly
  • Type: Boolean
Support Administrator - Analytics & Reports - Support Metrics & Notifications
  • Field Name: roles.support
  • Type: Boolean
User and Device Administrator - User Management - Device Management - Licenses & Upgrades
  • Field Name: roles.user_device
  • Type: Boolean
Device Administrator - Device Management
  • Field Name: roles.device
  • Type: Boolean
Settings
  • Field Name: settings
  • Type: Object
Calling
  • Field Name: calling
  • Type: Object
Calling Behaviour This determines how a user makes calls in Webex App.
  • Field Name: settings.calling.calling_behaviour
  • Type: String
  • Choices: ["Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app"]
Use Organization's Domain Enabling this will use the Webex App organization domain for Calling in Webex App (Unified CM)
  • Field Name: settings.calling.use_org_domain
  • Type: Boolean
UC Manager Profile
  • Field Name: settings.calling.calling_behaviour_uc_manager_profile
  • Type: String
Create iPhone Device Default: true
  • Field Name: settings.calling.SparkiPhoneDevice
  • Type: Boolean
  • Default: true
Create Android Device Default: true
  • Field Name: settings.calling.SparkAndroidDevice
  • Type: Boolean
  • Default: true
Create Tablet Device Default: true
  • Field Name: settings.calling.SparkTabletDevice
  • Type: Boolean
  • Default: true
Create CSF Device Default: true
  • Field Name: settings.calling.SparkCSFDevice
  • Type: Boolean
  • Default: true
Message
  • Field Name: message
  • Type: Object
Third-Party Content Management Select how this user manages and shares files with content management in Cisco Webex App. Default: Third Party Off
  • Field Name: settings.message.enterprise_content_management
  • Type: String
  • Default: Third Party Off
  • Choices: ["Third Party Off", "Third Party On"]
Enable Jabber Team Messaging Mode
  • Field Name: settings.message.jabber_with_webex_teams
  • Type: Boolean
Contact Migration Required
  • Field Name: settings.message.contact_migration_required
  • Type: Boolean
Enable Jabber Calling
  • Field Name: settings.message.jabber_calling
  • Type: Boolean
UC Manager Profile
  • Field Name: settings.message.uc_manager_profile
  • Type: String
Care
  • Field Name: care
  • Type: Object
Chat and Callback All Care users require a Cisco Webex App license as a prerequisite. Additionally, they require a Cisco Webex Calling license for voice-based interactions.
  • Field Name: settings.care.care_digital_channel_service
  • Type: Boolean
Spark Services
  • Field Name: SparkServices
  • Type: Object
name
  • Field Name: SparkServices.name
  • Type: String
message_messaging
  • Field Name: SparkServices.message_messaging
  • Type: String
meeting_meeting
  • Field Name: SparkServices.meeting_meeting
  • Type: String
meeting_webex_enterprise_200
  • Field Name: SparkServices.meeting_webex_enterprise_200
  • Type: String
calling_basic
  • Field Name: SparkServices.calling_basic
  • Type: String
calling_standard_enterprise
  • Field Name: SparkServices.calling_standard_enterprise
  • Type: String
calling_common_area
  • Field Name: SparkServices.calling_common_area
  • Type: String
hybrid_calendar_services_microsoft_exchange
  • Field Name: SparkServices.hybrid_calendar_services_microsoft_exchange
  • Type: String
hybrid_calendar_services_google
  • Field Name: SparkServices.hybrid_calendar_services_google
  • Type: String
hybrid_call_services_aware
  • Field Name: SparkServices.hybrid_call_services_aware
  • Type: String
hybrid_call_services_connect
  • Field Name: SparkServices.hybrid_call_services_connect
  • Type: String
hybrid_message_services_message
  • Field Name: SparkServices.hybrid_message_services_message
  • Type: String
jabber_team_messaging_mode
  • Field Name: SparkServices.jabber_team_messaging_mode
  • Type: String
enterprise_content_management
  • Field Name: SparkServices.enterprise_content_management
  • Type: String
provision_iphone
  • Field Name: SparkServices.provision_iphone
  • Type: Boolean
configuredCallingBehaviour
  • Field Name: SparkServices.configuredCallingBehaviour
  • Type: String