DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks Subscribers
GETList BroadWorks Subscribers
POSTProvision a BroadWorks Subscriber
GETGet a BroadWorks Subscriber
PUTUpdate a BroadWorks Subscriber
DELETERemove a BroadWorks Subscriber
POSTPrecheck a Broadworks Subscriber Provisioning
Call ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks Subscribers
GETList BroadWorks Subscribers
POSTProvision a BroadWorks Subscriber
GETGet a BroadWorks Subscriber
PUTUpdate a BroadWorks Subscriber
DELETERemove a BroadWorks Subscriber
POSTPrecheck a Broadworks Subscriber Provisioning
Call ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Precheck a Broadworks Subscriber Provisioning

Verify the likely success of provisioning a broadworks subscriber.

The Prerequisite for using this API is to have at least one Broadworks Cluster configured against partner using Partner Hub. The Provisioning Precheck APIs supports two variants of Broadworks Provisioning Precheck Requests. Please refer to Using the Provisioning Precheck API section in Webex for BroadWorks guide for more information.

POST/v1/broadworks/subscribers/validate
Body Parameters
provisioningId
string

Provisioning ID that defines how this subscriber is to be provisioned for Cisco Webex Services. Each Customer Template has their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Cisco Webex Control Hub.

userId
string

The user ID of the Broadworks subscriber.

spEnterpriseId
string

The Service Provider supplied unique identifier for the subscriber's enterprise.

firstName
string

The first name of the subscriber.

lastName
string

The last name of the subscriber.

package
enum

The Webex for BroadWorks package to be assigned to the subscriber.

softphone
string

Softphone package.

basic
string

Basic package.

standard
string

Standard package.

premium
string

Premium package.

primaryPhoneNumber
string

The primary phone number configured for the subscriber on BroadWorks.

mobilePhoneNumber
string

The mobile phone number configured against the subscriber on BroadWorks.

extension
string

The extension number configured against the subscriber on BroadWorks.

email
stringrequired

The email address of the subscriber.

language
string

The ISO 639-1 language code associated with the subscriber. Reserved for future use. Any value currently specified will be ignored during subscriber provisioning.

timezone
string

The time zone associated with the subscriber. Refer to the Webex Meetings Site Timezone section of the Webex for BroadWorks guide for more information.

customerInfo
object
primaryEmail
stringrequired

Email address of a user in the customer org that you want to provision.

Response Properties
message
string

A textual representation of the precheck response message.

info
object

A list of ProvisioningPreCheckResponseInfo objects.

infoCode
number

Provisioning Precheck infoCode.

description
string

A textual description of the infoCode.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
POST
/v1/broadworks/subscribers/validate
Log in to try the API.
Header
Body
  • Provisioning ID that defines how this subscriber is to be provisioned for Cisco Webex Services. Each Customer Template has their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Cisco Webex Control Hub.
  • The user ID of the Broadworks subscriber.
  • The Service Provider supplied unique identifier for the subscriber's enterprise.
  • The first name of the subscriber.
  • The last name of the subscriber.
  • The Webex for BroadWorks package to be assigned to the subscriber.
  • The primary phone number configured for the subscriber on BroadWorks.
  • The mobile phone number configured against the subscriber on BroadWorks.
  • The extension number configured against the subscriber on BroadWorks.
  • The email address of the subscriber.
  • The ISO 639-1 language code associated with the subscriber. Reserved for future use. Any value currently specified will be ignored during subscriber provisioning.
  • The time zone associated with the subscriber. Refer to the [Webex Meetings Site Timezone](/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) section of the [Webex for BroadWorks](/docs/api/guides/webex-for-broadworks-developers-guide) guide for more information.
  • Request
  • Response
{
    "customerInfo": {
        "primaryEmail" : "john.anderson@example.com"
    },
    "email": "alice.anderson@example.com"
}
200 / OK
{
    "message": "success",
    "info": [
        {
            "infoCode": 100,
            "description": "Provisioning preCheck validation successful."
        }
    ]
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.