Webex · Schema

DncEntryResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
phoneNumber	string	The phone number in the DNC list, in E.164 format.
source	string	The source or origin of the DNC entry.
addedDate	string	The date and time when the phone number was added to the DNC list.
addedBy	string	The user or system that added the phone number to the DNC list.
reason	string	The reason for adding the phone number to the DNC list, if provided.
lastModified	string	The date and time when the DNC entry was last modified.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DncEntryResponse",
  "title": "DncEntryResponse",
  "type": "object",
  "properties": {
    "phoneNumber": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{1,14}$",
      "description": "The phone number in the DNC list, in E.164 format.",
      "example": "+1234567890"
    },
    "source": {
      "type": "string",
      "description": "The source or origin of the DNC entry.",
      "example": "customer-request"
    },
    "addedDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the phone number was added to the DNC list.",
      "example": "2024-01-15T10:30:00Z"
    },
    "addedBy": {
      "type": "string",
      "description": "The user or system that added the phone number to the DNC list.",
      "example": "[email protected]"
    },
    "reason": {
      "type": "string",
      "description": "The reason for adding the phone number to the DNC list, if provided.",
      "example": "Customer opted out via phone"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the DNC entry was last modified.",
      "example": "2024-01-15T10:30:00Z"
    }
  },
  "example": {
    "phoneNumber": "+1234567890",
    "source": "customer-request",
    "addedDate": "2024-01-15T10:30:00Z",
    "addedBy": "[email protected]",
    "reason": "Customer opted out via phone",
    "lastModified": "2024-01-15T10:30:00Z"
  }
}