Webex · Schema

PhoneNumber

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
primary boolean If `true` marks the phone number as primary.
action object Either 'ADD' to add phone numbers or 'DELETE' to remove phone numbers.
directNumber string Phone numbers that are assigned.
extension string Extension that is assigned.
ringPattern object Ring Pattern of this number.
View JSON Schema on GitHub

JSON Schema

webex-phonenumber-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PhoneNumber",
  "title": "PhoneNumber",
  "type": "object",
  "required": [
    "primary",
    "action",
    "directNumber"
  ],
  "properties": {
    "primary": {
      "type": "boolean",
      "example": true,
      "description": "If `true` marks the phone number as primary."
    },
    "action": {
      "$ref": "#/components/schemas/Action",
      "description": "Either 'ADD' to add phone numbers or 'DELETE' to remove phone numbers."
    },
    "directNumber": {
      "type": "string",
      "example": "+12145553567",
      "description": "Phone numbers that are assigned."
    },
    "extension": {
      "type": "string",
      "example": "1234",
      "description": "Extension that is assigned."
    },
    "ringPattern": {
      "$ref": "#/components/schemas/RingPattern",
      "description": "Ring Pattern of this number."
    }
  }
}