Sip Endpoint

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cm-com/main/json-schema/cm-com-api-sip-endpoint-schema.json",
  "title": "Sip Endpoint",
  "description": "SIP Endpoint that represents a device that can make or receive VOIP phone calls.",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cm-com-voice-sip-accounts-v1-openapi.yml#/components/schemas/ApiSipEndpoint",
  "type": "object",
  "properties": {
    "guid": {
      "type": [
        "string",
        "null"
      ],
      "description": "Unique identifier of the SIP Endpoint."
    },
    "createdOn": {
      "type": "string",
      "description": "Date and time on which the SIP Endpoint was created.",
      "format": "date-time"
    },
    "hostname": {
      "type": [
        "string",
        "null"
      ],
      "description": "Hostname of the SIP Endpoint, when given, the IP address should be left blank."
    },
    "ipAddress": {
      "type": [
        "string",
        "null"
      ],
      "description": "External IP address of the SIP Endpoint, when given, the hostname should be left blank."
    },
    "port": {
      "type": "integer",
      "description": "Port number of the SIP Endpoint, when set to 0 any port number will be used.",
      "format": "int32"
    },
    "subnetMask": {
      "type": "integer",
      "description": "Subnet mask of the SIP Endpoint.",
      "format": "int32"
    },
    "isTrusted": {
      "type": "boolean",
      "description": "Whether authentication is required for the SIP endpoints to use the SIP Account or not. It is not recommended to set this to true."
    }
  },
  "additionalProperties": false
}