DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebarSidebar on Mobile
API Reference
BotsButtons and CardsIntegrationsBYODSService AppsService App GuestsService Apps G2GGuest IssuerWidgetsWebex ConnectLogin with WebexInstant ConnectInstant Connect Meeting LinksDeveloper SandboxBeta ProgramSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsCompliance
Webex APIs
Reference
Data Sources
Admin
OverviewAdmin APIsHybrid ServicesAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner Reports/TemplatesPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSettingsSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and AuthorizationMetadata and Samples
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsMetadata and SamplesBackground Images
Reference
Call ControlsCall RoutingCall Settings For MeCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsDevice Call SettingsDevicesEmergency Services SettingsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Operating ModesFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPartner Reports/TemplatesPeopleRecording ReportReportsReports: Detailed Call HistorySend Activation EmailUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for Wholesale
Overview
Guides
Developer's Guide
Reference
Wholesale Billing ReportsWholesale Provisioning
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Reference
Data Sources
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Directory Services
Reference
Domain ManagementIdentity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetings
POSTCreate a Meeting
GETGet a Meeting
GETList Meetings
PATCHPatch a Meeting
PUTUpdate a Meeting
DELETEDelete a Meeting
POSTJoin a Meeting
GETList Meeting Templates
GETGet a Meeting Template
GETGet Meeting Control Status
PUTUpdate Meeting Control Status
GETList Meeting Session Types
GETGet a Meeting Session Type
GETGet registration form for a meeting
PUTUpdate Meeting Registration Form
DELETEDelete Meeting Registration Form
POSTRegister a Meeting Registrant
POSTBatch register Meeting Registrants
GETGet Detailed Information for a Meeting Registrant
GETList Meeting Registrants
POSTQuery Meeting Registrants
POSTBatch Update Meeting Registrants status
DELETEDelete a Meeting Registrant
PUTUpdate Meeting Simultaneous interpretation
POSTCreate a Meeting Interpreter
GETGet a Meeting Interpreter
GETList Meeting Interpreters
PUTUpdate a Meeting Interpreter
DELETEDelete a Meeting Interpreter
GETList Meeting Breakout Sessions
PUTUpdate Meeting Breakout Sessions
DELETEDelete Meeting Breakout Sessions
GETGet a Meeting Survey
GETList Meeting Survey Results
POSTGet Meeting Survey Links
POSTCreate Invitation Sources
GETList Invitation Sources
GETList Meeting Tracking Codes
POSTReassign Meetings to a New Host
Meetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCall Settings For MeCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsData SourcesDevice Call SettingsDevice ConfigurationsDevicesDomain ManagementEmergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Operating ModesFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsIdentity OrganizationIssuesLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetings
POSTCreate a Meeting
GETGet a Meeting
GETList Meetings
PATCHPatch a Meeting
PUTUpdate a Meeting
DELETEDelete a Meeting
POSTJoin a Meeting
GETList Meeting Templates
GETGet a Meeting Template
GETGet Meeting Control Status
PUTUpdate Meeting Control Status
GETList Meeting Session Types
GETGet a Meeting Session Type
GETGet registration form for a meeting
PUTUpdate Meeting Registration Form
DELETEDelete Meeting Registration Form
POSTRegister a Meeting Registrant
POSTBatch register Meeting Registrants
GETGet Detailed Information for a Meeting Registrant
GETList Meeting Registrants
POSTQuery Meeting Registrants
POSTBatch Update Meeting Registrants status
DELETEDelete a Meeting Registrant
PUTUpdate Meeting Simultaneous interpretation
POSTCreate a Meeting Interpreter
GETGet a Meeting Interpreter
GETList Meeting Interpreters
PUTUpdate a Meeting Interpreter
DELETEDelete a Meeting Interpreter
GETList Meeting Breakout Sessions
PUTUpdate Meeting Breakout Sessions
DELETEDelete Meeting Breakout Sessions
GETGet a Meeting Survey
GETList Meeting Survey Results
POSTGet Meeting Survey Links
POSTCreate Invitation Sources
GETList Invitation Sources
GETList Meeting Tracking Codes
POSTReassign Meetings to a New Host
Meetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPSTNPartner ManagementPartner Reports/TemplatesPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSend Activation EmailSession TypesSettingsSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
Space Meetings Migration
Calling
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationCore ConceptsCalls
Advanced Features
Call SettingsContactsSupplementary ServicesVoicemailBackground Noise Reduction
Kitchen Sink
Meetings
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationJoin a MeetingMigration To Improved MeetingsPasswords & CaptchasUnified Space Meetings
Advanced Features
Advanced ControlsDialing In and OutStreams & EffectsVideo Resolution
Multistream
Multistream Comprehensive GuideMultistream Quickstart
Migrating SDK V2 to V3
iOSAndroidBrowserNode.jsClick to Call
Developer CommunityCertifications

Get a Meeting Template

Retrieves details for a meeting template with a specified meeting template ID.

Request Header
  • timezone: Time zone for time stamps in response body, defined in conformance with the IANA time zone database. The default value is UTC if not specified.
GET/v1/meetings/templates/{templateId}
URI Parameters
templateId
stringrequired

Unique identifier for the meeting template being requested.

Query Parameters
hostEmail
string

Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return the meeting template that is available for that user.

Response Properties
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
enum

Meeting template type.

meeting
string

Webex meeting.

webinar
string

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
CreateMeetingObject

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.

adhoc
boolean

Whether or not to create an ad-hoc meeting for the room specified by roomId. When true, roomId is required.

roomId
string

Unique identifier for the Webex space which the meeting is to be associated with. It can be retrieved by List Rooms. roomId is required when adhoc is true. When roomId is specified, the parameter hostEmail will be ignored.

templateId
string

Unique identifier for meeting template. Please note that start and end are optional when templateId is specified. The list of meeting templates that is available for the authenticated user can be retrieved from List Meeting Templates. This parameter is ignored for an ad-hoc meeting.

title
string

Meeting title. The title can be a maximum of 128 characters long. The default value for an ad-hoc meeting is the user's name if not specified.

agenda
string

Meeting agenda. The agenda can be a maximum of 1300 characters long.

password
string

Meeting password. Must conform to the site's password complexity settings. Read password management for details. If not specified, a random password conforming to the site's password rules will be generated automatically.

start
string

Date and time for the start of meeting in any ISO 8601 compliant format. start cannot be before current date and time or after end. Duration between start and end cannot be shorter than 10 minutes or longer than 23 hours 59 minutes. Please note that when a meeting is being scheduled, start of the meeting will be accurate to minutes, not seconds or milliseconds. Therefore, if start is within the same minute as the current time, start will be adjusted to the upcoming minute; otherwise, start will be adjusted with seconds and milliseconds stripped off. For instance, if the current time is 2022-03-01T10:32:16.657+08:00, start of 2022-03-01T10:32:28.076+08:00 or 2022-03-01T10:32:41+08:00 will be adjusted to 2022-03-01T10:33:00+08:00, and start of 2022-03-01T11:32:28.076+08:00 or 2022-03-01T11:32:41+08:00 will be adjusted to 2022-03-01T11:32:00+08:00. The default value for an ad-hoc meeting is 5 minutes after the current time and the user's input value will be ignored. An ad-hoc meeting can be started immediately even if the start is 5 minutes after the current time.

end
string

Date and time for the end of meeting in any ISO 8601 compliant format. end cannot be before current date and time or before start. Duration between start and end cannot be shorter than 10 minutes or longer than 23 hours 59 minutes. Please note that when a meeting is being scheduled, end of the meeting will be accurate to minutes, not seconds or milliseconds. Therefore, end will be adjusted with seconds and milliseconds stripped off. For instance, end of 2022-03-01T11:52:28.076+08:00 or 2022-03-01T11:52:41+08:00 will be adjusted to 2022-03-01T11:52:00+08:00. The default value for an ad-hoc meeting is 20 minutes after the current time and the user's input value will be ignored.

timezone
string

Time zone in which the meeting was originally scheduled (conforming with the IANA time zone database). The default value for an ad-hoc meeting is UTC and the user's input value will be ignored.

recurrence
string

Meeting series recurrence rule (conforming with RFC 2445), applying only to meeting series. It doesn't apply to a scheduled meeting or an ended or ongoing meeting instance. This parameter is ignored for an ad-hoc meeting. Multiple days or dates for monthly or yearly recurrence rule are not supported, only the first day or date specified is taken. For example, "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10,11,12" is not supported and it will be partially supported as "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10".

enabledAutoRecordMeeting
boolean

Whether or not meeting is recorded automatically.

allowAnyUserToBeCoHost
boolean

Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by siteUrl parameter when creating the meeting; if not specified, it's the user's preferred site. The default value for an ad-hoc meeting is true and the user's input value will be ignored.

enabledJoinBeforeHost
boolean

Whether or not to allow any attendee to join the meeting before the host joins the meeting. The default value for an ad-hoc meeting is true and the user's input value will be ignored.

enableConnectAudioBeforeHost
boolean

Whether or not to allow any attendee to connect audio in the meeting before the host joins the meeting. This attribute is only applicable if the enabledJoinBeforeHost attribute is set to true. The default value for an ad-hoc meeting is true and the user's input value will be ignored.

joinBeforeHostMinutes
number

Number of minutes an attendee can join the meeting before the meeting start time and the host joins. This attribute is only applicable if the enabledJoinBeforeHost attribute is set to true. Valid options for a meeting are 0, 5, 10, and 15, and valid options for a webinar are 0, 15, 30, 45, and 60. The default value for an ad-hoc meeting is 0 and the user's input value will be ignored.

excludePassword
boolean

Whether or not to exclude the meeting password from the email invitation. This parameter is ignored for an ad-hoc meeting.

publicMeeting
boolean

Whether or not to allow the meeting to be listed on the public calendar. The default value for an ad-hoc meeting is false and the user's input value will be ignored.

reminderTime
number

The number of minutes before the meeting begins, that an email reminder is sent to the host. This parameter is ignored for an ad-hoc meeting.

unlockedMeetingJoinSecurity
enum

Specifies how the people who aren't on the invite can join the unlocked meeting. The default value for an ad-hoc meeting is allowJoinWithLobby and the user's input value will be ignored.

allowJoin
string

If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.

allowJoinWithLobby
string

If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.

blockFromJoin
string

If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.

sessionTypeId
number

Unique identifier for a meeting session type for the user. This attribute is required when scheduling a webinar meeting. All available meeting session types enabled for the user can be retrieved using the List Meeting Session Types API.

scheduledType
enum

When set as an attribute in a POST request body, specifies whether it's a regular meeting, a webinar, or a meeting scheduled in the user's personal room. If not specified, it's a regular meeting by default. The default value for an ad-hoc meeting is meeting and the user's input value will be ignored.

meeting
string

Set the value of scheduledType attribute to meeting for creating a regular meeting.

webinar
string

Set the value of scheduledType attribute to webinar for creating a webinar meeting.

personalRoomMeeting
string

Set the value of scheduledType attribute to personalRoomMeeting for creating a meeting in the user's personal room. Please note that templateId, roomId, integrationTags, enabledWebcastView, enabledAutoRecordMeeting and registration are not supported when creating a personal room meeting.

enabledWebcastView
boolean

Whether or not webcast view is enabled. This parameter is ignored for an ad-hoc meeting.

panelistPassword
string

Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read password management for details. If not specified, a random password conforming to the site's password rules will be generated automatically. This parameter is ignored for an ad-hoc meeting.

enableAutomaticLock
boolean

Whether or not to automatically lock the meeting after it starts. The default value for an ad-hoc meeting is false and the user's input value will be ignored.

automaticLockMinutes
number

The number of minutes after the meeting begins, for automatically locking it. The default value for an ad-hoc meeting is null and the user's input value will be ignored.

allowFirstUserToBeCoHost
boolean

Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by siteUrl parameter when creating the meeting; if not specified, it's user's preferred site. The default value for an ad-hoc meeting is false and the user's input value will be ignored.

allowAuthenticatedDevices
boolean

Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. The default value for an ad-hoc meeting is true and the user's input value will be ignored.

invitees
array[InviteeObjectForCreateMeeting]

Invitees for meeting. The maximum size of invitees is 1000. If roomId is specified and invitees is missing, all the members in the space are invited implicitly. If both roomId and invitees are specified, only those in the invitees list are invited. coHost for each invitee is true by default if roomId is specified when creating a meeting, and anyone in the invitee list that is not qualified to be a cohost will be invited as a non-cohost invitee. The user's input value will be ignored for an ad-hoc meeting and the the members of the room specified by roomId except "me" will be used by default.

email
string

Email address of meeting invitee.

displayName
string

Display name of meeting invitee. The maximum length of displayName is 128 characters. If not specified but the email has been registered, user's registered name for the email will be taken as displayName. If not specified and the email hasn't been registered, the email will be taken as displayName.

coHost
boolean

Whether or not invitee is allowed to be a cohost for the meeting. coHost for each invitee is true by default if roomId is specified when creating a meeting, and anyone in the invitee list that is not qualified to be a cohost will be invited as a non-cohost invitee.

panelist
boolean

Whether or not an invitee is allowed to be a panelist. Only applies to webinars.

sendEmail
boolean

Whether or not to send emails to host and invitees. It is an optional field and default value is true. The default value for an ad-hoc meeting is false and the user's input value will be ignored.

hostEmail
string

Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.

siteUrl
string

URL of the Webex site which the meeting is created on. If not specified, the meeting is created on user's preferred site. All available Webex sites and preferred site of the user can be retrieved by Get Site List API.

meetingOptions
object

Meeting Options.

enabledChat
boolean

Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.

enabledVideo
boolean

Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.

enabledPolling
boolean

Whether or not to allow any attendee to poll in the meeting. Can only be set true for a webinar. The value of this attribute depends on the session type for a meeting. Please contact your site admin if this attribute is not available. Not supported if the site has been migrated to the Webex Suite meeting platform.

enabledNote
boolean

Whether or not to allow any attendee to take notes in the meeting. The value of this attribute also depends on the session type. Not supported if the site has been migrated to the Webex Suite meeting platform.

noteType
enum

Whether note taking is enabled. If the value of enabledNote is false, users cannot set this attribute and get the default value allowAll. Not supported if the site has been migrated to the Webex Suite meeting platform.

allowAll
string

If the value of noteType attribute is allowAll, all participants can take notes.

allowOne
string

If the value of noteType attribute is allowOne, only a single note taker is allowed.

enabledFileTransfer
boolean

Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.

enabledUCFRichMedia
boolean

Whether or not to allow any attendee to share Universal Communications Format media files in the meeting. The value of this attribute also depends on the sessionType. Not supported if the site has been migrated to the Webex Suite meeting platform.

attendeePrivileges
object

Attendee Privileges. This attribute is not supported for a webinar.

enabledShareContent
boolean

Whether or not to allow any attendee to share content in the meeting.

enabledSaveDocument
boolean

Whether or not to allow any attendee to save shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.

enabledPrintDocument
boolean

Whether or not to allow any attendee to print shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.

enabledAnnotate
boolean

Whether or not to allow any attendee to annotate shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.

enabledViewParticipantList
boolean

Whether or not to allow any attendee to view participants.

enabledViewThumbnails
boolean

Whether or not to allow any attendee to see a small preview image of any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.

enabledRemoteControl
boolean

Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.

enabledViewAnyDocument
boolean

Whether or not to allow any attendee to view any shared documents or slides when they are shared as files in the content viewer instead of in a window or application.

enabledViewAnyPage
boolean

Whether or not to allow any attendee to scroll through any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.

enabledContactOperatorPrivately
boolean

Whether or not to allow any attendee to contact the operator privately.

enabledChatHost
boolean

Whether or not to allow any attendee to chat with the host in private.

enabledChatPresenter
boolean

Whether or not to allow any attendee to chat with the presenter in private.

enabledChatOtherParticipants
boolean

Whether or not to allow any attendee to chat with other participants in private.

registration
object

Meeting registration. When this option is enabled, meeting invitees must register personal information in order to join the meeting. Meeting invitees will receive an email with a registration link for the registration. When the registration form has been submitted and approved, an email with a real meeting link will be received. By clicking that link the meeting invitee can join the meeting. Please note that meeting registration does not apply to a meeting when it's a recurring meeting with a recurrence field or no password or when the feature toggle DecoupleJBHWithRegistration is disabled the Join Before Host option is enabled for the meeting, See Register for a Meeting in Cisco Webex Meetings for details.

autoAcceptRequest
boolean

Whether or not meeting registration request is accepted automatically.

requireFirstName
boolean

Whether or not a registrant's first name is required for meeting registration. This option must always be true.

requireLastName
boolean

Whether or not a registrant's last name is required for meeting registration. This option must always be true.

requireEmail
boolean

Whether or not a registrant's email is required for meeting registration. This option must always be true.

requireJobTitle
boolean

Whether or not a registrant's job title is shown or required for meeting registration.

requireCompanyName
boolean

Whether or not a registrant's company name is shown or required for meeting registration.

requireAddress1
boolean

Whether or not a registrant's first address field is shown or required for meeting registration.

requireAddress2
boolean

Whether or not a registrant's second address field is shown or required for meeting registration.

requireCity
boolean

Whether or not a registrant's city is shown or required for meeting registration.

requireState
boolean

Whether or not a registrant's state is shown or required for meeting registration.

requireZipCode
boolean

Whether or not a registrant's postal code is shown or required for meeting registration.

requireCountryRegion
boolean

Whether or not a registrant's country or region is shown or required for meeting registration.

requireWorkPhone
boolean

Whether or not a registrant's work phone number is shown or required for meeting registration.

requireFax
boolean

Whether or not a registrant's fax number is shown or required for meeting registration.

maxRegisterNum
number

Maximum number of meeting registrations. This only applies to meetings. The maximum number of participants for meetings and webinars, with the limit based on the user capacity and controlled by a toggle at the site level. The default maximum number of participants for webinars is 10000, but the actual maximum number of participants is limited by the user capacity.

enabledRegistrationId
boolean

If true, generate random ID authentication for each registrant. Webinars only.

customizedQuestions
array[CustomizedQuestionForCreateMeeting]

Customized questions for meeting registration.

question
string

Title of the customized question.

required
boolean

Whether or not the customized question is required to be answered by participants.

type
enum

Type of the question being asked.

singleLineTextBox
string

Single line text box.

multiLineTextBox
string

Multiple line text box.

checkbox
string

Check box which requires options.

dropdownList
string

Drop down list box which requires options.

radioButtons
string

Single radio button which requires options.

maxLength
number

The maximum length of a string that can be entered by the user, ranging from 0 to 999. Only required by singleLineTextBox and multiLineTextBox.

options
array[object]

The content of options. Required if the question type is one of checkbox, dropdownList, or radioButtons.

value
string

The content of the option.

Possible values: green
rules
array[object]

The automatic approval rules for customized questions.

condition
enum

Judgment expression for approval rules.

contains
string

The content of the answer contains the value.

notContains
string

The content of the answer does not contain the value

beginsWith
string

The content of the answer begins with the value.

endsWith
string

The content of the answer ends with the value.

equals
string

The content of the answer is the same as the value.

notEquals
string

The content of the answer is not the same as the value.

value
string

The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.

Possible values: tom
result
enum

The automatic approval result for the approval rule.

approve
string

If the user's registration value meets the criteria, the registration form will be automatically approved.

reject
string

If the user's registration value meets the criteria, the registration form will be automatically rejected.

matchCase
boolean

Whether to check the case of values.

Possible values:
rules
array[StandardRegistrationApproveRule]

The approval rules for standard questions.

question
enum

Name for standard question.

lastName
string

If the value is lastName, this approval rule applies to the standard question of "Last Name".

email
string

If the value is email, this approval rule applies to the standard question of "Email".

jobTitle
string

If the value is jobTitle, this approval rule applies to the standard question of "Job Title".

companyName
string

If the value is companyName, this approval rule applies to the standard question of "Company Name".

address1
string

If the value is address1, this approval rule applies to the standard question of "Address 1".

address2
string

If the value is address2, this approval rule applies to the standard question of "Address 2".

city
string

If the value is city, this approval rule applies to the standard question of "City".

state
string

If the value is state, this approval rule applies to the standard question of "State".

zipCode
string

If the value is zipCode, this approval rule applies to the standard question of "Zip/Post Code".

countryRegion
string

If the value is countryRegion, this approval rule applies to the standard question of "Country Region".

workPhone
string

If the value is workPhone, this approval rule applies to the standard question of "Work Phone".

fax
string

If the value is fax, this approval rule applies to the standard question of "Fax".

condition
enum

Judgment expression for approval rules.

contains
string

The content of the answer contains the value.

notContains
string

The content of the answer does not contain the value

beginsWith
string

The content of the answer begins with the value.

endsWith
string

The content of the answer ends with the value.

equals
string

The content of the answer is the same as the value.

notEquals
string

The content of the answer is not the same as the value.

value
string

The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.

result
enum

The automatic approval result for the approval rule.

approve
string

If the user's registration value meets the criteria, the registration form will be automatically approved.

reject
string

If the user's registration value meets the criteria, the registration form will be automatically rejected.

matchCase
boolean

Whether to check the case of values.

order
number

The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together.

integrationTags
array[string]

External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries meetings by a key in its own domain. The maximum size of integrationTags is 3 and each item of integrationTags can be a maximum of 64 characters long. This parameter is ignored for an ad-hoc meeting.

simultaneousInterpretation
object

Simultaneous interpretation information for a meeting.

enabled
boolean

Whether or not simultaneous interpretation is enabled.

interpreters
array[InterpreterObjectForSimultaneousInterpretationOfCreateOrUpdateMeeting]

Interpreters for meeting.

languageCode1
string

Forms a set of simultaneous interpretation channels together with languageCode2. Standard language format from ISO 639-1 code. Read ISO 639-1 for details.

languageCode2
string

Forms a set of simultaneous interpretation channels together with languageCode1. Standard language format from ISO 639-1 code. Read ISO 639-1 for details.

email
string

Email address of meeting interpreter.

displayName
string

Display name of meeting interpreter.

enabledBreakoutSessions
boolean

Whether or not breakout sessions are enabled.

breakoutSessions
array[PreMeetingBreakoutSessionWithoutIdObject]

Breakout sessions are smaller groups that are split off from the main meeting or webinar. They allow a subset of participants to collaborate and share ideas over audio and video. Use breakout sessions for workshops, classrooms, or for when you need a moment to talk privately with a few participants outside of the main session. Please note that maximum number of breakout sessions in a meeting or webinar is 100. In webinars, if hosts preassign attendees to breakout sessions, the role of attendee will be changed to panelist. Breakout session is not supported for a meeting with simultaneous interpretation.

name
string

Name for breakout session.

invitees
array[string]

Invitees for breakout session. Please note that one invitee cannot be assigned to more than one breakout session.

trackingCodes
array[TrackingCodeItemForCreateMeetingObject]

Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by List Meeting Tracking Codes API. If an optional tracking code is missing from the trackingCodes array and there's a default option for this tracking code, the default option is assigned automatically. If the inputMode of a tracking code is select, its value must be one of the site-level options or the user-level value. Tracking code is not supported for a personal room meeting or an ad-hoc space meeting.

name
string

Name of the tracking code. The name cannot be empty and the maximum size is 120 characters.

value
string

Value for the tracking code. value cannot be empty and the maximum size is 120 characters.

enabledAudioWatermark
boolean

Whether or not the audio watermark is enabled. If it's true, scheduledType equals or defaults to meeting, and audioConnectionOptions.audioConnectionType equals VoIP, the audio for this meeting will have a watermark. In this case, a unique identifier is embedded into the audio that plays out of each Webex app and device. An administrator can use this watermark when analyzing an unauthorized recording to identify which Webex app or device was the source of the recording.

enabledVisualWatermark
boolean

Whether or not the visual watermark is enabled. If it's true, the video for this meeting will have a watermark. In this case, Webex superimposes a watermark image pattern on top of the meeting video and shared content to deter participants from leaking meeting information. Each participant viewing the meeting sees a watermark image pattern with their email address. If the participant is not signed in, the watermark image pattern includes their display name and email address.

visualWatermarkOpacity
number

Opacity level for the visual watermark. The value must be between 5 and 80, inclusive. A smaller value means less distraction for meeting participants, while a larger value shows a clearer watermark. It's supported when enabledVisualWatermark is true.

audioConnectionOptions
object

Audio connection options.

audioConnectionType
enum

Choose how meeting attendees join the audio portion of the meeting.

webexAudio
string

Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.

VoIP
string

Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.

other
string

Other teleconference services.

none
string

The way of attendees join the audio portion of the meeting is the default value.

enabledTollFreeCallIn
boolean

Whether or not to show toll-free call-in numbers.

enabledGlobalCallIn
boolean

Whether or not to show global call-in numbers to attendees.

enabledAudienceCallBack
boolean

Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.

entryAndExitTone
enum

Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.

beep
string

All call-in users joining the meeting will hear the beep.

announceName
string

All call-in users joining the meeting will hear their names.

noTone
string

Turn off beeps and name announcements.

allowHostToUnmuteParticipants
boolean

Whether or not to allow the host to unmute participants.

allowAttendeeToUnmuteSelf
boolean

Whether or not to allow attendees to unmute themselves.

muteAttendeeUponEntry
boolean

Whether or not to auto-mute attendees when attendees enter meetings.

requireAttendeeLogin
boolean

Require attendees to sign in before joining the webinar. This option works when the value of scheduledType attribute is webinar. Please note that requireAttendeeLogin cannot be set if someone has already registered for the webinar.

restrictToInvitees
boolean

Restrict webinar to invited attendees only. This option works when the registration option is disabled and the value of scheduledType attribute is webinar. Please note that restrictToInvitees cannot be set to true if requireAttendeeLogin is false.

enabledLiveStream
boolean

Whether or not live streaming is enabled. If enabled, the liveStream must be specified. The RTMP streaming specified by liveStream.rtmpUrl can be started and viewed during the meeting without any ad-hoc settings.

liveStream
LiveStreamObject

Live streaming settings. Applies when enabledLiveStream is true.

destination
string

A descriptive text to describe the destination of the live streaming.

rtmpUrl
string

Live streaming RTMP URL.

streamUrl
string

The URL to view the live streaming, i.e. the playback URL.

layoutWithoutSharedContent
enum

Live streaming layout when there's no shared content.

grid
string

The video layout that allows you to see multiple participants in a meeting in grids.

stack
string

The video layout that displays the active speaker on the stage and up to six participants in thumbnails across the top.

focus
string

The video layout that only displays the active speaker.

layoutWithSharedContent
enum

Live streaming layout when there's shared content.

stack
string

The video layout that displays the shared content on the stage and up to six participants in thumbnails across the top.

focusedContentWithActiveSpeaker
string

The layout that displays the shared content in the main part of the screen and a large thumbnail of the active speaker in the upper right corner.

focusedContent
string

The layout that only displays the shared content in the main part of the screen and does not display the participants.

allowChangeLayoutInMeeting
boolean

Whether or not to allow change the live streaming layout in the meeitng.

followStageLayoutWhenSynced
boolean

Whether or not to follow the stage layout when it's being synchronized.

resolution
string

Resolution of the live streaming.

Response Codes

The list below describes the common success and error responses you should expect from the API:

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
GET
/v1/meetings/templates/{?hostEmail}
Log in to try the API.
Header
Query Parameters
  • Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return the meeting template that is available for that user.
  • Request
  • Response
https://webexapis.com/v1/meetings/templates/N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM?hostEmail=john.andersen@example.com
200 / OK
{
    "id":"N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM",
    "name":"Meeting template 1",
    "locale":"en_US",
    "siteUrl":"site4-example.webex.com",
    "templateType":"meeting",
    "isDefault":false,
    "isStandard":false,
    "meeting":{
        "title":"My meeting template 1",
        "agenda":"My meeting template 1 agenda",
        "password":"gugUTMY4?25",
        "start":"2021-11-09T03:19:00Z",
        "end":"2021-11-09T03:39:00Z",
        "timezone":"UTC",
        "enabledJoinBeforeHost":false,
        "joinBeforeHostMinutes":0,
        "enableConnectAudioBeforeHost":false,
        "hostEmail":"john.andersen@example.com",
        "sendEmail":true,
        "invitees":[
            {
                "email":"brenda.song@example.com",
                "displayName":"Brenda Song",
                "coHost":false,
                "panelist":false
            },
            {
                "email":"catherine.sinu@example.com",
                "displayName":"Catherine Sinu",
                "coHost":false,
                "panelist":false
            }
        ],
        "enabledAutoRecordMeeting":false,
        "allowAnyUserToBeCoHost":false,
        "allowFirstUserToBeCoHost":false,
        "allowAuthenticatedDevices":false,
        "meetingOptions": {
            "enabledChat": true,
            "enabledVideo": true,
            "enabledPolling": false,
            "enabledNote": true,
            "noteType": "allowAll",
            "enabledFileTransfer": false,
            "enabledUCFRichMedia": false
        },
        "attendeePrivileges": {
            "enabledShareContent": true,
            "enabledSaveDocument": false,
            "enabledPrintDocument": false,
            "enabledAnnotate": false,
            "enabledViewParticipantList": true,
            "enabledViewThumbnails": false,
            "enabledRemoteControl": true,
            "enabledViewAnyDocument": false,
            "enabledViewAnyPage": false,
            "enabledContactOperatorPrivately": false,
            "enabledChatHost": true,
            "enabledChatPresenter": true,
            "enabledChatOtherParticipants": true
        },
        "registration":{
            "autoAcceptRequest":false,
            "requireFirstName":true,
            "requireLastName":true,
            "requireEmail":true,
            "requireJobTitle":false,
            "requireCompanyName":false,
            "requireAddress1":false,
            "requireAddress2":false,
            "requireCity":false,
            "requireState":false,
            "requireZipCode":false,
            "requireCountryRegion":false,
            "requireWorkPhone":false,
            "requireFax":false,
            "enabledRegistrationId": false
        },
        "siteUrl":"site4-example.webex.com",
        "excludePassword":false,
        "reminderTime":15,
        "unlockedMeetingJoinSecurity": "allowJoin",
        "enableAutomaticLock":true,
        "automaticLockMinutes":15,
        "sessionTypeId":636,
        "simultaneousInterpretation": {
            "enabled": true,
            "interpreters": [
                {
                    "languageCode1": "en",
                    "languageCode2": "de",
                    "email": "marcus.hoffmann@example.com",
                    "displayName": "Hoffmann"
                },
                {
                    "languageCode1": "en",
                    "languageCode2": "fr",
                    "email": "antoine.martin@example.com",
                    "displayName": "Martin"
                }
            ]
        },
        "enabledBreakoutSessions": true,
        "breakoutSessions": [
            {
                "name": "Breakout Session 1",
                "invitees": [
                    "rachel.green@example.com",
                    "monica.geller@example.com"
                ]
            },
            {
                "name": "Breakout Session N",
                "invitees": [
                    "ross.geller@example.com",
                    "chandler.bing@example.com"
                ]
            }
        ],
        "trackingCodes": [
            {
                "name": "Department",
                "value": "Engineering"
            },
            {
                "name": "Division",
                "value": "Full-time"
            }
        ],
        "audioConnectionOptions": {
            "audioConnectionType": "webexAudio",
            "enabledTollFreeCallIn": true,
            "enabledGlobalCallIn": true,
            "enabledAudienceCallBack": false,
            "entryAndExitTone": "beep",
            "allowHostToUnmuteParticipants": false,
            "allowAttendeeToUnmuteSelf": true,
            "muteAttendeeUponEntry": false
        }
    }
}

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2025 Cisco and/or its affiliates. All rights reserved.