Webex · Schema

PhoneNumberObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
value	string	phone number.
type	string	We support the following phone number types: 'mobile', 'work', 'fax', 'work_extension', 'alternate1', 'alternate2'. Alternate 1 and Alternate 2 are types inherited from Webex meeting sites.
display	string	A human-readable name, primarily used for display purposes.
primary	boolean	A Boolean value for phone number's primary status.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PhoneNumberObject",
  "title": "PhoneNumberObject",
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "example": "400 123 1234",
      "description": "phone number."
    },
    "type": {
      "type": "string",
      "enum": [
        "work",
        "home",
        "mobile",
        "work_extension",
        "fax",
        "pager",
        "other"
      ],
      "description": "We support the following phone number types: 'mobile', 'work', 'fax', 'work_extension', 'alternate1', 'alternate2'.  Alternate 1 and Alternate 2 are types inherited from Webex meeting sites."
    },
    "display": {
      "type": "string",
      "example": "work phone number",
      "description": "A human-readable name, primarily used for display purposes."
    },
    "primary": {
      "type": "boolean",
      "example": true,
      "description": "A Boolean value for phone number's primary status."
    }
  }
}