- Domov
- /
- Článok
Wholesale Route-to-Market Solution Guide
This document contains an overview of the Webex offer for the Wholesale Route to Market (RTM) solution.The document is aimed at partner administrators within Service Providers that sell Webex services.
Introduction
About this Guide
The Wholesale Route-to-Market (RTM) strategically brings Webex to SMBs through global Service Providers. Supported by Cisco's tech and collaboration expertise, it features a new operations model, commercials, and partner programs.
Wholesale offers operations APIs and Partner Portal innovations for efficient high-volume transactions. The commercial strategy enables BroadWorks users to transition to Webex with fixed, per-user monthly packaging and simplified billing.
Wholesale partner programs cater to Service Providers' technical and business goals with Cisco's Managed Onboarding Program, focusing on Technical Onboarding and Go-to-Market. The offer includes five Webex packages: Common Area Calling, Webex Voice Package, Webex Calling, Webex Suite, and Webex Meetings.
Overview of Wholesale Route to Market
Overview of Wholesale Route to Market
The Wholesale Route-to-Market (RTM) is a strategic channel solution designed to bring Webex to the SMB segment by leveraging the market power of Service Providers around the world. It is backed by Cisco's innovative technology and deep collaboration expertise. It is comprised of a new operations model, new commercials and new partner programs.
The Wholesale platform delivers operations APIs and Partner Portal innovations that make high-volume, high-velocity transactions possible, while making it easy for partners to create differentiated, cobranded offers in market with their own products.
The new Wholesale commercial strategy facilitates the 35M BroadWorks users to move to the Webex cloud with predictable, fixed, per-user per-month packaging and monthly billing in arrears. A single commercial relationship with each Service Provider is the anchor for all of their end customers, greatly simplifying workflows.
The Wholesale partner programs address both the Service Provder technical and business goals. Cisco's Managed Onboarding Program is designed with two parallel work-streams: Technical Onboarding and Go-to-Market. Dedicated Cisco experts, paired with comprehensive online partner trainings and a robust set of migration and marketing toolkits assure the onboarding experience exceeds expectations.
The Wholesale offer is Webex and comes in 4 packages: Common Area Calling, Webex Calling, Webex Suite and Webex Meetings.
Wholesale Route To Market Benefits
The Wholesale Route to Market (RTM) solution is optimized to provide managed service providers with a high-velocity, transactional sales motion. It provides:
-
Fixed, predictable transfer price
-
Simplified packaging
-
High-velocity provisioning UX and APIs
-
Monthly invoicing based on net active users
-
Simplified self-administration interface
The Wholesale RTM offer integrates seamlessly into your existing workflows. This allows you to manage the sales cycle end-to-end without having to register every customer with the Cisco Commerce Workplace (CCW).
Wholesale RTM provides the following enhancements over Webex Calling to better integrate with your SMB sales motion:
-
With Wholesale RTM, there's a fixed transfer price with Cisco for each package. These transfer prices are captured in a PO that gets submitted once into CCW. After that partners no longer need to use CCW for any sales transaction.
-
All Wholesale RTM sales will be based on the same fixed, predictable transfer price. This greatly simplifies and accelerates the sales process.
-
Wholesale RTM provides you with two simple interfaces to provision and manage customers:
-
Partner Hub provides a simple UX for you to provision, manage, and remove customers and users.
-
Control Hub is Cisco’s web-based enterprise management portal, offering a holistic view of an enterprise’s Webex services.
-
-
Wholesale RTM APIs provide a simple, machine to machine interface that integrates into the service provider back-office systems. This allows you to provision, manage, and remove customers and users.
-
Wholesale RTM bills you monthly for the net number of active licenses, in arrears, and pro-rated on the activation dates of each customer. This allows Service Provider partners to flex up and down and only get charged for licenses that are actively provisioned on the system.
-
Wholesale RTM uses a simple packaging that is well-suited for the small and medium business segment.
Package Offers
The Wholesale RTM solution offers four calling and collaboration packages for your end users.
-
Common Area—The Common Area package supports basic calling features. It is intended for simple endpoints like hallway phones, door phones, and simple retail stations. The Common Area package includes features like Call Forward, BLF, Transfer, Call Waiting, and T.38 Fax. More advanced calling features, as well as Webex Clients, Messaging, and Meetings are part of higher value packages.
-
Enhanced Calling—This calling-only package includes a subset of the calling features that are associated with Webex Calling with the option of the Webex App softphone or a choice of devices. It does not include the Meetings and Messaging functionality and offers a calling focused package for customers looking for a simple voice solution.
-
Webex Calling—The Webex Calling package includes advanced calling features, as well as the Webex Client, Webex Messaging, and a "basic" meetings capability. This package is intended for all professional users of the platform. In addition to the features in Common Area, calling features include, but are not limited to, Hunting, Voicemail, Visual Voicemail, Shared Call Appearance, Privacy, N-way Calling, Executive/executive assistant, and many more. Webex Calling also includes use of all the Webex Clients for Desktop and Mobile OSes, Webex Messaging functions including Spaces and File Sharing.
-
Webex Suite—Webex Suite is the most feature rich package that includes all capabilities of the Webex Calling package, all user and groups services, Webex messaging, and the full Webex Meetings product for up to 1000 participants. This package will appeal to the senior/professional level within the company with heavy calling and large meeting requirements.
-
Customer Experience Essentials—Wholesale Customer Experience Essentials provides the fundamental capabilities of the Webex Contact Center solution. It includes all the Webex Calling professional capabilities, Customer Experience Basic features, and some additional key features accessible through the Webex App for both agents and supervisors. The features like screen pop, supervisor experience in Webex App, and real-time and historical agent and queue view make the Customer Experience Essentials distinct from the Customer Experience Basic.
For more information, see: Webex Customer Experience Essentials
-
Webex Meetings—The Webex Meetings package is a standalone meetings package that includes Webex Messaging, and Webex Meetings for up to 1000 participants. This package does not include a calling seat. It is intended for those users who only want a meetings and messaging capability that is not associated with their calling behavior.
Unlike the Webex Calling Flex offer, with the Wholesale RTM solution, Cisco does not impose any specific pricing and terms on the end-customers, these are up to each service provider to implement as they see fit based on their own business model.
Webex Calling Features
Webex Calling has the enterprise business calling features that Service Providers need – all included in the single user license charge.
Alternate numbers w/ distinctive ring |
Anonymous call rejection |
Barge-in exempt |
business continuity (CFNR) |
Busy lamp monitoring |
Call forwarding: always/busy/no answer/selective |
Call history |
Call hold & resume |
Call logs w/ click to dial |
Call notify |
Call queue agent |
Call recording |
Call redial |
Call return |
Call transfer (attended & blind) |
Call waiting (up to 4 calls) |
Call waiting ID |
Connected line ID restriction |
Directed call pickup |
Directed call pickup with barge in |
Do not disturb |
Enterprise phone directory |
Executive / Executive assistant |
Extension dialing, variable length |
Feature access codes |
Hoteling: host & guest |
Inbound caller ID (name & number) |
Inbound fax to email |
Mobility |
Multiple line appearance |
N-way calling (6) |
Office anywhere |
Outbound caller ID blocking |
Personal phone directory |
Priority alert |
Privacy |
Push-to-talk |
Remote office |
Selective call acceptance |
Selective call rejection |
Sequential ring |
Shared call appearance |
Simultaneous ring |
Speed dial 100 |
T.38 fax support |
Three-way calling |
Unified messaging |
User intercept |
User web portal |
Video (point to point) |
Visual voicemail |
Voicemail |
Auto attendant |
Call park authentication |
Call park group |
Call pick up |
Call queue |
External calling line ID delivery |
Group paging |
Hunt group |
Intercept group |
Intercept user |
Internal calling line ID delivery |
Music on hold |
Receptionist client |
Microsoft Teams integration |
Voice portal |
Webex Calling with the Webex App
The Webex App is our single end user experience that delivers calling, meetings, and messaging to the end user. With Webex Calling and the Webex App together you can:
-
Make, receive, or decline calls on your desk phone or with the Webex App on your smartphone, PC, laptop, or tablet.
-
Pair with Webex devices using Cisco Intelligent Proximity and/or desk phone control to access common contacts and call history on the app while using those devices for your audio and video.
-
Elevate any call into a full-featured meeting to take advantage of screen sharing, whiteboarding, AI transcriptions, real-time transcriptions, notes and action items, recordings, and more
The Webex App provides team collaboration features that meet the day-to-day enterprise meeting and collaboration needs including:
-
1:1 and group messaging—Chat individually or in groups with messages, gifs, emojis, and animated reactions. Easily delete or edit messages, start a conversation thread, add people to conversations, see read receipts, and more.
-
File and content sharing—Share even the largest of files in a secure space that’s neatly organized, searchable, and saved right alongside your chats so it is easy to find what you need.
-
Two-way whiteboarding—Whiteboard or draw with your team and share the interactive drawing in a chat. Keep iterating whether or not you’re in a live meeting.
-
Make calls directly to other Webex users—Make or receive video calls to other Webex App users through the app, for free.
-
Work with the tools you love—Forget app-switching and interrupted workflows. Integrate Webex with the tools you use every day for your most productive work. You can incorporate key and deep integration with the likes of Microsoft, Google, ServiceNow, and more.
-
Personalize your spaces—Change your color theme, add a cover photo, set a custom status, and personalize the experience to you.
-
Read about more features in the Webex App solutions overview.
Webex Meetings
Better together experiences and pricing are available with the Webex Suite when buying Webex with Calling, Meetings, Messaging, Polling, and Events in a single offer. Webex Meetings is optimized for larger scale meetings that demand various access methods and features for both participants and presenters. Webex Meetings is the world’s most popular video conferencing service for the enterprise, offering highly secure integrated audio, video, and content sharing from the Webex cloud.
The Webex Meetings suite is a feature-rich solution that includes modules for collaborative meetings, training, large events, and remote support. Webex Meetings supports multiple mobile devices, including iPhone, iPad, Apple Watch, and Android and Android wearables. You can meet with anyone on all common OS platforms, including Windows, Mac, and Linux. Webex Meetings supports Internet Explorer (IE), Safari, Firefox, Chrome, and Edge browsers.
-
Webex Meetings supports HD (720p) video and is interoperable with Cisco Webex Rooms and third-party standards-based video systems. You can invite others to join meetings from mobile devices or their own video systems, such as desk and room devices. This video capability combines video bridging and web conferencing into one always-on meeting. Schedule ahead or meet instantly—everyone is welcome.
-
Customers can gain a strong competitive advantage using Webex Meetings, which offers:
-
Robust video—Multi-stream HD video that is customizable to how you want to work and who you want to see in the meeting, even on mobile devices. Add Cisco award-winning video room and desk devices to your Webex meeting for life-like experiences.
-
Powerful mobile experience—Optimized just for mobile users with customizable 720p video views, native screen sharing, hands-free joining, simple meeting scheduling, and it adapts to noisy environments.
-
Join from your device of choice from the pocket to the boardroom—Phone, browser, mobile, room device, third-party standards-based room devices, and even Skype for Business. And you’ll have a consistent meeting experience no matter how you join.
-
Integrated into how you work and learn—Schedule, join and start meetings with the third-party tools you may already use, including Microsoft Teams, Slack, Workplace by Facebook, Microsoft Office 365, Google Calendar, and Skype for Business. Webex Meetings is also tightly integrated with popular Learning Management Systems (LMS), so remote learning can be as effective as it is in class.
-
One meeting experience—Whether participants are together or apart, internal or external to the organization, they will have one meeting experience across mobile or video devices.
-
Professional and effective meetings—Keep internal and external participants engaged with integrated audio, video, and content sharing capabilities, made possible by global online conferencing with Webex Meetings applications. You can also share other applications, desktops, and even video files for more productive and impactful collaborative meetings, training, and events.
-
Virtual meetings as if you were face to face—Start or join a meeting using a web browser, mobile phone, desktop, or in-room video device. Make online meetings even more engaging just like you were together in person with video that automatically switches to display the person who is speaking, creating an intuitive meeting experience. Bring everyone together in a personalized, always-available meeting room anytime. You can use your own standards-based video device, which can scale your meeting from a few to hundreds, as desired.
-
Enhanced security and compliance—Take the worry out of your meeting with multi-layer security built with Cisco expertise that does not compromise user experience.
-
Global meeting architecture—Cisco Webex® has a global architecture and network, purpose built for meetings, to ensure speed and performance. With data centers located throughout the world, people join using the Webex data center closest to them. The benefit? High-quality video meetings without delays—no matter where participants are located. This is made possible by an enterprise structure that securely and reliably delivers SaaS functionality.
-
Improved administration—To better manage the collaboration portfolio, the Cisco Webex Control Hub allows administrative users to access Webex Meetings settings and reports in a single pane of glass.
-
Improved speed of deployment—Experience rapid time to value with low total cost of ownership by being able to quickly deploy the solution over the secure Webex platform. You can deploy Webex Meetings quickly instead of over months, taking full advantage of innovative video and web collaboration best practices along with Cisco technology and expertise.
-
Webex Meetings helps you forget about the technology, so you can focus on having a well-planned event and productive meeting. Joining Webex Meetings is a breeze for everyone, no matter whether they connect from an app on their computer, smartphone, or tablet or join with a group of colleagues using a Webex Room Series device.
Wholesale Webex Assistant
Webex Assistant for Meetings is an intelligent, interactive virtual meeting assistant that makes meetings searchable, actionable, and more productive. You can ask Webex Assistant to follow up on action items, take note of important decisions, and highlight key moments during a meeting or event.
Webex Assistant for Meetings is available for free for Webex Meetings, Webex Suite package meeting sites and Personal Meeting Rooms. Support includes both new and existing sites.
Enable Webex Assistant Meetings for Webex Meetings and Webex Suite Packages
Webex Assistant is by default enabled for Webex Meetings and Webex Suite package Wholesale customers. Partner Administrators and Customer Organization Administrators can disable the feature for Customer Organizations through Control Hub.
Limitations
The following limitations exist for Webex for Cisco Wholesale:
-
Support is limited to Webex Meetings and Webex Suite package meeting sites and Personal Meeting Rooms only.
-
Closed captioning transcriptions are supported in English, Spanish, French and German only.
-
Content sharing via email can be accessed only by users within your organization.
-
Meeting content is not accessible to users outside your organization. Meeting content is also not accessible when shared between users of different packages from within the same organization.
-
With the Webex Meetings and Webex Suite package, meeting recording transcriptions are available whether Webex Assistant is enabled or disabled. However, if local recording is selected, post-meeting transcripts or highlights are not captured.
Additional Information About Webex Assistant For user information on how to use the feature, see Use Webex Assistant in Webex Meetings and Webex Webinars.
Wholesale Customer Experience Essentials Configuration
Explore the features and limitations of Wholesale Customer Experience Essentials, excluding the configuration of call queue creation and the upgrade from Customer Experience Essentials.
Call Queue Creation:
The key distinction from the creation of the Customer Experience Call Queue mentioned in Webex Customer Experience Essentials is that, for Wholesale organizations, On the Select Agents page, a user can be selected as an agent only if they have the CX Essentials package assigned. Show Customer Experience Users Only toggle won't be available.
Call Queue Upgrade:
If the organization has purchased Customer Experience Essentials and wants to move the existing basic call queue to Customer Experience Essentials queue, you can do it effortlessly from the Control Hub. Upgrading the queue maintains the assigned agents and supervisors, and the existing settings of the queue.
Limitations/Warning:
- Once a call queue is upgraded, you can’t downgrade it.
- Virtual line and workspace in the Customer Experience Basic call queue aren’t supported to upgrade to Customer Experience Essentials queues.
To upgrade a call queue:
- Sign in to Control Hub, and go to Services > Calling > Features > Call Queue.
- Click the ellipsis ... icon of the call queue that you want to upgrade and click Upgrade queue.
- Review the queue information and click Next.
The weighted routing pattern from Customer Experience Basic isn’t supported in Customer Experience Essentials and defaults to Top Down. You can change to other routing types after the upgrade.
- In Review Package Assignment screen, we can do either two actions mentioned below:
- Remove agents who do not have the Customer Experience package by clicking 'Continue the upgrade without the listed agents'. This action will remove those agents from the call queue.
- Change the package assigned to the relevant users by navigating to the 'Assigned User Package' page as shown below. This will take you to the users screen where you can assign the customer experience essentials package as needed. Thereafter, you can re-attempt the Call Queue Upgrade.
Simplified and Centralized Administration
The Wholesale RTM solution provides you with two simple interfaces to provision and manage customers:
-
Partner Hub
-
Control Hub
Partner Hub: Managing the Offer
Partner Hub is Cisco's web-based portal for management of the Wholesale RTM solution. Partner Hub is the administrative interface that you use to configure offer attributes that span enterprises. Partner Hub provides:
-
Offer Management—Establish default settings, templates, and policies that apply to all enterprises managed under the offer.
-
Cobranding—Set client brand colors, logos, and other client attributes for a cobranded end-user experience that reenforces the values of both the Service Provider and Cisco.
-
Enterprise Onboarding—Add new businesses to your offer, assign enterprise-level features, and security compliance. Set meeting site attributes including dial-in and callback services.
-
Enterprise Management and Reporting—Assign roles and responsibilities to admins within the enterprises that you manage. See analytics across all enterprises to monitor adoption, usage, and quality metrics.
Partner Hub has multiple levels of role-based access control letting Service Providers assign access levels, while maintaining security best practices.
The Partner Hub Overview screen displays a Start Trial button. However, the trial option is not available to Wholesale RTM partners. Partners should not attempt to use this option as you cannot convert these trials to Wholesale customers.
Control Hub: Managing on Behalf of the Enterprise
Webex Control Hub is Cisco’s web-based enterprise management portal. It offers a holistic view of an enterprise’s Webex services. It helps you manage all enterprises, users, devices, and security settings in one place. In the context of the Wholesale RTM solution, the primary user of Control Hub is the service provider administrator who updates settings on behalf of the end enterprise. It is also possible for the enterprise administrator to perform these functions. This provides the ability for Service Providers to allow your enterprises to self-manage, if desired. There are multiple roles that Service Providers can assign to their customer to allow them to have different levels of access to Control Hub. This increases offer flexibility and customization.
Control Hub provides one central cloud app for all your administrative functions with detailed analytics and reporting. Also, the administrator can configure security and compliance policies to help keep data safe and meet regulatory needs.
Control Hub provides:
-
User creation and service assignment—Manage all moves, adds, changes, and deletes (MACDs) for users in an enterprise. Control Hub allows you to set specific package types per user such entitling them to a Common Area or Suite package.
-
Actionable insights—See adoption in action across all enterprises, and within enterprises. Understand how users are calling, messaging, joining meetings, how long meetings last, and who is using video. This helps you to measure the adoption and use the services for the entire offer.
-
Drill down on the root cause of user experience issues—At the enterprise level, identify issues such as voice quality and page-load performance so you can troubleshoot them before they have an impact.
-
Flexible policy definition—Easily configure service settings for administrators and users with role templates and granular policy controls.
-
User and device management—Activate devices quickly, manage users, and enable synchronization with Microsoft Active Directory and integrated single sign-on for all, or a subset of the enterprises you manage.
See Control Hub Management and Analytics Data Sheet for more about Control Hub management and analytics.
API Management for Service Provider Scale
The Wholesale RTM solution is built for service provider scale. To achieve this, all functions for partner level and enterprise (Control Hub) level management are enabled via APIs.
The Wholesale RTM solution includes specifically built APIs for service providers that help onboarding customers and users at scale. In an ideal state, an API call for creating a customer entity in Webex and an API call for creating and configuring services for users are all you need. Cisco has invested in asynchronous APIs that do away with ordering APIs and any other manual operations. These APIs extend those available on developer.webex.com and allow service providers to span integration from service provider to customer to user easily. The design guidelines for these APIs are that they are simple to use, allow service providers to operate at scale, and offer flexibility via onboarding templates to target offers to the end customers.
Webex for Broadworks customers will be rejected by these APIs.
Architecture Overview
The diagram below illustrates the overall Architecture for the Wholesale Route to Market solution. There are two areas highlighted:
-
Customer Provisioning/Management
-
Service Provider Billing
These areas are discussed in more detail in subsequent topics.
Customer Provisioning
As already mentioned, Wholesale Route to Market removes the need to place per-customer Purchase Orders into CCW. Instead, the Service Provider can onboard customers directly against Webex using Public APIs or Partner Hub (Future). The diagram above illustrates the high level interactions:
-
The Service Provider owns the customer relationship. When selling services to the customer, the Service Provider will manage that relationship (including quoting, ordering, billing, payments) on their own systems. So step one in any customer management is to provision the customer on their own system.
-
The Service Provider can integrate Public APIs into their customer provisioning workflows to allow them to automatically onboard the customer and users onto Webex and assign services. In the future, the solution will also support onboarding capabilities via Partner Hub.
-
Once the Customer is onboarded, the Service Provider may use Partner Hub, Control Hub and Public APIs to further administer the solution for their customers.
Administrators should be provisioned with the same level of package as the customer organization was created with. No downgrade of the package is supported for the customer administrator (full administrator).
Packages/AddOns
The basic units of service assignment for Wholesale Route to Market are Packages and AddOns.
-
Packages are the base service assignments. All users are assigned one (and only one) package, which entitles them to a set of Webex Messaging, Meeting and Calling services. For the list of packages, see Package Offers.
-
AddOns are additional billable features that are not included by default in the base packages. The initial release of Wholesale RTM does not include any AddOns, but there are a list of potential AddOns in the pipeline.
Restricted and Denied Persons Checks
For compliance reasons, Wholesale RTM provisioning checks automatically whether the customer appears on a Restricted or Denied Persons List. If the customer appears is on either list, provisioning is placed in a pending state during which the API completes periodic status checks to see if the issue is cleared. If the customer remains in a pending state after 72 hours, onboarding ceases and the Cisco Ops team takes over the compliance check to determine whether the customer can be provisioned.
For information on Cisco compliance policy, see General Export Compliance.
For information from the US Department of Commerce, see Denied Persons List.
Address
You must select a country in billing address when you create a customer. This country will be automatically assigned as the organisation country in Common Identity. Additionally, the organization country will determine the default global call-in numbers in Webex Meeting Sites with Cisco enabled PSTN calling options.
The site's default global call-in numbers will be set to the first available dial-in number defined in the telephony domain based on the organization's country. If the organization's country is not found in the dial-in number defined in the telephony domain, the default number of that location will be used.
S No. |
Location |
Country Code |
Country Name |
---|---|---|---|
1 |
AMER |
+1 |
US, CA |
2 |
APAC |
+65 |
Singapore |
3 |
ANZ |
+61 |
Australia |
4 |
EMEA |
+44 |
UK |
5 |
EURO |
+49 |
Germany |
Supported Language Locales
During provisioning, the language field will allow administrators to provision Wholesale customer organizations with a specific language. This language will get assigned automatically as the default locale for that customer organization and Webex Meeting Sites.
Five character language locales in (ISO-639-1)_(ISO-3166) format are supported. For example, en_US corresponds to English_UnitedStates. If only a two letter language is requested (using ISO-639-1 format), the service will generate a five character language locale by combining the requested language with a country code from the template i.e. "requestedLanguage_CountryCode", if unable to get a valid locale, then the default sensible locale used based on the required language code.
The following table lists the supported locales, and the mapping that converts a two-letter language code to a five-character locale for situations where a five-character locale is not available.
Supported Language Locales (ISO-639-1)_(ISO-3166) |
If only a two-letter language code is available... | |
---|---|---|
Language code (ISO-639-1) ** |
Use Default Sensible Locale instead (ISO-639-1)_(ISO-3166) | |
en_US en_AU en_GB en_CA |
en |
en_US |
fr_FR fr_CA |
fr |
fr_FR |
cs_CZ |
cs |
cs_CZ |
da_DK |
da |
da_DK |
de_DE |
de |
de_DE |
hu_HU |
hu |
hu_HU |
id_ID |
id |
id_ID |
it_IT |
it |
it_IT |
ja_JP |
ja |
ja_JP |
ko_KR |
ko |
ko_KR |
es_ES es_CO es_MX |
es |
es_ES |
nl_NL |
nl |
nl_NL |
nb_NO |
nb |
nb_NO |
pl_PL |
pl |
pl_PL |
pt_PT pt_BR |
pt |
pt_PT |
ru_RU |
ru |
ru_RU |
ro_RO |
ro |
ro_RO |
zh_CN zh_TW |
zh |
zh_CN |
sv_SE |
sv |
sv_SE |
ar_SA |
ar |
ar_SA |
tr_TR |
tr |
tr_TR |
The locales es_CO, id_ID, nb_NO and pt_PT are not supported by Webex Meeting Sites. For these locales, The Webex Meetings sites will be in English only. English is the default locale for sites if no/invalid/unsupported locale is required for the site. This language field is applicable while creating an Organization and Webex Meetings site. If no language is mentioned in a post or in the subscriber's API then language from the template will be used as a default language.
Service Provider Billing
A key goal for the Wholesale Route To Market (RTM) solution is to reduce the friction for Service Provider partner organizations in onboarding customers at scale.
-
Normally, distinct purchase orders are needed to establish a subscription per Webex customer. This slows down the onboarding process and is too much burden on a Wholesale SP who usually deal with many thousands of very small SMB customers (< 20 users per customer in the vast majority of cases).
-
To avoid this, Wholesale RTM only requires a single "blanked" Purchase Order/Subscription at the Service Provider level, against which the SP will be billed for all usage across their customer base. This frees up the Service Provider to focus on onboarding their customers onto the Webex platform.
Figure 5: Architecture Overview illustrates the basic steps in how the Wholesale Service Provider establishes their subscription and are ultimately billed for all usage.
-
The Service Provider places a single blanked Purchase Order into CCW for Wholesale services. This purchase order includes an itemized list of wholesale services (Packages or AddOns) that the Service Provider is entitled to sell to their customer base.
-
As customers are provisioned and Webex services get used, Webex tracks and records all Package and AddOn usage consumption.
-
At the end of the Service Provider billing period, Webex prorates the daily usage totals and generates an invoice to the Service Provider based on the agreed pricing per usage.
-
The Service Provider uses the Wholesale Billing public APIs to generate and download custom billing reports that break usage down on a per customer or per user basis. Service Providers can use data from these billing reports to bill their customers according to the customer usage.
Webex maintains historical records of all usage. For details on how to use these APIs see Billing Reconciliation.
SubPartner Capability
Wholesale RTM service provider partners would likely have a reseller channel. These reseller channels typically include agreements with one or many resellers (for this feature, we call the reseller a ‘SubPartner’). These SubPartners typically extend the offer to their customer base and manage the customer lifecycle which is critical to success. At its core, the feature allows a partner to abstract billing integration with Cisco from its SubPartners.
For more information, see Set up SubPartner section under Deploy Wholesale Route to Market.
Once set up, to successfully onboard customers, the SubPartner must use their access to Partner Hub to configure calling integration and Wholesale RTM onboarding templates (the parent partner's shared subscription ID will automatically appear during template creation). Once the templates are in place, the SubPartner may use the customer creation wizards in Partner Hub or the APIs to onboard customers. To provide some insight, Webex architecture models SubPartners as a partner, which allows SubPartners to benefit from capabilities similar to a partner. SubPartners can have their admin users, reporting, branding, and onboarding templates and fully manage their customers.
Currently, this model supports only 1 level (Partner - zero or more SubPartners), and there isn't a hard limit on the number of SubPartners per partner. A SubPartner does NOT have access to the parent partners instance and other SubPartners that may exist under the parent partner, and a SubPartner will be able to manage only customers they onboard. A partner can create, view, and delete billing reports for their individual SubPartners. For more information, see Billing Reconciliation on enhancements to the report related to Sub Partners.
- The Parent partner has the ability to create a template on the SubPartner's Partner Hub.
- The Parent partner could also assist in onboarding the wholesale customer on behalf of the SubPartner.
SubPartner (also known as indirect providers in the UI)
The SubPartner model enhancements in this phase enables parent partners to manage indirect providers and their customers with improved visibility and actions via Partner Hub and APIs.
The Parent partners will establish a managed-by relationship with both the indirect provider and their customers, improving visibility and control within the SubPartner model.
The managed-by relationship between the Parent partner and the SubPartner is established during the setup phase of the SubPartner.
Meanwhile, the managed-by relationship between the Parent partner and the sub-partner's customer is established during Wholesale customer creation or Wholesale organization attach.
Additionally, besides empowering SubPartners to independently carry out operations, this feature enables Parent partners to oversee both SubPartners and their respective customers through both the UI and APIs.
Wholesale Provisioning API Changes
The Wholesale API offers an extra support parameter 'onBehalfOfSubPartnerOrgId' on behalf of the partner, allowing the Parent partner to execute wholesale operations for the SubPartners.
Partner Hub
Parent Partner - Indirect Provider view
If you are signed in to Partner Hub as a Parent Partner Admin holding both the 'partner full admin' and 'wholesale admin' roles, you'll have access to the 'Indirect providers' tab. This section displays all indirect providers linked to your partner organization through a 'managed-by' relationship. On the right-hand side, you'll find the cross-launch button. Clicking on it will direct you to the Partner Hub account of the indirect provider, where you will be logged in as the Parent Partner admin user.
Parent Partner - Customer List view
When logged in to Partner Hub as a Parent Partner Admin with both the 'partner full admin' role and the 'wholesale admin' role, you will have access to the Parent Partner's customer list. However, as part of the SubPartner feature, you can now explicitly search for customers belonging to the Parent Partner's Indirect Providers. These customers will not be loaded in the customer list by default, but by explicitly searching for them, the Parent Partner admin can view them. Additionally, the Parent Partner admin will have the ability to cross-launch from here into the customers Control Hub of the Indirect Providers.
Limitation
- The cross-launch of the Helpdesk is not operational for the SubPartners.
- The UI for the Partner Hub indirect provider list currently only accommodates 100 indirect providers.
- When cross-launched into the SubPartner Partner Hub, the following
functionalities will be unavailable:
-
Analytics Screen
-
Services Screen
-
Reports Screen
-
Webex Release Management
-
Flex Trial Creation
-
List Wholesale SubPartners
Use this API to obtain a list of SubPartners for the partner organization. You can list all SubPartners, or limit the list to those SubPartners that meet the specified parameters such as provisioning state (suspended, active).
If you enter optional parameters, the API returns only those SubPartners that match exactly the parameters that you enter. For example, if you enter provisioning state, only SubPartners that have that specific provisioning state get returned.
-
Go to the List Wholesale SubPartners API.
-
Under Query Parameters, enter any search parameters that you want to use (for example, the provisioningState, offset, max). For additional details on these parameters, see the Developer help on the API.
-
Click Run.
The API outputs the list of SubPartners along with the unique orgId and provisioningState.
Branding
Partner administrators can use Advanced Branding Customizations to customize how the Webex App looks for the customer organizations that the partner manages. Partner administrators can customize the following settings to ensure that the Webex App reflects their company brand and identity:
-
Company logos
-
Unique Color Schemes for Light mode or Dark mode
-
Customized Support URLs
For details on how to customize branding, refer to Configure Advanced Branding Customizations.
-
Basic Branding customizations are in the process of being deprecated. We recommend that you deploy Advanced Branding, which offers a wider range of customizations.
-
For details on how branding is applied when attaching to a pre-existing Customer Organization, refer to Conditions of Org Attachment under the Attach Webex for BroadWorks to Existing Organization section.
Feature Matrix
For information on the supported features for the Wholesale Route-to-Market solution, see Webex Wholesale RTM feature matrix.
Onboarding and Managing Customers
Deployment Overview
The Wholesale RTM solution offers a streamlined deployment process that includes simplified provisioning, administration and billing. The following chapter provides procedures that describe:
-
How to provision new customer organizations and subscribers.
-
How to maintain and update existing customer and subscribers.
-
How to create Billing reconciliation reports so that you can bill your customers.
Before You Begin
You must decide on how you want to manage your customers and users. There are two interface options for provisioining and managing customers. This chapter provides procedures for both interfaces.
-
Manage customers manually via the Partner Hub interface
-
Manage customers using public APIs
Also, if you haven't yet assigned administration roles within the partner organization, see Partner Administrator Roles for Webex for BroadWorks and Wholesale RTM.
Onboarding with Wholesale Setup Assist
Wholesale Setup Assist is an optional customer onboarding service that Cisco offers to Wholesale RTM partners to help them onboard customers. The service is available to any partner that orders the A-Wholesale SKU in Cisco Commerce Workspace (CCW). Partners can order the service for specific customer locations via either the Express or Standard Wholesale SKU, with the sku being assigned automatically based on the quantity of users for the customer location.
As an additional benefit, the service updates the partner's billing reconciliation report automatically so that partners can bill their customers appropriately.
Following are the two Wholesale Setup Assist SKUs along with their respective pricing model. Note that these are net transfer prices to the partner. The list prices will be different (higher) based on the Wholesale partner discounts.
SKU |
SKU is used for... |
---|---|
Wholesale Setup Assist Express Usage |
Flat charge to set up location of up to 5 seats |
Wholesale Setup Assist Standard Usage |
Per-user charge to set up location with more than 5 seats |
Onboarding Flow with Wholesale Setup Assist
This section describes the onboarding flow when you use Wholesale Setup Assist.
Prerequisites
-
Partner must be onboarded fully to the Wholesale Route-to-Market solution. This includes items such as PSTN connectivity, third-party hosting requirements completed, OSS/BSS configured.
-
All requests for Wholesale Setup Assist must be submitted no later than six business days prior to onboarding completion.
-
We recommend that customers verify network connectivity at cscan.webex.com.
Onboarding Flow
Action |
Description | |
---|---|---|
1 |
Place a one-time purchase order in Cisco Commerce Workspace (CCW) for the A-Wholesale SKU with a quantity of 1. |
See Webex - Wholesale Ordering Guide for help with placing the order. This needs to be completed a single time only per partner. You don't need to repeat this for each new customer that you provision. |
2 |
Complete customer provisioning tasks using either of these flows: |
You can either provision customer organizations manually in Partner Hub or use APIs to complete provisioning. |
3 |
The Setup Assist can be done using either of these flows: |
After provisioning, submit the subscription request with the Wholesale Setup Assist Request Form or the Wholesale Setup Assist Order via API. You can also submit the request via a call to the Calling HelpDesk. |
4 |
The Setup Assist team helps you to onboard the customer using one of these flows: |
Refer to the flow that applies to the customer location that you are onboarding. The flow describes both Cisco and partner responsibilities at each stage of the process. |
Setup Assistance (Express Flow)
The following table breaks down the project flow for the Express option when the Cisco Wholesale Setup Assist team takes over onboarding. The below project phases occur after you complete provisioning and submit your assistance request.
The table breaks down the Cisco responsibility and partner responsibility at each phase of the project.
Project Phase |
Cisco Responsibility during this phase |
Partner Responsibility during this phase | |
---|---|---|---|
1 |
Discovery and Assessment |
| |
2 |
Solution Design |
|
Follow up with customer as required. |
Setup Assistance (Standard Flow)
The following table breaks down the project flow for the Express option when the Cisco Wholesale Setup Assist team takes over onboarding. The below project phases occur after you complete provisioning and submit your assistance request.
The table breaks down the Cisco responsibility and partner responsibility at each phase of the project.
Project Phase |
Cisco responsibility during this phase |
Partner responsibility during this phase | |
---|---|---|---|
1 |
Project Management |
|
|
2 |
Discovery and Assessment |
|
|
3 |
Solution Design |
|
|
4 |
Onboarding (testing) Plannign Phase |
|
|
5 |
Implementation |
|
|
6 |
Onboarding Execution |
|
|
7 |
Post-onboarding |
|
|
8 |
Operations handoff |
|
|
Partner Pre-Provisioning Check API
The Pre-Provisioning Check API helps administrators and sales teams by checking for errors before you provision a customer or subscriber for a package. Users or Integrations authorised by a User with the Partner Full Administrator role can use this API to ensure that there are no conflicts or errors with package provisioning for a given customer or subscriber.
The API checks to see if there are conflicts between this customer/subscriber and existing customers/subscribers on Webex. For example, the API may throw errors if the subscriber is already provisioned to a different customer or partner, if the email address exists already for another subscriber, or if there are conflicts between the provisioning parameters and what exists already on Webex. This gives you the opportunity to fix those errors before you provision, increasing the likelihood of successful provisioning.
For more information on the API, see: Webex for Wholesale Developer Guide
To use the API, go to : Precheck a Wholesale Subscriber Provisioning
To access Precheck a Wholesale Subscriber Provisioning document you need to log in to https://developer.webex.com/ portal.
Provision Customer Organization Task Flow (via Partner Hub)
1 |
Configure a Onboarding Template Before you provision a customer, you must set up a Onboarding template. You can use an existing template or create a new template. |
2 |
Create Customer via Partner Hub Create a new customer organization manually in Partner Hub. |
3 |
Set up the newly created customer by adding users and locations. |
Configure a Onboarding Template
You must have a Onboarding template before you can provision any customer organizations or users. Use this procedure to create a Onboarding template with common settings that you want to apply to the customer organizations that use the template. The following conditions apply:
-
You can apply a single Onboarding template to multiple customers.
-
You can create multiple Onboarding templates with settings that are targeted to different sets of customers.
1 |
Sign in to Partner Hub and select Customers. |
2 |
Click the Templates button to view existing templates. |
3 |
Click Create template. |
4 |
Select Webex for wholesale and click Next. |
5 |
Set up your Primary settings:
|
6 |
From the Wholesale subscription drop-down, select your subscription. |
7 |
Click Next. |
8 |
Select one of the following Authentication method:
|
9 |
Click Next. |
10 |
Under Wholesale calling, select a Cloud Connected PSTN vendor if desired, and click Next. Cisco does not recommend using this optional template setting due to limitations with this approach. For more information, see Customer PSTN Setup. |
11 |
Configure Common settings and Call settings options:
|
12 |
Click Next. |
13 |
Review the settings summary and click Edit to change any settings that you want. When the settings look correct, click Submit. Your newly created template gets added to the template view.
|
14 |
Open the template that you created and copy the Provisioning ID value. You'll need this value when you provision a customer organization. |
Create Customer via Partner Hub
1 |
Sign in to Partner Hub. |
2 |
Click Customers to view the list of existing customers. You can select any customer to view information about that organization. |
3 |
Click Create customer to create a new customer organization. |
4 |
On the Customer information screen, enter details such as company name, Administrator email and the template that you want to apply. |
5 |
Click Next. |
6 |
On the Packages screen, select the package that you want to apply to this customer and click Next. |
7 |
On the Headquarter's location screen, enter location details about the customer's headquarters. |
8 |
If the headquarters are in a Webex supported location, click the I verify that this customer is in a Cisco Webex supported location check box. |
9 |
Click Next. |
10 |
Review the customer summary. If the information is correct, click Create customer. |
What to do next
Set up Customer
1 |
Sign in to Partner Hub. |
2 |
Click Customers and select the appropriate customer. The customer settings display on the right side of the screen. |
3 |
Click Setup Customer. The Set up Users wizard launches. |
4 |
In the Add and confirm locations screen, enter additional locations such as branch offices. |
5 |
Click Next. |
6 |
In the Add users screen, enter user details such as First Name, Last Name, Email, Package, and Location. |
7 |
Click Next. |
8 |
Assign Phone Numbers for users who have a calling package. |
9 |
Click Next. |
10 |
Review the information that you entered. |
11 |
Click Create users. If you are providing Control Hub acccess to customer organizations, you can also assign roles to the customer administrators. See Assign organization account roles in Control Hub. |
What to do next
Administrators should be provisioned with the same level of package as the customer organization was created with. No downgrade of the package is supported for the customer administrator (full administrator).
Provision Customer Organization Task Flow (via API)
1 |
Configure a Onboarding Template Before you provision a customer, you must have set up a Onboarding template in Partner Hub. You can use an existing template or create a new one. |
2 |
Provision Wholesale Customer API Provision the customer organization using APIs. Apply the Onboarding template settings to your new customer organization. |
3 |
Provision Wholesale Subscribers API Add subscribers (users) to the customer organization using APIs. |
Provision Wholesale Customer API
Before you begin
For more information on supported languages, see: Supported Language Locales
1 |
Open the Provision a Wholesale Customer API. |
2 |
In the configuration area on the right, complete the required fields for the customer org. Make sure to follow the format in the examples:
|
3 |
Click Run. The result displays in the Response window. The response also contains a URL that displays in the Location header and which points to the organization.
|
What to do next
Provision Wholesale Subscribers API
1 |
Open the Provision a Wholesale Subscriber API. |
2 |
Complete the following required fields. For additional information on the fields, refer to the field descriptions with the API:
The LocationId provisioning parameter is applicable to calling packages only. This field can be used if you are attaching this subscriber to an existing customer organization that has multiple locations. This field lets you specify the proper location. |
3 |
Click Run. |
4 |
Repeat these steps to provision additional subscribers. If you are providing Control Hub acccess to customer organizations, you can also assign roles to the customer administrators. See Assign organization account roles in Control Hub. |
What to do next
Customer PSTN Setup
To setup PSTN service for your Customer Locations, Cisco recommends two approaches:
- If you manage your customer service via Partner Hub, you must navigate to the Customer Location and provision the appropriate PSTN option.
- If you manage your customer via Webex APIs, you can leverage the https://developer.webex.com/docs/api/v1/pstn to provision PSTN for the location.
Cisco also provides a convenient method of provisioning Cloud Connected PSTN for Customers via Onboarding Templates. This is not a preferred approach due to the following the limitations:
- The Cloud Connected PSTN vendor selected in the Onboarding Template applies to the initial customer location only.
- Changing the Cloud Connected PSTN vendor selected in the Onboarding Template has no impact on existing customers or locations.
- Partners need to ensure that the selected Cloud Connected PSTN vendor has coverage within the country selected for the first location to avoid potential provisioning failures which will require intervention either via API or within Control Hub to rectify.
Attaching Webex for Wholesale to an Existing Customer Organization
If you are a partner administrator adding Webex for Wholesale services to an existing Webex customer organization that is not currently managed by a Wholesale, the customer organization administrator must approve administrator access for the provisioning request to succeed.
Organization administrator approval is required if any of the following criteria are met:
-
The existing customer organization has 100 users or more.
-
The organization has a verified email domain.
-
The organization domain is claimed.
Automatic Attachment Scenario
In an Automatic Attachment scenario, a Webex for Wholesale subscription is added to an existing customer organization without notifying the existing org administrator or end user. In most cases, your Partner Org will be given Provisioning Admin rights. However, if the customer org has no licenses or only suspended/canceled licenses, you will be made a Full Admin.
With Provisioning Admin access, you will have limited visibility in Control Hub to the users in the existing org. It is recommended that you contact the customer admin and request Full Admin access to the org.
Steps to Add Wholesale Services to a Preexisting Customer Organization
Partner administrators can follow these steps to add Wholesale services to an existing Webex organization:
- If you do not already manage the customer, ask the customer admin to add you as an external administrator with full admin rights. This step is not mandatory at this stage but simplifies the process. The customer admin may have to do this later if the provisioning attempt is not eligible for an automatic attachment.
- Ensure that the onboarding template has the "Allow admin-invite emails when attaching to existing orgs" toggle set to true (located in Common Settings of template details).
- Collect the parameters needed to use the POST Wholesale Customer API:
- provisioningId, packages, orgId, externalId, address.
- The orgId can be obtained from the Account Section of Control Hub.
- The provisioningId can be found in the Onboarding templates section in Partner Hub by viewing a Wholesale template's details.
- The provisioningParameters are required when any calling packages are being provisioned.
- provisioningId, packages, orgId, externalId, address.
- Provision the Wholesale services using the POST Wholesale Customer API, ensuring all required parameters are provided.
- If the request is successfully accepted, a 202 response will be returned. This does not mean provisioning has succeeded, as wholesale provisioning is done asynchronously. Use the status attribute returned by the GET Wholesale Customer API to check if provisioning succeeded.
Limitations and Unsupported Use Cases
- After attaching wholesale services to a partner's own customer org, further provisioning must be done via the Public APIs, not through Partner Hub.
- Organization approval is required from the customer admin in certain scenarios when adding wholesale services to a customer that is not currently managed by a Wholesale partner:
- The existing customer organization has 100 users or more.
- The organization has a verified email domain.
- The organization domain is claimed.
- Conversion of trial organizations to Wholesale customers is not supported.
Conditions of Org Attachment
- The first user from the existing org who is provisioned for Webex for Wholesale is not provisioned as an admin user. Settings and entitlements from the existing org are retained.
- The organization’s existing authentication settings take precedence over what is configured on the Webex for Wholesale provisioning template. As a result, there is no change to how existing users log in.
- If the existing customer organization has basic branding enabled, after the attach occurs, the Partner's Advanced branding settings will take precedence. If the customer wants the basic branding to remain intact, then the partner must configure the customer organization to override branding in the Advanced Branding settings.
- The name of the existing organization will not change.
- Restricted Admin Mode (set by the Restricted by Partner Mode toggle) is turned off for the attached org.
Submit Wholesale Setup Assist Request Form
If you are using the Wholesale Setup Assist service, complete this form after you provision customers and users in Partner Hub and Control Hub to submit the subscription request.
1 |
Open the Wholesale Setup Assist Request Form. | ||||||||||||||
2 |
Complete the following fields on the request form. You can get most of the values from Partner Hub and Control Hub settings. The following table describes how to find appropriate values for some of the prominent settings.
| ||||||||||||||
3 |
Complete any additional fields on the SmartSheet. Make sure to complete all fields with an *. | ||||||||||||||
4 |
To receive an email copy of the request, check the Send me a copy of my responses check box. | ||||||||||||||
5 |
Click Submit. If you run into any issues, you can request Setup Assist help from Calling HelpDesk. The team assists with “how-to” calling questions and initiates engagement with the Setup Assist Team. |
What to do next
The Wholesale Setup Assist team at Cisco takes over the onboarding process and works with you to complete the onboarding process. For more details on the project flow, and the Cisco responsibility and partner responsibilities during this process, see one of the following two flows:
-
For Express Flow, see Setup Assistance (Express Flow) of Onboarding Flow with Wholesale Setup Assist in the Reference section.
-
For Standard Flow, see Setup Assistance (Standard Flow) of Onboarding Flow with Wholesale Setup Assist in the Reference section.
Set up SubPartner
While requesting to be set up in this model, we recommend that the partner maintain an admin account per SubPartner to support the SubPartner during technical onboarding, setup and support phases. We realize that this may pose additional operational challenges (maintaining a new email and credentials per SubPartner) for the partner and seeking to fix this in a future phase. That said, please get in touch with the PSM team with the following details.
-
Your Org ID
-
Your Org name
-
SubPartner Org name
-
Email address to be assigned as first SubPartner administrator user
-
First and Last Name of first SubPartner administrator user
-
Your Subscription ID is to be shared with the SubPartner Org
-
Billing start date for the SubPartner (Default: SubPartner setup date)
Administration via Partner Hub
The Partner Hub user interface includes options that let you manage many administration tasks manually via the Partner Hub interface. For example, you can do the folloiwng tasks:
-
Provision new customer organizations and users
-
Add or update users for existing organizations
-
Update existing settings
Add Users Manually
1 |
Sign in to Partner Hub and click Customers. |
2 |
Launch the customer view for the applicable customer. The customer view opens in Control Hub.
|
3 |
Click Users. |
4 |
Click Manage users. |
5 |
Click Manually Add Users. You also have additiional options to add or modify users:
|
6 |
Enter the Basic information for that user (for example, names, email addresses and package) and click Next. |
7 |
Add additional users. You can add up to 25 users. |
8 |
Click Next. |
9 |
Click Close. |
Change User Package
1 |
Sign in to Partner Hub and click Customers. |
2 |
Launch the customer view for the customer that the user is under. |
3 |
In Control Hub, click Users. |
4 |
Select the user whose package you want to change. |
5 |
In the Package section, click the arrow (>). |
6 |
Choose the new package. |
7 |
If you changed the package to Webex Calling or Webex Suite, update the calling number information. |
8 |
Click Change. |
Customer Management APIs
The following public APIs let Wholesale partners manage settings for existing customer organizations.
API |
Description |
---|---|
Use this API to update settings for one of your existing customer organizations. | |
Use this API to view a summary of settings for an existing customer, including orgID, address, provisioning status, and packages. | |
Use this API to list your customer organizations, along with a summary of their main settings. You can enter optional parameters to limit the search to only those organizations that meet the search criteria. | |
Use this API to delete an existing customer organization. |
Update a Wholesale Customer
1 |
Open the Update a Wholesale Customer API. |
2 |
In the PUT field, click customerID and enter the customerID for the customer organization that you want to update. |
3 |
In the Body enter any optional parameters.
|
4 |
Click Run. |
Get a Wholesale Customer
1 |
Open the Get a Wholesale Customer API. |
2 |
In the GET line, click id and enter the customer ID. |
3 |
Click Run. The output displays the details for that customer organization.
|
List Wholesale Customers
Use this procedure to use the API to get a list of your existing customer organizations, along with details for those customer organizations.
-
If you run the API without search parameters, the output displays every customer that the partner manages.
- If you run the API with search parameters, the output displays only those customers who match the criteria. For example, if you enter an externalId the output displays only the customer organization that uses that Id.
1 |
Open the List Wholesale Customers API. |
2 |
Optional. Enter any optional search parameters. |
3 |
Click Run. The output displays customer details for the customers who meet your search criteria.
|
Delete a Wholesale Customer
Use this procedure to remove Wholesale services from an existing customer organization.
This API removes Wholesale services from an existing Webex customer organization, but does not delete the organization completely. To delete the organization from Webex, use the Organization APIs.
Before you begin
1 |
Open the Delete a Wholesale Customer API. |
2 |
Enter the customerID of the customer organization that you want to delete. |
3 |
Click Run. |
Device Onboarding and Management
Wholesale RTM supports all Cisco devices and a wide range of Third-Party devices via different Device Management (DM) options available at the Webex platform. The DM options are detailed as below:
-
Cisco Managed Cisco Devices: The Cisco Webex platform natively supports all Cisco Devices (MPP & RoomOS) via this DM option. These devices can be added and provisioned directly through CH or APIs and give partners and customers the best Cisco on Cisco Experience. Cisco Devices are also enabled with Webex awareness which means users can access Webex services (Enhanced serviceability, Unified Call History, Directory Sync, Webex presence, one button to join, Hot Desking etc.) from their Cisco MPP phones. They can also make PSTN calls from their RoomOS Devices in addition to the Webex services listed.
For procedures about how to onboard new MPP devices, see Configure and Manage Webex Calling Devices.
For more information about Cisco device features, see Webex Features Available on Cisco MPP Devices.
- Cisco Managed Third-Party Devices: Cisco Webex platforms natively supports a few widely deployed Third-Party devices (Poly, Yealink, others). New customer organizations in Wholesale do not have access to these Third-Party phones when adding a new phone which can be enabled via contacting Cisco or your account manager. More details on these devices, see Supported devices for Webex Calling.
- Externally Managed Devices: Cisco further allows support for a wide range of Third-Party devices via the externally managed DM options where Partners and Customers can provision devices as Generic SIP devices, download and manage the SIP authentication credentials/configuration files with or without using an external DM tool based on the level of DM capability required. These DM options are:
- Customer Managed Devices: This DM option allows partners and customers to support generic SIP devices like Pagers, Door Phones etc. where the customization requirements are very low. For more information on how to add a Customer Managed device, see Add your customer-managed device.
- Partner Managed Devices: This is a new DM option that allows partners and customers to support a range of Third Party SIP phones and Gateways with full customization and at scale using an external DM tool. For more information on Partner Managed devices, see Partner Managed Devices for Webex.
Billing Reconciliation
Partner administrators can use the Wholesale Billing APIs to generate custom billing reports that display usage consumption at the per partner, per customer, or per user levels. Partners can use this information to reconcile their monthly invoice so that they can bill their customers and users according to their usage consumption.
Partners can also generate custom billing reports for sub-partners using subPartnerOrgId parameter.
There are four APIs that are available to partner administrators who meet the minimum access requirements.
Billing API |
Purpose of API |
Partner Admin Access Requirement |
---|---|---|
Create a Wholesale Billing Report |
Used to generate a billing report. |
Read / Write |
Get a Wholesale Billing Report |
Used to get a generated billing report for download. |
Read |
List Wholesale Billing Reports |
Used to list the billing reports that exist for that partner. |
Read |
Delete a Wholesale Billing Report |
Used to delete an existing billing report. |
Read / Write |
Data Source
Data for the Billing reports gets pulled from the usage consumption data that Webex tracks for each partner. Each day, Webex tracks the previous day's usage consumption for all partners, customers and users and aggregates the data so that it can be used to generate the partner's monthly invoice. Billing APIs leverage this data, letting partner admins generate custom reports so that the partner can reconcile usage consumption from their monthly invoice at the partner, customer and user levels.
For more detailed information on how Webex invoices partners, see Service Provider Billing.
Create a Wholesale Billing Report
1 |
Go to the Create a Wholesale Billing Report API. |
2 |
Enter the billing period by entering values for the billingStartDate and billingEndDate in the format that the API specifies. You can enter any date from the last five years, but not the current day. |
3 |
Enter the Type of report:
|
4 |
Click Run to generate the report. |
5 |
Copy the report id from the API output. You can use this value with the Get API in order to get the generated billing report. |
What to do next
Get a Wholesale Billing Report
1 |
Go to the Get a Wholesale Billing Report API. |
2 |
In the GET line, click the id button and enter the unique id value for the report. |
3 |
Click Run. |
4 |
The API outputs report status. The output includes the tempDownloadURL parameter, which provides a URL from which you can download the report. |
5 |
Copy the tempDownloadURL into a browser in order to access and download the report. |
List Wholesale Billing Reports
Use this API to obtain a list of generated billing reports for the partner organization. You can list all existing reports, or limit the list to those reports that meet the specified parameters such as your billing period and billing type (Partner, customer, user).
1 |
Go to the List Wholesale Billing Report API |
2 |
Under Query Parameters, enter any search parameters that you want to use (for example, the startDate, endDate, Type, sortBy on). For additional details on these parameters, see the Developer help on the API. |
3 |
Click Run. The API outputs the list of reports along with the unique report id and status (COMPLETED, IN_PROGRESS).
|
What to do next
Delete a Wholesale Billing Report
Use this procedure to delete a generated billing report based on report id. A few examples where you may want to delete a report include:
-
If you want to regenerate an existing billing report, you must first delete the existing report. After you delete the existing report, you can create a new report for that period. Note that the delete requirement does not exist if the report is failed or is in progress.
-
If a report is generated and you send the URL to the wrong person, you can delete the report and they won’t be able to access it.
1 |
Go to the Delete Wholesale Billing Report API. |
2 |
Enter the report Id. |
3 |
Click Run. |
Billing Report Fields
Billing reports contain the following fields:
Field |
Additional Info |
Appears in Reports of this type |
---|---|---|
PARTNER_NAME |
Name of partner |
PARTNER, CUSTOMER, USER |
PARTNER_ORG_ID |
Unique partner identifier |
PARTNER, CUSTOMER, USER |
SUBSCRIPTION_ID |
Unique subscription identifier |
PARTNER, CUSTOMER, USER |
SERVICE_NAME |
Name of service (e.g, COMMON_AREA_CALLING, WEBEX_CALLING, WEBEX_SUITE, WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
SKU |
Sku for the service |
PARTNER, CUSTOMER, USER |
DESCRIPTION |
Description of the service |
PARTNER, CUSTOMER, USER |
CONSUMPTION_START_DATE |
Start of the service consumption. Along with the below field, this value defines the usage period. |
PARTNER, CUSTOMER, USER |
CONSUMPTION_END_DATE |
End of the service consumption. Along with the above field, this value defines the usage consumption period. |
PARTNER, CUSTOMER, USER |
QUANTITY |
Represents the aggregated user usage consumption per partner, per customer or per user (depending on the report and level at which you are viewing the data). Calculation: For each user, the per-day quantity is calculated on a prorated basis for that day. For example: Usage for a full day = 1 Usage for a half day = 0.5 The per-day totals for all days within the billing period are summed to provide a total quantity for that user within that billing period. For customer and partner-level reports, the totals for all users are aggregated to provide a total quantity for that customer or partner. |
PARTNER, CUSTOMER, USER |
CUSTOMER_ORG_ID |
Internal Customer Unique Identifier |
CUSTOMER, USER |
CUSTOMER_EXTERNAL_ID |
Customer Unique Identifier as provided by a partner |
CUSTOMER, USER |
SUBSCRIBER_ID |
Unique identifier for the subscriber |
USER |
USER_ID |
The subscriber's Webex user ID |
USER |
WORKSPACE_ID |
Unique workspace identier |
USER |
LOCATION_ID |
Unique Location Identifier |
CUSTOMER,USER |
Webex Wholesale billing is triggered by the provisioning of a package to a user or stopped by removing the package assignment.
Partner SSO - SAML
Allows partner administrators to configure SAML SSO for newly created customer organizations. Partners can configure a single pre-defined SSO relationship and apply that configuration to the customer organizations that they manage, as well as to their own employees.
-
Verify that the third-party Identity Provider provider meets the requirements listed in the Requirements for Identity Providers section of Single Sign-On Integration in Control Hub.
-
Upload the CI metadata file that has Identity Provider.
-
Configure a Onboarding Template. For the Authentication Mode setting, select Partner Authentication. For the IDP Entity ID, enter the EntityID from the SAML metadata XML of the third-party identity provider.
-
Create a new user in a new customer organization that uses the template.
-
Very that the user can log in.
Partner SSO - OpenID Connect (OIDC)
Allows partner administrators to configure OIDC SSO for newly created customer organizations. Partners can configure a single pre-defined SSO relationship and apply that configuration to the customer organizations that they manage, as well as to their own employees.
The below steps to set up Partner SSO OIDC apply to newly created customer organizations only. If partner administrators try to modify the default authentication type to Partner SSO OIDC in an existing temple, the changes will not apply to the customer organizations already onboarded using the template.
-
Open a Service Request with Cisco TAC with the details of the OpenID Connect IDP. The following are mandatory and optional IDP attributes. TAC must set up the IDP on the CI and provide the redirect URI to be configured on the IDP.
Attribute
Required
Description
IDP Name
Yes
Unique but case-insensitive name for OIDC IdP config, could consist of letters, numbers, hyphens, underlines, tildes, and dots and max length is 128 characters.
OAuth client Id
Yes
Used to request OIDC IdP Authentication.
OAuth client Secret
Yes
Used to request OIDC IdP Authentication.
List of scopes
Yes
List of scopes which will be used to request OIDC IdP authentication, split by space, e.g. 'openid email profile' Must including openid and email.
Authorization Endpoint
Yes if discoveryEndpoint not provided
URL of the IdP's OAuth 2.0 Authorization Endpoint.
tokenEndpoint
Yes if discoveryEndpoint not provided
URL of the IdP's OAuth 2.0 Token Endpoint.
Discovery Endpoint
No
URL of the IdP's Discovery Endpoint for OpenID endpoints discovery.
userInfoEndpoint
No
URL of the IdP's UserInfo Endpoint.
Key Set Endpoint
No
URL of the IdP's JSON Web Key Set Endpoint.
In addition to the above IDP attributes, the partner organization ID needs to be specified in the TAC request.
-
Configure the redirect URI on the OpenID connect IDP.
-
Configure a Onboarding template. For the Authentication Mode setting, select Partner Authentication With OpenID Connect and enter the IDP Name provided during the IDP setup as the OpenID Connect IDP Entity ID.
-
Create a new user in a new customer organization that uses the template.
-
Very that the user can log in using the SSO authentication flow.
Restricted by Partner Mode
Restricted by Partner Mode is a Partner Hub setting that partner administrators can assign to specific customer organizations to limit the organization settings that customer administrators can update in Control Hub. When this setting is enabled for a given customer organization, all of that organization's customer administrators, irrespective of their role entitlements, are unable to access a set of restricted controls in Control Hub. Only a partner administrator can update the restricted settings.
Customer Administrator Access
Customer administrators receive a notification when Restricted-by-Partner Mode is applied. After login, they will see a notification banner at the top of the screen, immediately under the Control Hub header. The banner notifies the customer administrator that Restricted Mode is enabled and they may not be able to update some calling settings.
For a customer administrator in an organization where Restricted by Partner Mode is enabled, the level of Control Hub access is determined with the following formula:
(Control Hub access) = (Organization Role entitlements) - (Restricted by Partner Mode restrictions)
Customer administrators will face several restrictions, regardless of the Restricted-by-Partner Mode. These restrictions include:
- Call Settings: The 'App Options Call Priority' settings in the Calling menu are read-only.
- Location Setup: Setting up calling after location creation will be hidden.
- PSTN Management and Call Recording: These options will be greyed out for the location.
- Phone Number Management: In the Calling menu, phone number management is disabled, and the 'App Options Call Priority' settings, as well as call recordings, are read-only.
Restrictions
When Restricted-by-Partner Mode is enabled for a customer organization, customer administrators in that organization are restricted from accessing the following Control Hub settings:
-
In the Users view, the following settings are not available:
-
Manage Users button is greyed out.
-
Manually Add or Modify Users—No option to add or modify users, either manually or via CSV.
-
Claim Users—not available
-
Auto-assign Licenses—not available
-
Directory Synchronization—Unable to edit directory sync settings (this setting is available to Partner-level admins only).
-
User details—User settings such as First Name, Last Name, Display Name and Primary Email* are editable.
-
Reset Package—No option to reset the package type.
-
Edit Services—No option to edit the services that are enabled for a user (e.g., Messages, Meetings, Calling)
-
View Services status—Unable to see full status of Hybrid Services or Software Upgrade Channel
-
Primary Work Number—This field is read-only.
-
-
In the Account view, the following settings are not available:
-
Company Name is read-only.
-
-
In the Organization Settings view, the following settings are not available:
-
Domain—Access is read-only.
-
Email—The Suppress Admin Invite Email and Email Locale Selection settings are read-only.
-
Authentication—No option to edit Authentication and SSO settings.
-
-
In the Calling menu, the following settings are not available:
-
Call Settings—The App Options Call Priority settings are read-only.
-
Calling Behavior—Settings are read-only.
-
Location > PSTN—The Local Gateway and Cisco PSTN options are hidden.
-
-
Under SERVICES, the Migrations and Connected UC service options are suppressed.
Enable Restricted by Partner Mode
Partner administrators can use the below procedure to enable Restricted by Partner Mode for a given customer organization (the default setting is enabled).
-
Sign in to Partner Hub ( https://admin.webex.com) and select Customers.
-
Select the applicable customer organization.
-
In the right-hand settings view, enable the Restricted by Partner Mode toggle to turn the setting on.
If you want to turn Restricted by Partner Mode off, disable the toggle.
If the partner removes the restricted administrator mode for a customer administrator, the customer administrator will be able to perform the following:
-
Add Webex for Wholesale users (with the button)
-
Change packages for a user
For more information on list of time zones supported for Wholesale Provisioning, see the List of Time Zones supported for Wholesale Provisioning.
Technical Support
The below diagram highlights the support model for this offer.
Partners are expected to handle inquiries from their customers. However, should a partner require help, the following table summarizes the support channels that are available to partner administrators. Note that
Support Channel |
Description |
---|---|
Webex Calling Help Desk |
Provides 'how to' and help with inquiries about Webex Calling features and configuration
|
TAC
|
Partner may contact TAC directly by:
|
Cisco Experience Services |
Customer may contact CES directly from within CCW
|
How to Engage the Webex Calling Partner Help Desk (PHD)
Partner Experience
Any partner how-to and/or documentation inquiries about the Wholesale offering should be directed to the Webex Calling Partner Helpdesk (PHD). To contact the PHD, use the information below:
-
Phone:
-
United States: 1-844-613-6108
-
United Kingdom: +44 129 366 10 20
-
Germany: +49 22 197 585129
-
Australia: +61 3 7017 7272
-
-
Open a Ticket https://mycase.cloudapps.cisco.com/case > Webex > Calling and Business Phones > Webex Partner Helpdesk
-
Email:
- webexcalling-PHD@cisco.com
- Webex Calling Multi-Tenant: webexcalling-PHD@cisco.com
- Webex Calling Carrier: bc-carrier-PHD@cisco.com
-
Chat:
- Live Chat - help.webex.com/en-us/contact > Chat
- Live Chat - https://admin.webex.com/partner/resources
PHD Escalations:
- Partner Help Desk Manager: Matt Hannah – ( mathanna@cisco.com)
- Lead on PHD: James Moss – ( jamemoss@cisco.com)
- Sr. Manager for Partner Technical Services: Hamid Tiouti – ( hatiouti@cisco.com)
Migration Tools for BroadWorks to Wholesale RTM Migrations
Overview
This document covers a set of migration tools that helps to migrate existing BroadWorks customers to the Wholesale Route-to-Market solution. The migration tools are easy-to-access command line tools that allow migrating the customers, locations, numbers, users, services, phones, and soft clients by automating the migration tasks. The migration tools offer the following benefits:
-
Run migration with minimal pre-configuration.
-
Ease commands to run.
-
Administrators can review their data after the provisioning and make and receive calls immediately after the migration.
-
It supports an automatic upgrade to the Webex App for UC-One clients.
Document
-
To view the Migration Tools for BroadWorks to Wholesale RTM guide, see Migration Tools for BroadWorks to Wholesale RTM Solutions
Document Revision History
Date |
Version |
Description |
---|---|---|
October 12, 2024 |
1.35 |
|
October 11, 2024 |
1.34 |
|
August 21, 2024 |
1.33 |
|
August 9, 2024 |
1.32 |
|
July 12, 2024 |
1.31 |
|
June 27, 2024 |
1.30 |
|
May 27, 2024 |
1.29 |
|
May 22, 2024 |
1.28 |
|
May 10, 2024 |
1.27 |
|
May 08, 2024 |
1.26 |
|
March 22, 2024 |
1.25 |
|
February 06, 2024 |
1.24 |
|
January 23, 2024 |
1.23 |
|
December 12, 2023 |
1.22 |
|
August 23, 2023 |
1.21 |
|
July 31, 2023 |
1.20 |
|
June 09, 2023 |
1.19 |
|
May 26, 2023 |
1.18 |
|
May 19, 2023 |
1.17 |
|
May 09, 2023 |
1.16 |
|
April 28, 2023 |
1.15 |
|
April 17, 2023 |
1.14 |
|
January 26, 2023 |
1.13 |
|
December 07, 2022 |
1.12 |
|
December 05, 2022 |
1.11 |
|
November 30, 2022 |
1.10 |
|
November 02, 2022 |
1.9 |
|
August 31, 2022 |
1.8 |
|
August 18, 2022 |
1.7 |
|
July 29, 2022 |
1.6 |
|
June 10, 2022 |
1.5 |
|
June 03, 2022 |
1.4 |
|
May 02, 2022 |
1.3 |
|
April 11, 2022 |
1.2 |
|
March 02, 2022 |
1.1 |
|