Webex · Schema

FeatureReferenceObject

Metadata describing a call feature that references an announcement.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier of the call feature referenced. The call Feature can be Auto Attendant, Call Queue or Music On hold.
name string Name of the call feature referenced.
type string Resource Type of the call feature.
locationId string Unique identifier of the location.
locationName string Location name of the announcement file.
View JSON Schema on GitHub

JSON Schema

webex-featurereferenceobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FeatureReferenceObject",
  "title": "FeatureReferenceObject",
  "type": "object",
  "description": "Metadata describing a call feature that references an announcement.",
  "required": [
    "id",
    "name",
    "type",
    "locationId",
    "locationName"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw",
      "description": "Unique identifier of the call feature referenced. The call Feature can be Auto Attendant, Call Queue or Music On hold."
    },
    "name": {
      "type": "string",
      "example": "Main Line AA - Test",
      "description": "Name of the call feature referenced."
    },
    "type": {
      "type": "string",
      "example": "Auto Attendant",
      "description": "Resource Type of the call feature."
    },
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81ZTk3MzFlNy1iOWQ0LTRmMWQtYjYyMi05NDgwMDhhMjkzMzM",
      "description": "Unique identifier of the location."
    },
    "locationName": {
      "type": "string",
      "example": "RCDN",
      "description": "Location name of the announcement file."
    }
  }
}