Webex · Schema

SipAddressObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
value string The `sipAddress` value.
type string `sipAddress` type.
display string A human-readable description, primarily used for display purposes.
primary boolean Designate the primary `sipAddress`.
View JSON Schema on GitHub

JSON Schema

webex-sipaddressobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SipAddressObject",
  "title": "SipAddressObject",
  "type": "object",
  "required": [
    "value"
  ],
  "properties": {
    "value": {
      "type": "string",
      "example": "sipAddress value1",
      "description": "The `sipAddress` value."
    },
    "type": {
      "type": "string",
      "enum": [
        "enterprise"
      ],
      "description": "`sipAddress` type."
    },
    "display": {
      "type": "string",
      "example": "sipAddress1 description",
      "description": "A human-readable description, primarily used for display purposes."
    },
    "primary": {
      "type": "boolean",
      "example": true,
      "description": "Designate the primary `sipAddress`."
    }
  }
}