Webex · Schema

PersonECBNAvailableNumberObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
phoneNumber	string	A unique identifier for the phone number.
state	object	Phone number's state.
isMainNumber	boolean	If `true`, the phone number is used as a location CLID.
tollFreeNumber	boolean	If `true`, the phone number is a toll-free number.
telephonyType	object	The telephony type for the number.
isServiceNumber	boolean	If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free.
owner	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PersonECBNAvailableNumberObject",
  "title": "PersonECBNAvailableNumberObject",
  "type": "object",
  "required": [
    "phoneNumber",
    "state",
    "isMainNumber",
    "tollFreeNumber",
    "telephonyType",
    "isServiceNumber"
  ],
  "properties": {
    "phoneNumber": {
      "type": "string",
      "example": "+12056350001",
      "description": "A unique identifier for the phone number."
    },
    "state": {
      "$ref": "#/components/schemas/STATE",
      "description": "Phone number's state."
    },
    "isMainNumber": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, the phone number is used as a location CLID."
    },
    "tollFreeNumber": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, the phone number is a toll-free number."
    },
    "telephonyType": {
      "$ref": "#/components/schemas/TelephonyType",
      "description": "The telephony type for the number."
    },
    "isServiceNumber": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free."
    },
    "owner": {
      "type": "object",
      "required": [
        "id",
        "type"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
          "description": "Unique identifier of the owner to which phone number is assigned."
        },
        "type": {
          "type": "string",
          "enum": [
            "PLACE",
            "PEOPLE",
            "VIRTUAL_LINE",
            "HUNT_GROUP"
          ],
          "description": "Type of the PSTN phone number's owner.\n * `PLACE` - Phone number's owner is a workspace.\n * `PEOPLE` - Phone number's owner is a person.\n * `VIRTUAL_LINE` - Phone number's owner is a Virtual Line.\n * `HUNT_GROUP` - Phone number's owner is a Hunt Group.\n"
        },
        "firstName": {
          "type": "string",
          "example": "Test",
          "description": "First name of the phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`."
        },
        "lastName": {
          "type": "string",
          "example": "Person",
          "description": "Last name of the phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`."
        },
        "displayName": {
          "type": "string",
          "example": "TestWorkSpace",
          "description": "Display name of the phone number's owner. This field will be present only when the owner `type` is `PLACE` or `HUNT_GROUP`."
        }
      }
    }
  }
}