Webex · Schema

OutdialANIEntryDTO

Outdial ANI entry representing a single caller ID phone number or SIP URI.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
organizationId string ID of the contact center organization. This field is required for all bulk save operations.
id string ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
version integer The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
name string Enter a name for the outdial ANI entry.
number string Enter a valid phone number or valid SIP URI.
defaultANIEntry boolean Indicates whether this is the default Outdial ANI Entry(true) or not(false).
createdTime integer This is the created time of the entity.
lastUpdatedTime integer This is the updated time of the entity.
View JSON Schema on GitHub

JSON Schema

webex-outdialanientrydto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OutdialANIEntryDTO",
  "title": "OutdialANIEntryDTO",
  "type": "object",
  "description": "Outdial ANI entry representing a single caller ID phone number or SIP URI.",
  "properties": {
    "organizationId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the contact center organization. This field is required for all bulk save operations.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "example": 1
    },
    "name": {
      "type": "string",
      "description": "Enter a name for the outdial ANI entry.",
      "example": "Test",
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9._\\-\\s]*$"
    },
    "number": {
      "type": "string",
      "description": "Enter a valid phone number or valid SIP URI.",
      "example": "98723487924"
    },
    "defaultANIEntry": {
      "type": "boolean",
      "description": "Indicates whether this is the default Outdial ANI Entry(true) or not(false).",
      "example": true
    },
    "createdTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the created time of the entity."
    },
    "lastUpdatedTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the updated time of the entity."
    }
  },
  "required": [
    "name",
    "number"
  ]
}