Webex · Schema

DncEntryRequest

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
phoneNumber	string	The phone number to add to the DNC list. Must be in E.164 format (e.g., +1234567890).
source	string	The source or origin of the DNC entry. This helps track where the request originated from.
reason	string	Optional reason for adding the phone number to the DNC list. This can help with compliance documentation.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DncEntryRequest",
  "title": "DncEntryRequest",
  "type": "object",
  "required": [
    "phoneNumber",
    "source"
  ],
  "properties": {
    "phoneNumber": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{1,14}$",
      "description": "The phone number to add to the DNC list. Must be in E.164 format (e.g., +1234567890).",
      "example": "+1234567890"
    },
    "source": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "The source or origin of the DNC entry. This helps track where the request originated from.",
      "example": "customer-request"
    },
    "reason": {
      "type": "string",
      "maxLength": 500,
      "description": "Optional reason for adding the phone number to the DNC list. This can help with compliance documentation.",
      "example": "Customer requested to be removed from all marketing calls"
    }
  },
  "example": {
    "phoneNumber": "+1234567890",
    "source": "customer-request",
    "reason": "Customer opted out via email"
  }
}