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 isUTCif not specified.
URI Parameters
Unique identifier for the meeting template being requested.
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.
Response Properties
Unique identifier for meeting template.
Meeting template name.
Meeting template locale.
Site URL for the meeting template.
Meeting template type.
Webex meeting.
Webex webinar.
Whether or not the meeting template is a default template.
Whether or not the meeting template is a standard template.
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.
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.
Meeting title. The title can be a maximum of 128 characters long.
Meeting agenda. The agenda can be a maximum of 1300 characters long.
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.
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 24 hours. 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.
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 24 hours. 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.
Time zone in which meeting was originally scheduled (conforming with the IANA time zone database).
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.
Whether or not meeting is recorded automatically.
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 user's preferred site.
Whether or not to allow any attendee to join the meeting before the host joins the meeting.
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 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 are 0, 5, 10 and 15. Default is 0 if not specified.
Whether or not to exclude password from the meeting email invitation.
Whether or not to allow the meeting to be listed on the public calendar.
The number of minutes before the meeting begins, for sending an email reminder to the host.
It specifies how the people who aren't on the invite can join the unlocked meeting.
If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.
If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.
If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.
Unique identifier for a meeting session type for the user. This attribute is required while scheduling a webinar meeting. All available meeting session types enabled for the user can be retrieved by List Meeting Session Types API.
When set as an attribute in a POST request body, it 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.
Set the value of scheduledType attribute to meeting for creating a regular meeting.
Set the value of scheduledType attribute to webinar for creating a webinar meeting.
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.
Whether or not webcast view is enabled.
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.
Whether or not to automatically lock the meeting after it starts.
The number of minutes after the meeting begins, for automatically locking it.
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.
Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt.
Invitees for meeting. The maximum size of invitees is 1000.
Email address of meeting invitee.
Display name of meeting invitee. The maximum length of displayName is 384 bytes. 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.
Whether or not invitee is allowed to be a cohost for the meeting.
Whether or not to send emails to host and invitees. It is an optional field and default value is true.
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.
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.
Meeting registration. When this option is enabled, meeting invitee must register personal information in order to join the meeting. Meeting invitee 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 recurrence field or it has no password, or the Join Before Host option is enabled for the meeting. Read Register for a Meeting in Cisco Webex Meetings for details.
Whether or not meeting registration request is accepted automatically.
Whether or not registrant's first name is required for meeting registration. This option must always be true.
Whether or not registrant's last name is required for meeting registration. This option must always be true.
Whether or not registrant's email is required for meeting registration. This option must always be true.
Whether or not registrant's job title is required for meeting registration.
Whether or not registrant's company name is required for meeting registration.
Whether or not registrant's 1st address is required for meeting registration.
Whether or not registrant's 2nd address is required for meeting registration.
Whether or not registrant's city is required for meeting registration.
Whether or not registrant's state is required for meeting registration.
Whether or not registrant's zip code is required for meeting registration.
Whether or not registrant's country or region is required for meeting registration.
Whether or not registrant's work phone number is required for meeting registration.
Whether or not registrant's fax number is required for meeting registration.
The maximum number of meeting registration. It only applies to meetings and will be ignored by webinars.
External keys created by an integration application in its own domain. They could be 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.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
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.
{
"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,
"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
},
"siteUrl":"site4-example.webex.com",
"excludePassword":false,
"reminderTime":15,
"unlockedMeetingJoinSecurity": "allowJoin",
"enableAutomaticLock":true,
"automaticLockMinutes":15,
"sessionTypeId":636
}
}