ListVirtualLineObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListVirtualLineObject",
  "title": "ListVirtualLineObject",
  "type": "object",
  "required": [
    "id",
    "lastName",
    "firstName",
    "externalCallerIdNamePolicy",
    "number",
    "location",
    "numberOfDevicesAssigned"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9iMTJhNTBiMi01N2NiLTQ0MzktYjc1MS1jZDQ4M2I4MjhmNmU=",
      "description": "A unique identifier for the virtual line."
    },
    "lastName": {
      "type": "string",
      "example": "Shen",
      "description": "Last name for virtual line."
    },
    "firstName": {
      "type": "string",
      "example": "Tom",
      "description": "First name for virtual line."
    },
    "callerIdLastName": {
      "type": "string",
      "example": "Shen",
      "description": "`callerIdLastName` for virtual line."
    },
    "callerIdFirstName": {
      "type": "string",
      "example": "Tom",
      "description": "`callerIdFirstName` for virtual line."
    },
    "callerIdNumber": {
      "type": "string",
      "example": "+15558675313",
      "description": "`callerIdNumber` for virtual line."
    },
    "externalCallerIdNamePolicy": {
      "type": "string",
      "enum": [
        "DIRECT_LINE",
        "LOCATION",
        "OTHER"
      ],
      "description": "`externalCallerIdNamePolicy` for the virtual line.\n * `DIRECT_LINE` - Shows virtual lines Caller ID name.\n * `LOCATION` - Shows virtual lines location name.\n * `OTHER` - Allow virtual lines first/last name to be configured.\n"
    },
    "customExternalCallerIdName": {
      "type": "string",
      "example": "Tom",
      "description": "`customExternalCallerIdName` for virtual line."
    },
    "number": {
      "type": "object",
      "required": [
        "primary"
      ],
      "properties": {
        "external": {
          "type": "string",
          "example": "+15558675313",
          "description": "Virtual Line external.  Either `external` or `extension` is mandatory."
        },
        "extension": {
          "type": "string",
          "example": "6101",
          "description": "Virtual Line extension.  Either `external` or `extension` is mandatory."
        },
        "routingPrefix": {
          "type": "string",
          "example": "1234",
          "description": "Routing prefix of location."
        },
        "esn": {
          "type": "string",
          "example": "12346101",
          "description": "Routing prefix + extension of a person or workspace."
        },
        "primary": {
          "type": "boolean",
          "example": true,
          "description": "Number is Primary or Alternative Number."
        }
      },
      "description": "Calling details of virtual line."
    },
    "location": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg2LWVhMzMtNDc2Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
          "description": "ID of location associated with virtual line."
        },
        "name": {
          "type": "string",
          "example": "Denver",
          "description": "Name of location associated with virtual line."
        }
      },
      "description": "Location details of virtual line."
    },
    "numberOfDevicesAssigned": {
      "type": "number",
      "example": 1,
      "description": "Number of devices assigned to a virtual line."
    },
    "billingPlan": {
      "type": "string",
      "example": "BCOCP1",
      "description": "Type of billing plan."
    }
  }
}