Webex · Schema

DetailedTemplateObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for meeting template.
name string Meeting template name.
locale string Meeting template locale.
siteUrl string Site URL for the meeting template.
templateType string Meeting template type. * `meeting` - Webex meeting. * `webinar` - Webex webinar.
isDefault boolean Whether or not the meeting template is a default template.
isStandard boolean Whether or not the meeting template is a standard template.
meeting object Meeting object which is used to create a meeting by the meeting template. Please note that the meeting object should be used to create a meeting immediately after retrieval since the `start` and `end`
View JSON Schema on GitHub

JSON Schema

webex-detailedtemplateobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DetailedTemplateObject",
  "title": "DetailedTemplateObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "locale",
    "siteUrl",
    "templateType",
    "isDefault",
    "isStandard",
    "meeting"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM",
      "description": "Unique identifier for meeting template."
    },
    "name": {
      "type": "string",
      "example": "Meeting template 1",
      "description": "Meeting template name."
    },
    "locale": {
      "type": "string",
      "example": "en_US",
      "description": "Meeting template locale."
    },
    "siteUrl": {
      "type": "string",
      "example": "site4-example.webex.com",
      "description": "Site URL for the meeting template."
    },
    "templateType": {
      "type": "string",
      "enum": [
        "meeting",
        "webinar"
      ],
      "description": "Meeting template type.\n * `meeting` - Webex meeting.\n * `webinar` - Webex webinar.\n"
    },
    "isDefault": {
      "type": "boolean",
      "description": "Whether or not the meeting template is a default template."
    },
    "isStandard": {
      "type": "boolean",
      "description": "Whether or not the meeting template is a standard template."
    },
    "meeting": {
      "$ref": "#/components/schemas/CreateMeetingObject",
      "description": "Meeting object which is used to create a meeting by the meeting template. Please note that the meeting object should be used to create a meeting immediately after retrieval since the `start` and `end` may be invalid quickly after generation."
    }
  }
}