Webex Broadworks Calling — BroadWorks Subscribers

naftiko: 1.0.0-alpha2
info:
  label: Webex Broadworks Calling — BroadWorks Subscribers
  description: 'Webex Broadworks Calling — BroadWorks Subscribers. 7 operations. Lead operation: List BroadWorks Subscribers.
    Self-contained Naftiko capability covering one Webex business surface.'
  tags:
  - Webex
  - BroadWorks Subscribers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBEX_API_KEY: WEBEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: broadworks-broadworks-subscribers
    baseUri: ''
    description: Webex Broadworks Calling — BroadWorks Subscribers business capability. Self-contained, no shared references.
    resources:
    - name: broadworks-subscribers
      path: /broadworks/subscribers
      operations:
      - name: listbroadworkssubscribers
        method: GET
        description: List BroadWorks Subscribers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: query
          type: string
          description: The user ID of the subscriber on BroadWorks.
        - name: personId
          in: query
          type: string
          description: The Person ID of the Webex subscriber.
        - name: email
          in: query
          type: string
          description: The email address of the subscriber.
        - name: provisioningId
          in: query
          type: string
          description: The Provisioning ID associated with this subscriber.
        - name: spEnterpriseId
          in: query
          type: string
          description: The Service Provider supplied unique identifier for the subscriber's enterprise.
        - name: lastStatusChange
          in: query
          type: string
          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 accep
        - name: status
          in: query
          type: string
          description: 'The provisioning status of the subscriber. This Parameter supports multiple comma separated values.
            For example : status=error,provisioned,provisioning.'
        - name: after
          in: query
          type: string
          description: Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred,
            but ISO 8601 date format also accepted.
        - name: selfActivated
          in: query
          type: boolean
          description: Indicates if the subscriber was self activated, rather than provisioned via these APIs.
        - name: max
          in: query
          type: integer
          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 [Webe
      - name: provisionabroadworkssubscriber
        method: POST
        description: Provision a BroadWorks Subscriber
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: broadworks-subscribers-validate
      path: /broadworks/subscribers/validate
      operations:
      - name: precheckabroadworkssubscriberprovisioning
        method: POST
        description: Precheck a Broadworks Subscriber Provisioning
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: broadworks-subscribers-subscriberId
      path: /broadworks/subscribers/{subscriberId}
      operations:
      - name: getabroadworkssubscriber
        method: GET
        description: Get a BroadWorks Subscriber
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriberId
          in: path
          type: string
          description: A unique identifier for the subscriber in question.
          required: true
      - name: updateabroadworkssubscriber
        method: PUT
        description: Update a BroadWorks Subscriber
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriberId
          in: path
          type: string
          description: A unique identifier for the subscriber in question.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: removeabroadworkssubscriber
        method: DELETE
        description: Remove a BroadWorks Subscriber
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriberId
          in: path
          type: string
          description: A unique identifier for the subscriber in question.
          required: true
    - name: subscribers-subscriberId-emails-consentMove
      path: /subscribers/{subscriberId}/emails/consentMove
      operations:
      - name: sendconsentusermoveemailtopendingbroadworkssubscribers
        method: POST
        description: Send Consent User Move Email to Pending Broadworks Subscribers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriberId
          in: path
          type: string
          description: A unique identifier for the subscriber in question.
          required: true
    authentication:
      type: bearer
      token: '{{env.WEBEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: broadworks-broadworks-subscribers-rest
    port: 8080
    description: REST adapter for Webex Broadworks Calling — BroadWorks Subscribers. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/broadworks/subscribers
      name: broadworks-subscribers
      description: REST surface for broadworks-subscribers.
      operations:
      - method: GET
        name: listbroadworkssubscribers
        description: List BroadWorks Subscribers
        call: broadworks-broadworks-subscribers.listbroadworkssubscribers
        with:
          userId: rest.userId
          personId: rest.personId
          email: rest.email
          provisioningId: rest.provisioningId
          spEnterpriseId: rest.spEnterpriseId
          lastStatusChange: rest.lastStatusChange
          status: rest.status
          after: rest.after
          selfActivated: rest.selfActivated
          max: rest.max
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: provisionabroadworkssubscriber
        description: Provision a BroadWorks Subscriber
        call: broadworks-broadworks-subscribers.provisionabroadworkssubscriber
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/broadworks/subscribers/validate
      name: broadworks-subscribers-validate
      description: REST surface for broadworks-subscribers-validate.
      operations:
      - method: POST
        name: precheckabroadworkssubscriberprovisioning
        description: Precheck a Broadworks Subscriber Provisioning
        call: broadworks-broadworks-subscribers.precheckabroadworkssubscriberprovisioning
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/broadworks/subscribers/{subscriberid}
      name: broadworks-subscribers-subscriberid
      description: REST surface for broadworks-subscribers-subscriberId.
      operations:
      - method: GET
        name: getabroadworkssubscriber
        description: Get a BroadWorks Subscriber
        call: broadworks-broadworks-subscribers.getabroadworkssubscriber
        with:
          subscriberId: rest.subscriberId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateabroadworkssubscriber
        description: Update a BroadWorks Subscriber
        call: broadworks-broadworks-subscribers.updateabroadworkssubscriber
        with:
          subscriberId: rest.subscriberId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removeabroadworkssubscriber
        description: Remove a BroadWorks Subscriber
        call: broadworks-broadworks-subscribers.removeabroadworkssubscriber
        with:
          subscriberId: rest.subscriberId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscribers/{subscriberid}/emails/consentmove
      name: subscribers-subscriberid-emails-consentmove
      description: REST surface for subscribers-subscriberId-emails-consentMove.
      operations:
      - method: POST
        name: sendconsentusermoveemailtopendingbroadworkssubscribers
        description: Send Consent User Move Email to Pending Broadworks Subscribers
        call: broadworks-broadworks-subscribers.sendconsentusermoveemailtopendingbroadworkssubscribers
        with:
          subscriberId: rest.subscriberId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: broadworks-broadworks-subscribers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Webex Broadworks Calling — BroadWorks Subscribers. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-broadworks-subscribers
      description: List BroadWorks Subscribers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: broadworks-broadworks-subscribers.listbroadworkssubscribers
      with:
        userId: tools.userId
        personId: tools.personId
        email: tools.email
        provisioningId: tools.provisioningId
        spEnterpriseId: tools.spEnterpriseId
        lastStatusChange: tools.lastStatusChange
        status: tools.status
        after: tools.after
        selfActivated: tools.selfActivated
        max: tools.max
      outputParameters:
      - type: object
        mapping: $.
    - name: provision-broadworks-subscriber
      description: Provision a BroadWorks Subscriber
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: broadworks-broadworks-subscribers.provisionabroadworkssubscriber
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: precheck-broadworks-subscriber-provisioning
      description: Precheck a Broadworks Subscriber Provisioning
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: broadworks-broadworks-subscribers.precheckabroadworkssubscriberprovisioning
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-broadworks-subscriber
      description: Get a BroadWorks Subscriber
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: broadworks-broadworks-subscribers.getabroadworkssubscriber
      with:
        subscriberId: tools.subscriberId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-broadworks-subscriber
      description: Update a BroadWorks Subscriber
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: broadworks-broadworks-subscribers.updateabroadworkssubscriber
      with:
        subscriberId: tools.subscriberId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-broadworks-subscriber
      description: Remove a BroadWorks Subscriber
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: broadworks-broadworks-subscribers.removeabroadworkssubscriber
      with:
        subscriberId: tools.subscriberId
      outputParameters:
      - type: object
        mapping: $.
    - name: send-consent-user-move-email
      description: Send Consent User Move Email to Pending Broadworks Subscribers
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: broadworks-broadworks-subscribers.sendconsentusermoveemailtopendingbroadworkssubscribers
      with:
        subscriberId: tools.subscriberId
      outputParameters:
      - type: object
        mapping: $.