List Meeting Templates
Retrieves the list of meeting templates that is available for the authenticated user.
There are separate lists of meeting templates for different templateType, locale and siteUrl.
If
templateTypeis specified, the operation returns an array of meeting template objects specified by thetemplateType; otherwise, returns an array of meeting template objects of all template types.If
localeis specified, the operation returns an array of meeting template objects specified by thelocale; otherwise, returns an array of meeting template objects of the defaulten_USlocale. Refer to Meeting Template Locales for all the locales supported by Webex.If the parameter
siteUrlhas a value, the operation lists meeting templates on the specified site; otherwise, lists meeting templates on the user's preferred site. All available Webex sites and preferred site of the user can be retrieved byGet Site ListAPI.
Query Parameters
Meeting template type for the meeting template objects being requested. If not specified, return meeting templates of all types.
Locale for the meeting template objects being requested. If not specified, return meeting templates of the default en_US locale. Refer to Meeting Template Locales for all the locales supported by Webex.
The value is true or false. If it's true, return the default meeting templates; if it's false, return the non-default meeting templates. If it's not specified, return both default and non-default meeting templates.
The value is true or false. If it's true, return the standard meeting templates; if it's false, return the non-standard meeting templates. If it's not specified, return both standard and non-standard meeting templates.
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 meeting templates that are available for that user.
URL of the Webex site which the API lists meeting templates from. If not specified, the API lists meeting templates from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by Get Site List API.
Response Properties
Meeting templates array.
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.
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. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 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
- Meeting template type for the meeting template objects being requested. If not specified, return meeting templates of all types.
- Locale for the meeting template objects being requested. If not specified, return meeting templates of the default `en_US` locale. Refer to [Meeting Template Locales](/docs/meetings#meeting-template-locales) for all the locales supported by Webex.
- The value is `true` or `false`. If it's `true`, return the default meeting templates; if it's `false`, return the non-default meeting templates. If it's not specified, return both default and non-default meeting templates.
- The value is `true` or `false`. If it's `true`, return the standard meeting templates; if it's `false`, return the non-standard meeting templates. If it's not specified, return both standard and non-standard meeting templates.
- 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 meeting templates that are available for that user.
- URL of the Webex site which the API lists meeting templates from. If not specified, the API lists meeting templates from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by `Get Site List` API.
{
"items": [
{
"id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM",
"name": "Meeting template 1",
"locale": "en_US",
"siteUrl": "site4-example.webex.com",
"templateType": "meeting",
"isDefault": false,
"isStandard": false
},
{
"id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NjctTUMtZW5fVVMtTA",
"name": "Meeting template 2",
"locale": "en_US",
"siteUrl": "site4-example.webex.com",
"templateType": "meeting",
"isDefault": false,
"isStandard": true
},
{
"id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6Ry0wLU1DLWVuX1VT",
"name": "Webex Meetings Default",
"locale": "en_US",
"siteUrl": "site4-example.webex.com",
"templateType": "meeting",
"isDefault": true,
"isStandard": true
},
{
"id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA1NjctTUMtZW5fVVMtTA",
"name": "Webinar template 1",
"locale": "en_US",
"siteUrl": "site4-example.webex.com",
"templateType": "webinar",
"isDefault": false,
"isStandard": false
},
{
"id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA4NzctTUMtZW5fVVMtTA",
"name": "Webinar template 2",
"locale": "en_US",
"siteUrl": "site4-example.webex.com",
"templateType": "webinar",
"isDefault": false,
"isStandard": false
},
{
"id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6Ry0yLU1DLWVuX1VTLUw",
"name": "Webex Events Default",
"locale": "en_US",
"siteUrl": "site4-example.webex.com",
"templateType": "webinar",
"isDefault": false,
"isStandard": true
}
]
}