Subscriber

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Subscriber",
  "title": "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": "[email protected]",
      "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": "[email protected]",
      "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."
    }
  }
}