GetNumbers

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetNumbers",
  "title": "GetNumbers",
  "type": "object",
  "required": [
    "phoneNumbers"
  ],
  "properties": {
    "distinctiveRingEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable/disable a distinctive ring pattern that identifies calls coming from a specific phone number."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "primary": {
            "type": "boolean",
            "example": true,
            "description": "Flag to indicate if the number is primary or not."
          },
          "directNumber": {
            "type": "string",
            "example": "2143456789",
            "description": "Phone number."
          },
          "extension": {
            "type": "string",
            "example": "1234",
            "description": "Extension."
          },
          "routingPrefix": {
            "type": "string",
            "example": "1234",
            "description": "Routing prefix of location."
          },
          "esn": {
            "type": "string",
            "example": "12341234",
            "description": "Routing prefix + extension of a person or workspace."
          },
          "ringPattern": {
            "type": "string",
            "enum": [
              "NORMAL",
              "LONG_LONG",
              "SHORT_SHORT_LONG",
              "SHORT_LONG_SHORT"
            ],
            "description": "Optional ring pattern. Applicable only for alternate numbers.\n * `NORMAL` - Normal incoming ring pattern.\n * `LONG_LONG` - Incoming ring pattern of two long rings.\n * `SHORT_SHORT_LONG` - Incoming ring pattern of two short rings, followed by a long ring.\n * `SHORT_LONG_SHORT` - Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.\n"
          }
        }
      },
      "description": "Information about the number."
    }
  }
}