{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Broadworks Calling",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "BroadWorks Billing Reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List BroadWorks Billing Reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/broadworks/billing/reports",
            "params": [
              {
                "name": "before",
                "value": "2020-03",
                "type": "query",
                "description": "Only include billing reports created before this date."
              },
              {
                "name": "after",
                "value": "2019-12",
                "type": "query",
                "description": "Only include billing reports created after this date."
              },
              {
                "name": "sortBy",
                "value": "billingPeriod",
                "type": "query",
                "description": "Sort the reports.\n\n+ Members:\n    + id\n    + status\n    + billingPeriod"
              }
            ]
          },
          "docs": "Search for reports. There are a number of filter options which can be combined in a single request."
        },
        {
          "info": {
            "name": "Create a BroadWorks Billing Report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/broadworks/billing/reports",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate a monthly reconciliation report.\n\n<div>\n<Callout type='info'>\nPartners who have moved to extended wholesale subscription model should generate reports via [Wholesale Billing Reports](/docs/api/v1/wholesale-billing).\n</Callout>\n</div>"
        },
        {
          "info": {
            "name": "Get a BroadWorks Billing Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/broadworks/billing/reports/:id",
            "params": [
              {
                "name": "id",
                "value": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
                "type": "path",
                "description": "A unique identifier for the report in request."
              }
            ]
          },
          "docs": "Retrieve a specific billing reconciliation report."
        },
        {
          "info": {
            "name": "Delete a BroadWorks Billing Report",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/broadworks/billing/reports/:id",
            "params": [
              {
                "name": "id",
                "value": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
                "type": "path",
                "description": "A unique report ID that corresponds to a billing report."
              }
            ]
          },
          "docs": "Delete a monthly reconciliation report using a report ID."
        }
      ]
    },
    {
      "info": {
        "name": "BroadWorks Enterprises",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List BroadWorks Enterprises",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/broadworks/enterprises",
            "params": [
              {
                "name": "spEnterpriseId",
                "value": "Reseller1+acme",
                "type": "query",
                "description": "The Service Provider supplied unique identifier for the subscriber's enterprise."
              },
              {
                "name": "startsWith",
                "value": "Res",
                "type": "query",
                "description": "The starting string of the enterprise identifiers to match against."
              },
              {
                "name": "max",
                "value": "10",
                "type": "query",
                "description": "Limit the number of enterprises returned in the search, up to 1000."
              }
            ]
          },
          "docs": "List the provisioned enterprises for a Service Provider. This API also lets a Service Provider search for their provisioned enterprises on Webex. A search on enterprises can be performed by either a full or partial enterprise identifier."
        },
        {
          "info": {
            "name": "Get Directory Sync Status for an Enterprise",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/broadworks/enterprises/:id/broadworksDirectorySync",
            "params": [
              {
                "name": "id",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the enterprise in question."
              }
            ]
          },
          "docs": "This API lets a Partner Admin get the most recent directory sync status for a customer's Broadworks enterprise on Webex."
        },
        {
          "info": {
            "name": "Trigger Directory Sync for an Enterprise",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/broadworks/enterprises/:id/broadworksDirectorySync",
            "params": [
              {
                "name": "id",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the enterprise in question."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API lets a Partner Admin trigger a directory sync for the customer's Broadworks enterprise on Webex."
        },
        {
          "info": {
            "name": "Update Directory Sync for a BroadWorks Enterprise",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/broadworks/enterprises/:id/broadworksDirectorySync",
            "params": [
              {
                "name": "id",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the enterprise in question."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API lets a Partner Admin enable or disable directory sync for the customer's Broadworks enterprise on Webex."
        },
        {
          "info": {
            "name": "Trigger Directory Sync for a User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/broadworks/enterprises/:id/broadworksDirectorySync/externalUser",
            "params": [
              {
                "name": "id",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the enterprise in question."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API lets a Partner Admin trigger a directory sync for an external user (real or virtual user) on Broadworks enterprise with Webex."
        }
      ]
    },
    {
      "info": {
        "name": "BroadWorks Subscribers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List BroadWorks Subscribers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/broadworks/subscribers",
            "params": [
              {
                "name": "userId",
                "value": "95547321@sp.com",
                "type": "query",
                "description": "The user ID of the subscriber on BroadWorks."
              },
              {
                "name": "personId",
                "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
                "type": "query",
                "description": "The Person ID of the Webex subscriber."
              },
              {
                "name": "email",
                "value": "john.anderson@acme.com",
                "type": "query",
                "description": "The email address of the subscriber."
              },
              {
                "name": "provisioningId",
                "value": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
                "type": "query",
                "description": "The Provisioning ID associated with this subscriber."
              },
              {
                "name": "spEnterpriseId",
                "value": "SP1+Acme",
                "type": "query",
                "description": "The Service Provider supplied unique identifier for the subscriber's enterprise."
              },
              {
                "name": "lastStatusChange",
                "value": "1579046400245",
                "type": "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."
              },
              {
                "name": "status",
                "value": "pending_email_input",
                "type": "query",
                "description": "The provisioning status of the subscriber. This Parameter supports multiple comma separated values. For example : status=error,provisioned,provisioning."
              },
              {
                "name": "after",
                "value": "1579046400245",
                "type": "query",
                "description": "Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted."
              },
              {
                "name": "selfActivated",
                "value": "false",
                "type": "query",
                "description": "Indicates if the subscriber was self activated, rather than provisioned via these APIs."
              },
              {
                "name": "max",
                "value": "10",
                "type": "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)."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Provision a BroadWorks Subscriber",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/broadworks/subscribers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Provision a new BroadWorks subscriber for Webex services.\n\nThis 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."
        },
        {
          "info": {
            "name": "Get a BroadWorks Subscriber",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/broadworks/subscribers/:subscriberId",
            "params": [
              {
                "name": "subscriberId",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the subscriber in question."
              }
            ]
          },
          "docs": "This API lets a Service Provider retrieve details of a provisioned BroadWorks subscriber on Webex."
        },
        {
          "info": {
            "name": "Update a BroadWorks Subscriber",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/broadworks/subscribers/:subscriberId",
            "params": [
              {
                "name": "subscriberId",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the subscriber in question."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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>"
        },
        {
          "info": {
            "name": "Remove a BroadWorks Subscriber",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/broadworks/subscribers/:subscriberId",
            "params": [
              {
                "name": "subscriberId",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the subscriber in question."
              }
            ]
          },
          "docs": "This API will allow a Service Provider to remove the mapping between a BroadWorks Subscriber and Webex user."
        },
        {
          "info": {
            "name": "Precheck a Broadworks Subscriber Provisioning",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/broadworks/subscribers/validate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verify the likely success of provisioning a broadworks subscriber.\n\n<div>\n<Callout type='info'>\nThe 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]("
        },
        {
          "info": {
            "name": "Send Consent User Move Email to Pending Broadworks Subscribers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/subscribers/:subscriberId/emails/consentMove",
            "params": [
              {
                "name": "subscriberId",
                "value": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
                "type": "path",
                "description": "A unique identifier for the subscriber in question."
              }
            ]
          },
          "docs": "Allows a Service Provider to send the user consent move email to a subscriber who is currently in `pending_user_migration` state."
        }
      ]
    },
    {
      "info": {
        "name": "BroadWorks Workspaces",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Provision a BroadWorks Workspace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/broadworks/workspaces",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Provision a new BroadWorks workspace for Cisco Webex services.\n\nThis API allows a Service Provider to provision a workspace for an existing customer."
        },
        {
          "info": {
            "name": "Update a Broadworks Workspace",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/broadworks/workspaces/:workspaceId",
            "params": [
              {
                "name": "workspaceId",
                "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2RkMjJlZGZlLTlmZWYtNDdmOS05ODFkLWYxYjA3MWFmMDcwYw",
                "type": "path",
                "description": "A unique Cisco identifier for the workspace."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update certain details of a provisioned BroadWorks workspace on Cisco Webex."
        },
        {
          "info": {
            "name": "Remove a BroadWorks Workspace",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/broadworks/workspaces/:workspaceId",
            "params": [
              {
                "name": "workspaceId",
                "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2RkMjJlZGZlLTlmZWYtNDdmOS05ODFkLWYxYjA3MWFmMDcwYw",
                "type": "path",
                "description": "A unique Cisco identifier for the workspace."
              }
            ]
          },
          "docs": "Remove the mapping between a BroadWorks workspace and Cisco Webex device."
        }
      ]
    }
  ],
  "bundled": true
}