Webex · Schema

OutdialANIDTO

Outdial ANI resource representing a set of caller ID entries for outdial calls.

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.
description	string	(Optional) Enter a description for the outdial ANI.
outdialANIEntries	array	List of Outdial ANI entries associated with this Outdial ANI.
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OutdialANIDTO",
  "title": "OutdialANIDTO",
  "type": "object",
  "description": "Outdial ANI resource representing a set of caller ID entries for outdial calls.",
  "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.",
      "example": "outdial-ANI1",
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9._\\-\\s]*$"
    },
    "description": {
      "type": "string",
      "description": "(Optional) Enter a description for the outdial ANI.",
      "example": "This profile allows agent to select a phone number as the caller ID for an outdial call.",
      "maxLength": 255,
      "minLength": 0
    },
    "outdialANIEntries": {
      "type": "array",
      "description": "List of Outdial ANI entries associated with this Outdial ANI.",
      "items": {
        "$ref": "#/components/schemas/OutdialANIEntryDTO"
      },
      "uniqueItems": 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"
  ]
}