openapi: 3.0.0
info:
  title: Webex Admin Address Book BroadWorks Subscribers API
  version: 1.0.0
  description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: BroadWorks Subscribers
paths:
  /broadworks/subscribers:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberListResponse'
              example:
                items:
                - id: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
                  personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                  userId: 95547321@sp.com
                  spEnterpriseId: SP1+acme
                  firstName: John
                  lastName: Andersen
                  email: john.anderson@acme.com
                  primaryPhoneNumber: +1-240-555-1212
                  mobilePhoneNumber: +1-818-279-1234
                  extension: '1212'
                  package: standard
                  status: error
                  errors:
                  - errorCode: 10022
                    description: The BroadWorks UserID is already associated with an existing user
                  created: '2019-10-18T14:26:16.000Z'
                  lastStatusChange: '2020-03-18T16:05:34.000Z'
                  provisioningId: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
                  selfActivated: 'false'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The 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.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The 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.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: List BroadWorks Subscribers
      operationId: List BroadWorks Subscribers
      description: This API lets a Service Provider search for their associated subscribers. There are a number of filter options that can be combined in a single request.
      tags:
      - BroadWorks Subscribers
      parameters:
      - name: userId
        in: query
        description: The user ID of the subscriber on BroadWorks.
        example: 95547321@sp.com
        schema:
          type: string
      - name: personId
        in: query
        description: The Person ID of the Webex subscriber.
        example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
        schema:
          type: string
      - name: email
        in: query
        description: The email address of the subscriber.
        example: john.anderson@acme.com
        schema:
          type: string
      - name: provisioningId
        in: query
        description: The Provisioning ID associated with this subscriber.
        example: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
        schema:
          type: string
      - name: spEnterpriseId
        in: query
        description: The Service Provider supplied unique identifier for the subscriber's enterprise.
        example: SP1+Acme
        schema:
          type: string
      - name: lastStatusChange
        in: query
        description: Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
        example: '1579046400245'
        schema:
          type: string
      - name: status
        in: query
        description: 'The provisioning status of the subscriber. This Parameter supports multiple comma separated values. For example : status=error,provisioned,provisioning.'
        example: pending_email_input
        schema:
          type: string
          enum:
          - pending_email_input
          - pending_email_validation
          - pending_user_migration
          - provisioning
          - provisioned
          - updating
          - error
      - name: after
        in: query
        description: Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
        example: '1579046400245'
        schema:
          type: string
      - name: selfActivated
        in: query
        description: Indicates if the subscriber was self activated, rather than provisioned via these APIs.
        example: 'false'
        schema:
          type: boolean
      - name: max
        in: query
        description: Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/basics).
        example: '10'
        schema:
          type: integer
          default: 50
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
              example:
                id: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
                userId: 95547321@sp.com
                spEnterpriseId: Reseller1+acme
                firstName: John
                lastName: Andersen
                email: john.anderson@acme.com
                primaryPhoneNumber: +1-240-555-1212
                mobilePhoneNumber: +1-818-279-1234
                extension: '1212'
                package: standard
                status: provisioning
                created: '2019-10-18T14:26:16.000Z'
                lastStatusChange: '2020-03-18T16:05:34.000Z'
                provisioningId: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
                selfActivated: 'false'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The 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.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The 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.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Provision a BroadWorks Subscriber
      operationId: Provision a BroadWorks Subscriber
      description: 'Provision a new BroadWorks subscriber for Webex services.


        This API lets a Service Provider map a BroadWorks subscriber to a new or existing Webex user and assign the required licenses and entitlements for Webex and Meetings.'
      tags:
      - BroadWorks Subscribers
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              provisioningId: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
              userId: 95547321@sp.com
              spEnterpriseId: Reseller1+acme
              firstName: John
              lastName: Andersen
              package: standard
              primaryPhoneNumber: +1-240-555-1212
              mobilePhoneNumber: +1-818-279-1234
              extension: '1212'
              email: john.anderson@acme.com
              language: en
              timezone: America/Los_Angeles
            schema:
              type: object
              required:
              - provisioningId
              - userId
              - spEnterpriseId
              - firstName
              - lastName
              - package
              properties:
                provisioningId:
                  type: string
                  example: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
                  description: 'This Provisioning ID defines how this subscriber is to be provisioned for Webex Services.


                    Each Customer Template will have their own unique Provisioning ID. This ID will be displayed under the chosen Customer Template

                    on Webex Partner Hub.'
                userId:
                  type: string
                  example: 95547321@sp.com
                  description: The user ID of the subscriber on BroadWorks.
                spEnterpriseId:
                  type: string
                  example: Reseller1+acme
                  description: The Service Provider supplied unique identifier for the subscriber's enterprise.
                firstName:
                  type: string
                  example: John
                  description: The first name of the subscriber.
                lastName:
                  type: string
                  example: Andersen
                  description: The last name of the subscriber.
                package:
                  type: string
                  enum:
                  - softphone
                  - basic
                  - standard
                  - premium
                  description: "The Webex for BroadWorks package to be assigned to the subscriber.\n * `softphone` - Softphone package\n * `basic` - Basic package\n * `standard` - Standard package\n * `premium` - Premium package\n"
                primaryPhoneNumber:
                  type: string
                  example: +1-240-555-1212
                  description: The primary phone number configured against the subscriber on BroadWorks.
                mobilePhoneNumber:
                  type: string
                  example: +1-818-279-1234
                  description: The mobile phone number configured against the subscriber on BroadWorks. Any empty value on update will remove the already configured mobile phone number.
                extension:
                  type: string
                  example: '1212'
                  description: The extension number configured against the subscriber on BroadWorks.
                email:
                  type: string
                  example: john.anderson@acme.com
                  description: The email address of the subscriber (mandatory for the trusted email provisioning flow).
                language:
                  type: string
                  example: en
                  description: The {ISO-639-1}_{ISO-3166} or {ISO-639-1} locale or language code used as preferred language for organization and Webex Meeting Sites. Refer to the [help page](https://www.cisco.com/content/en/us/td/docs/voice_ip_comm/cloudCollaboration/wx4bwks/Solution_Guide/wbxbw_b_solution-guide/wbxbw_b_SolutionGuide-PDF_chapter_01.html#Cisco_Reference.dita_f10351e1-f775-418d-a700-ec8487e0a33b) for more information.
                timezone:
                  type: string
                  example: America/Los_Angeles
                  description: 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.
  /broadworks/subscribers/{subscriberId}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
              example:
                id: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
                personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                userId: 95547321@sp.com
                spEnterpriseId: Reseller1+acme
                firstName: John
                lastName: Andersen
                email: john.anderson@acme.com
                primaryPhoneNumber: +1-240-555-1212
                mobilePhoneNumber: +1-818-279-1234
                extension: '1212'
                package: basic
                status: pending_email_input
                created: '2019-10-18T14:26:16.000Z'
                lastStatusChange: '2020-03-18T16:05:34.000Z'
                provisioningId: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
                selfActivated: 'false'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The 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.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The 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.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Get a BroadWorks Subscriber
      operationId: Get a BroadWorks Subscriber
      description: This API lets a Service Provider retrieve details of a provisioned BroadWorks subscriber on Webex.
      tags:
      - BroadWorks Subscribers
      parameters:
      - name: subscriberId
        in: path
        description: A unique identifier for the subscriber in question.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
        schema:
          type: string
    put:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriber'
              example:
                id: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
                personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                userId: 95547321@sp.com
                spEnterpriseId: Reseller1+acme
                firstName: John
                lastName: Andersen
                email: john.anderson@acme.com
                primaryPhoneNumber: +1-240-555-1212
                mobilePhoneNumber: +1-818-279-1234
                extension: '1212'
                package: premium
                status: updating
                created: '2019-10-18T14:26:16.000Z'
                lastStatusChange: '2020-03-18T16:05:34.000Z'
                provisioningId: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
                selfActivated: 'false'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The 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.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The 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.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Update a BroadWorks Subscriber
      operationId: Update a BroadWorks Subscriber
      description: "This API lets a Service Provider update certain details of a provisioned BroadWorks subscriber\non Webex.\n\n<div>\n        <Callout type='info'>The updated items will not be immediately reflected in the response body, but can be subsequently obtained via the [Get a BroadWorks Subscriber](/docs/api/v1/broadworks-subscribers/get-a-broadworks-subscriber) API once the status has transitioned from the updating state to the provisioned state.</Callout>\n</div>"
      tags:
      - BroadWorks Subscribers
      parameters:
      - name: subscriberId
        in: path
        description: A unique identifier for the subscriber in question.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              userId: 95547321@sp.com
              firstName: John
              lastName: Andersen
              primaryPhoneNumber: +1-240-555-1212
              mobilePhoneNumber: +1-818-279-1234
              extension: '1212'
              timezone: America/Los_Angeles
              package: premium
            schema:
              type: object
              properties:
                userId:
                  type: string
                  example: 95547321@sp.com
                  description: The user ID of the subscriber on BroadWorks.
                firstName:
                  type: string
                  example: John
                  description: The first name of the subscriber.
                lastName:
                  type: string
                  example: Andersen
                  description: The last name of the subscriber.
                primaryPhoneNumber:
                  type: string
                  example: +1-240-555-1212
                  description: The primary phone number configured against the subscriber on BroadWorks. Any empty value on update will remove the already configured primary phone number if an extension is set. The user must have either a primary phone number or an extension configured.
                mobilePhoneNumber:
                  type: string
                  example: +1-818-279-1234
                  description: The mobile phone number configured against the subscriber on BroadWorks. Any empty value on update will remove the already configured mobile phone number.
                extension:
                  type: string
                  example: '1212'
                  description: The extension number configured against the subscriber on BroadWorks. Any empty value on update will remove the already configured extension if a primary phone number is set. The user must have either a primary phone number or an extension configured.
                timezone:
                  type: string
                  example: America/Los_Angeles
                  description: 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.
                package:
                  type: string
                  example: premium
                  description: The Webex for BroadWorks Package to be assigned to the subscriber.
    delete:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The 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.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The 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.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Remove a BroadWorks Subscriber
      operationId: Remove a BroadWorks Subscriber
      description: This API will allow a Service Provider to remove the mapping between a BroadWorks Subscriber and Webex user.
      tags:
      - BroadWorks Subscribers
      parameters:
      - name: subscriberId
        in: path
        description: A unique identifier for the subscriber in question.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
        schema:
          type: string
  /broadworks/subscribers/validate:
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberProvisioningPrecheckResponse'
              example:
                message: success
                info:
                - infoCode: 100
                  description: Provisioning preCheck validation successful.
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The 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.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The 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.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Precheck a Broadworks Subscriber Provisioning
      operationId: Precheck a Broadworks Subscriber Provisioning
      description: 'Verify the likely success of provisioning a broadworks subscriber.


        <div>

        <Callout type=''info''>

        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](/docs/api/guides/webex-for-broadworks-developers-guide#using-the-precheck-provisioning-api) section in [Webex for BroadWorks](/docs/api/guides/webex-for-broadworks-developers-guide) guide for more information.

        </Callout>

        </div>'
      tags:
      - BroadWorks Subscribers
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              provisioningId: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
              userId: 95547321@example.com
              spEnterpriseId: Reseller1+example
              firstName: John
              lastName: Andersen
              email: john.anderson@example.com
              primaryPhoneNumber: +1-240-555-1212
              language: en
              package: standard
              customerInfo:
                primaryEmail: alice.anderson@example.com
            schema:
              type: object
              required:
              - email
              properties:
                provisioningId:
                  type: string
                  example: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
                  description: Provisioning ID that defines how this subscriber is to be provisioned for Cisco Webex Services. Each Customer Template has its unique Provisioning ID. This ID will be displayed under the chosen Customer Template on Cisco Webex Control Hub.
                userId:
                  type: string
                  example: 95547321@example.com
                  description: The user ID of the Broadworks subscriber.
                spEnterpriseId:
                  type: string
                  example: Reseller1+example
                  description: The Service Provider supplied unique identifier for the subscriber's enterprise.
                firstName:
                  type: string
                  example: John
                  description: The first name of the subscriber.
                lastName:
                  type: string
                  example: Andersen
                  description: The last name of the subscriber.
                package:
                  type: string
                  enum:
                  - softphone
                  - basic
                  - standard
                  - premium
                  description: "The Webex for BroadWorks package to be assigned to the subscriber.\n * `softphone` - Softphone package.\n * `basic` - Basic package.\n * `standard` - Standard package.\n * `premium` - Premium package.\n"
                primaryPhoneNumber:
                  type: string
                  example: +1-240-555-1212
                  description: The primary phone number configured for the subscriber on BroadWorks.
                mobilePhoneNumber:
                  type: string
                  example: +1-818-279-1234
                  description: The mobile phone number configured against the subscriber on BroadWorks.
                extension:
                  type: string
                  example: '1212'
                  description: The extension number configured against the subscriber on BroadWorks.
                email:
                  type: string
                  example: john.anderson@example.com
                  description: The email address of the subscriber.
                language:
                  type: string
                  example: en
                  description: 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:
                  type: string
                  example: America/Los_Angeles
                  description: 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.
                customerInfo:
                  type: object
                  required:
                  - primaryEmail
                  properties:
                    primaryEmail:
                      type: string
                      example: '"john.anderson@example.com"'
                      description: The Customer's primary email address.
                  description: The information of the customer into which the subscriber is provisioned. If you are including this parameter, you must include the `primaryEmail` of the customer.
  /subscribers/{subscriberId}/emails/consentMove:
    post:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The 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.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The 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.'
        '429':
          description: 'Too Many Requests: Too 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.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Send Consent User Move Email to Pending Broadworks Subscribers
      operationId: Send Consent User Move Email to Pending Broadworks Subscribers
      description: Allows a Service Provider to send the user consent move email to a subscriber who is currently in `pending_user_migration` state.
      tags:
      - BroadWorks Subscribers
      parameters:
      - name: subscriberId
        in: path
        description: A unique identifier for the subscriber in question.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
        schema:
          type: string
components:
  schemas:
    SubscriberProvisioningPrecheckResponse:
      type: object
      properties:
        message:
          type: string
          example: success
          description: A textual representation of the Precheck response message containing the `infoCode` object in the case of a success response and the `errorCode` object in the case of failure.
        info:
          type: object
          properties:
            infoCode:
              type: number
              example: 100
              description: Provisioning Precheck `infoCode`.
            description:
              type: string
              example: Provisioning Precheck validation successful.
              description: A textual description of the `infoCode`.
          description: A list of `ProvisioningPreCheckResponseInfo` objects.
    Subscriber:
      type: object
      properties:
        id:
          type: string
          example: '''Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk'''
          description: A unique Cisco identifier for the subscriber.
        personId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
          description: The Person Id of the subscriber on Webex. To be used when referencing this subscriber on other Webex APIs. Only presented when status is `provisioned`.
        userId:
          type: string
          example: 95547321@sp.com
          description: The user ID of the subscriber on BroadWorks.
        spEnterpriseId:
          type: string
          example: Reseller1+acme
          description: The Service Provider supplied unique identifier for the subscriber's enterprise.
        firstName:
          type: string
          example: John
          description: The first name of the subscriber.
        lastName:
          type: string
          example: Andersen
          description: The last name of the subscriber.
        email:
          type: string
          example: john.anderson@acme.com
          description: The email address of the subscriber.
        primaryPhoneNumber:
          type: string
          example: +1-240-555-1212
          description: The primary phone number configured against the subscriber on BroadWorks.
        mobilePhoneNumber:
          type: string
          example: +1-818-279-1234
          description: The mobile phone number configured against the subscriber on BroadWorks.
        extension:
          type: string
          example: '1212'
          description: The extension number configured against the subscriber on BroadWorks.
        package:
          type: string
          enum:
          - softphone
          - basic
          - standard
          - premium
          description: "The Webex for BroadWorks Package assigned to the subscriber.\n * `softphone` - Softphone package.\n * `basic` - Basic package.\n * `standard` - Standard package.\n * `premium` - Premium package.\n"
        status:
          type: string
          enum:
          - pending_email_input
          - pending_email_validation
          - pending_user_migration
          - provisioning
          - provisioned
          - updating
          - error
          description: "The provisioning status of the user.\n * `pending_email_input` - Subscriber Provisioning is paused, pending input of email address.\n * `pending_email_validation` - Subscriber Provisioning is paused. The subscriber has entered an email address but has yet to complete validation.\n * `pending_user_migration` - Subscriber Provisioning is paused. An automated email is sent to the subscriber, waiting for the subscriber's consent.\n * `provisioning` - Subscriber provisioning is in progress.\n * `provisioned` - The subscriber is fully provisioned on Webex.\n * `updating` - An update is in progress for a provisioned subscriber.\n * `error` - An error occurred provisioning the subscriber on Webex.\n"
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: "List of errors that occurred during that last attempt to provision/update this subscriber.\n\n *Note:*\n\n+ This list captures errors that occurred during *asynchronous or background* provisioning of the subscriber, *after* the API has been accepted and 200 OK response returned.\n\n+ Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code."
        created:
          type: string
          example: '2019-10-18T14:26:16.000Z'
          description: The date and time the subscriber was provisioned.
        lastStatusChange:
          type: string
          example: '2020-03-18T16:05:34.000Z'
          description: The date and time the provisioning status of the subscriber last changed.
        provisioningId:
          type: string
          example: ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ
          description: This Provisioning ID associated with this subscriber.
        selfActivated:
          type: boolean
          description: Indicates if the subscriber was self activated, rather than provisioned via these APIs.
    Error:
      type: object
      properties:
        errorCode:
          type: number
          example: 10022
          description: An error code that identifies the reason for the error.
        description:
          type: string
          example: The BroadWorks UserID is already associated with an existing user.
          description: A description of the error.
    SubscriberListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Subscriber'
          description: An array of Subscriber objects.
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps