{
"opencollection": "1.0.0",
"info": {
"name": "Webex Admin Address Book Meetings API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Meetings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get a Meeting By an Admin",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/admin/meetings/:meetingId",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "meetingId",
"value": "25bbf831-5be9-4c25-b4b0-9b592c8a086b",
"type": "path",
"description": "Unique identifier for the meeting being requested."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series. The default value is `false`."
}
]
},
"docs": "Retrieves details for a meeting with a specified meeting ID by an admin. The following sensitive attributes are hidden from the response: `agenda`, `hostKey`, `password`, `phoneAndVideoSystemPassword`, `panelistPassword`, `phoneAndVideoSystemPanelistPassword`, `webLink`, `sipAddress`, `dialInIpAddress`, `registration` and `telephony.accessCode`.\n\n* If the `meetingId` value specified is for a meeting series and `current` is `true`, the operation returns details for the current scheduled meeting o"
},
{
"info": {
"name": "List Meetings By an Admin",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/admin/meetings",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "meetingNumber",
"value": "123456789",
"type": "query",
"description": "Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned."
},
{
"name": "webLink",
"value": "https%3A%2F%2Fgo.webex.com%2Fgo%2Fj.php%3FMTID%3Dm066878aef4343e74c98b48439b71acfd",
"type": "query",
"description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where `meetingNumber` is specified and the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`."
}
]
},
"docs": "Retrieves details for meetings by an admin with a specified meeting number or web link. Please note that there are various products in the [Webex Suite](https://www.webex.com/collaboration-suite.html) such as `Meetings` and `Events`. Currently, only meetings of the `Meetings` product are supported by this API, meetings of others in the suite are not supported. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` will not be l"
},
{
"info": {
"name": "List Meetings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings",
"headers": [
{
"name": "password",
"value": "BgJep@4323"
},
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "meetingNumber",
"value": "123456789",
"type": "query",
"description": "Meeting number for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned."
},
{
"name": "webLink",
"value": "https%3A%2F%2Fgo.webex.com%2Fgo%2Fj.php%3FMTID%3Dm066878aef4343e74c98b48439b71acfd",
"type": "query",
"description": "URL encoded link to information page for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive."
},
{
"name": "roomId",
"value": "Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2",
"type": "query",
"description": "Associated Webex space ID for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive."
},
{
"name": "meetingSeriesId",
"value": "25bbf831-5be9-4c25-b4b0-9b592c8a086b",
"type": "query",
"description": "Unique identifier for the meeting series. The meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported. If `meetingSeriesId` is specified, it lists all occurrences and instances of the meeting series by default; with `meetingType` of `scheduledMeeting`, it lists occurrences; with `meetingType` of `meeting`, it lists ongoing and ended instances."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of meetings in the response, up to 100. This parameter is ignored if `meetingNumber`, `webLink` or `roomId` is specified. The default value is 10."
},
{
"name": "from",
"value": "2019-03-18T09:30:00+08:00",
"type": "query",
"description": "Start date and time (inclusive) for the range for which meetings are to be returned in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.\n\nWhen `meetingType` is `meetingSeries`(either explicitly set or by default), if `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is the current date and time. When `meetingType` is `scheduledMeeting`, `from` is the same as above. When `meetingType` is `meeting`, if `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is 7 days before the current date and time."
},
{
"name": "to",
"value": "2019-03-25T09:30:00+08:00",
"type": "query",
"description": "End date and time (exclusive) for the range for which meetings are to be returned in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.\n\nWhen `meetingType` is `meetingSeries`(either explicitly set or by default), if `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is 7 days after the current date and time. When `meetingType` is `scheduledMeeting`, `to` is the same as above. When `meetingType` is `meeting`, if `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time."
},
{
"name": "meetingType",
"value": "scheduledMeeting",
"type": "query",
"description": "Meeting type for the meeting objects being requested. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified."
},
{
"name": "state",
"value": "inProgress",
"type": "query",
"description": "Meeting state for the meeting objects being requested. If not specified, return meetings of all states. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified. Details of an `ended` meeting will only be available 15 minutes after the meeting has ended. `inProgress` meetings are not fully supported. The API will try to return details of an `inProgress` meeting 15 minutes after the meeting starts. However, it may take longer depending on the traffic. See the [Webex Meetings](/docs/meetings#meeting-states) guide for more information about the states of meetings."
},
{
"name": "scheduledType",
"value": "personalRoomMeeting",
"type": "query",
"description": "Scheduled type for the meeting objects being requested."
},
{
"name": "isModified",
"value": "false",
"type": "query",
"description": "Flag identifying whether a meeting has been modified. Only applies to scheduled meetings. If `true`, only return modified scheduled meetings; if `false`, only return unmodified scheduled meetings; if not specified, all scheduled meetings will be returned."
},
{
"name": "hasChat",
"value": "false",
"type": "query",
"description": "Flag identifying whether a meeting has a chat log. Only applies to ended meeting instances. If `true`, only return meeting instances which have chats; if `false`, only return meeting instances which have no chats; if not specified, all meeting instances will be returned."
},
{
"name": "hasRecording",
"value": "false",
"type": "query",
"description": "Flag identifying meetings which have been recorded. Only applies to ended meeting instances. If true, only return meeting instances which have been recorded; if false, only return meeting instances which have not been recorded; if not specified, all meeting instances will be returned."
},
{
"name": "hasTranscription",
"value": "false",
"type": "query",
"description": "Flag identifying meetings with transcripts. Only applies to ended meeting instances. If `true`, only return meeting instances which have transcripts; if `false`, only return meeting instances which have no transcripts; if not specified, all meeting instances will be returned."
},
{
"name": "hasSummary",
"value": "false",
"type": "query",
"description": "Flag identifying meetings with summaries. Only applies to ended meeting instances. If `true`, only return meeting instances which have summaries; if `false`, only return meeting instances which have no summaries; if not specified, all meeting instances will be returned."
},
{
"name": "hasClosedCaption",
"value": "false",
"type": "query",
"description": "Flag identifying meetings with closed captions. Only applies to ended meeting instances. If `true`, only return meeting instances which have closed captions; if `false`, only return meeting instances which have no closed captions; if not specified, all meeting instances will be returned."
},
{
"name": "hasPolls",
"value": "false",
"type": "query",
"description": "Flag identifying meetings with polls. Only applies to ended meeting instances. If `true`, only return meeting instances which have polls; if `false`, only return meeting instances which have no polls; if not specified, all meeting instances will be returned."
},
{
"name": "hasQA",
"value": "false",
"type": "query",
"description": "Flag identifying meetings with Q&A. Only applies to ended meeting instances. If `true`, only return meeting instances which have Q&A; if `false`, only return meeting instances which have no Q&A; if not specified, all meeting instances will be returned."
},
{
"name": "hasSlido",
"value": "false",
"type": "query",
"description": "Flag identifying meetings with Slido interactions. Only applies to ended meeting instances. If `true`, only return meeting instances which have Slido interactions like Q&A or polling; if `false`, only return meeting instances which have no Slido interactions; if not specified, all meeting instances will be returned."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 returns meetings as if the user calling the API were the user of `hostEmail` themself, and the meetings returned by the API include the meetings where the user of `hostEmail` is the meeting host and those where they are an invitee."
},
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API lists meetings from. If not specified, the API lists meetings from user's all sites. All available Webex sites of the user can be retrieved by `Get Site List` API."
},
{
"name": "integrationTag",
"value": "dbaeceebea5c4a63ac9d5ef1edfe36b9",
"type": "query",
"description": "External key created by an integration application. This parameter is used by the integration application to query meetings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\"."
}
]
},
"docs": "The previous `List Meetings of a Meeting Series` API is merged into the [List Meetings](/docs/api/v1/meetings/list-meetings) API.
\n\nRetrieves details for meetings with a specified meeting number, web link, meeting type, etc. Please note that there are various products in the [Webex Suite](https://www.webex.com/collaboration-suite.html) such as `Meetings` and `Events`. Currently, only meetings of the `Meetings` product are supported by this API, meetings o"
},
{
"info": {
"name": "Create a Meeting",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new meeting. Regular users can schedule up to 100 meetings in 24 hours and admin users up to 3000 overall or 800 for a single user. Please note that the failed requests are also counted toward the limits.\n\n* The `spark:all` scope is required when `roomId` is specified.\n\n* If the parameter `adhoc` is `true` and `roomId` is specified, an ad-hoc meeting is created for the target room. An ad-hoc meeting is a non-recurring instant meeting for the target room which is supposed to be started "
},
{
"info": {
"name": "Get a Meeting",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId",
"headers": [
{
"name": "password",
"value": "BgJep@4323"
},
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "meetingId",
"value": "25bbf831-5be9-4c25-b4b0-9b592c8a086b",
"type": "path",
"description": "Unique identifier for the meeting being requested."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
]
},
"docs": "Retrieves details for a meeting with a specified meeting ID.\n\n* If the `meetingId` value specified is for a meeting series and `current` is `true`, the operation returns details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series.\n\n* If the `meetingId` value specified is for a meeting series and `current` is `false` or `current` is not specified, the operation returns details for the entire mee"
},
{
"info": {
"name": "Update a Meeting",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/meetings/:meetingId",
"params": [
{
"name": "meetingId",
"value": "1d824a4a205042eba9574e00b711b226_20200127T120000Z",
"type": "path",
"description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nThe PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.\n
\n\nUpdates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be upda"
},
{
"info": {
"name": "Patch a Meeting",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/meetings/:meetingId",
"params": [
{
"name": "meetingId",
"value": "1d824a4a205042eba9574e00b711b226_20200127T120000Z",
"type": "path",
"description": "Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be updated.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meetin"
},
{
"info": {
"name": "Delete a Meeting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/meetings/:meetingId",
"params": [
{
"name": "meetingId",
"value": "e8a6557d3c964824ba346a0800d92575",
"type": "path",
"description": "Unique identifier for the meeting to be deleted. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 delete a meeting that is hosted by that user."
},
{
"name": "sendEmail",
"value": "true",
"type": "query",
"description": "Whether or not to send emails to host and invitees. It is an optional field and default value is true."
}
]
},
"docs": "Deletes a meeting with a specified meeting ID. The deleted meeting cannot be recovered. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` cannot be deleted.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation deletes that scheduled meeting without impact on other scheduled"
},
{
"info": {
"name": "Join a Meeting",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/join",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Retrieves links for a meeting with a specified `meetingId`, `meetingNumber`, or `webLink` that allow users to start or join the meeting directly without logging in and entering a password.\n\n* Please note that `meetingId`, `meetingNumber` and `webLink` are mutually exclusive and they cannot be specified simultaneously.\n\n* If `joinDirectly` is true or not specified, the response will have HTTP response code 302 and the request will be redirected to `joinLink`; otherwise, the response will have HTT"
},
{
"info": {
"name": "List Meeting Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/templates",
"params": [
{
"name": "templateType",
"value": "meeting",
"type": "query",
"description": "Meeting template type for the meeting template objects being requested. If not specified, return meeting templates of all types."
},
{
"name": "locale",
"value": "en_US",
"type": "query",
"description": "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."
},
{
"name": "isDefault",
"value": "false",
"type": "query",
"description": "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."
},
{
"name": "isStandard",
"value": "false",
"type": "query",
"description": "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."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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."
},
{
"name": "siteUrl",
"value": "site4-example.webex.com",
"type": "query",
"description": "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."
}
]
},
"docs": "Retrieves the list of meeting templates that is available for the authenticated user.\n\nThere are separate lists of meeting templates for different `templateType`, `locale` and `siteUrl`.\n\n* If `templateType` is specified, the operation returns an array of meeting template objects specified by the `templateType`; otherwise, returns an array of meeting template objects of all template types.\n\n* If `locale` is specified, the operation returns an array of meeting template objects specified by the `l"
},
{
"info": {
"name": "Get a Meeting Template",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/templates/:templateId",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "templateId",
"value": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM",
"type": "path",
"description": "Unique identifier for the meeting template being requested."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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."
}
]
},
"docs": "Retrieves details for a meeting template with a specified meeting template ID.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified."
},
{
"info": {
"name": "Get Meeting Control Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/controls",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "query",
"description": "Unique identifier for the meeting. Does not support meeting IDs for a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting."
}
]
},
"docs": "Get the meeting control of a live meeting, which is consisted of meeting control status on \"locked\" and \"recording\" to reflect whether the meeting is currently locked and there is recording in progress."
},
{
"info": {
"name": "Update Meeting Control Status",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/meetings/controls",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "query",
"description": "Unique identifier for the meeting. Does not support meeting IDs for a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "To start, pause, resume, or stop a meeting recording; To lock or unlock an on-going meeting."
},
{
"info": {
"name": "List Meeting Session Types",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/sessionTypes",
"params": [
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the user. 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 list all the meeting session types enabled for the user."
},
{
"name": "siteUrl",
"value": "site4-example.webex.com",
"type": "query",
"description": "Webex site URL to query. If `siteUrl` is not specified, the users' preferred site will be used. If the authorization token has the admin-level scopes, the admin can set the Webex site URL on behalf of the user specified in the `hostEmail` parameter."
}
]
},
"docs": "List all the meeting session types enabled for a given user."
},
{
"info": {
"name": "Get a Meeting Session Type",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/sessionTypes/:sessionTypeId",
"params": [
{
"name": "sessionTypeId",
"value": "628",
"type": "path",
"description": "A unique identifier for the sessionType."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the user. 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 get a meeting session type with the specified session type ID enabled for the user."
},
{
"name": "siteUrl",
"value": "site4-example.webex.com",
"type": "query",
"description": "Webex site URL to query. If `siteUrl` is not specified, the users' preferred site will be used. If the authorization token has the admin-level scopes, the admin can set the Webex site URL on behalf of the user specified in the `hostEmail` parameter."
}
]
},
"docs": "Retrieves details for a meeting session type with a specified session type ID."
},
{
"info": {
"name": "Get registration form for a meeting",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/registration",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
]
},
"docs": "Get a meeting's registration form to understand which fields are required."
},
{
"info": {
"name": "Update Meeting Registration Form",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/meetings/:meetingId/registration",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Enable or update a registration form for a meeting."
},
{
"info": {
"name": "Delete Meeting Registration Form",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/meetings/:meetingId/registration",
"headers": [
{
"name": "hostEmail",
"value": "`brenda.song@example.com` (string, optional) - Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for an interpreter of the meeting that is hosted by that user."
}
],
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
}
]
},
"docs": "Disable the registration form for a meeting."
},
{
"info": {
"name": "List Meeting Registrants",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/registrants",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of registrants in the response, up to 100. The default is 10."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series."
},
{
"name": "email",
"value": "abc@test.com",
"type": "query",
"description": "Registrant's email to filter registrants."
},
{
"name": "registrationTimeFrom",
"value": "2022-10-22T09:30:00",
"type": "query",
"description": "The time registrants register a meeting starts from the specified date and time (inclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If `registrationTimeFrom` is not specified, it equals `registrationTimeTo` minus 7 days."
},
{
"name": "registrationTimeTo",
"value": "2022-10-25T09:30:00",
"type": "query",
"description": "The time registrants register a meeting before the specified date and time (exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If `registrationTimeTo` is not specified, it equals `registrationTimeFrom` plus 7 days. The interval between `registrationTimeFrom` and `registrationTimeTo` must be within 90 days."
}
]
},
"docs": "Meeting's host and cohost can retrieve the list of registrants for a meeting with a specified meeting Id."
},
{
"info": {
"name": "Register a Meeting Registrant",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/registrants",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Register a new registrant for a meeting. When a meeting or webinar is created, this API can only be used if Registration is checked on the page or the registration attribute is specified through the [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) API."
},
{
"info": {
"name": "Batch register Meeting Registrants",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/registrants/bulkInsert",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Bulk register new registrants for a meeting. When a meeting or webinar is created, this API can only be used if Registration is checked on the page or the registration attribute is specified through the [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) API."
},
{
"info": {
"name": "Get Detailed Information for a Meeting Registrant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/registrants/:registrantId",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "registrantId",
"value": "89012b46-ee1d-4c4d-9c3f-0f1b27b47f19",
"type": "path",
"description": "Unique identifier for the registrant"
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
]
},
"docs": "Retrieves details for a meeting registrant with a specified registrant Id."
},
{
"info": {
"name": "Delete a Meeting Registrant",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/meetings/:meetingId/registrants/:registrantId",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "registrantId",
"value": "89012b46-ee1d-4c4d-9c3f-0f1b27b47f19",
"type": "path",
"description": "Unique identifier for the registrant."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
]
},
"docs": "Meeting's host or cohost can delete a registrant with a specified registrant ID."
},
{
"info": {
"name": "Query Meeting Registrants",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/registrants/query",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "max",
"value": "1000",
"type": "query",
"description": "Limit the maximum number of registrants in the response, up to 100. The default is 10."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Meeting's host and cohost can query the list of registrants for a meeting with a specified meeting ID and registrants email."
},
{
"info": {
"name": "Batch Approve Meeting Registrants",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/registrants/approve",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series.\n + Default: `false`\n"
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Batch approve a set of registrants for a meeting by the meeting host or cohost."
},
{
"info": {
"name": "Batch Reject Meeting Registrants",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/registrants/reject",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series.\n + Default: `false`\n"
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Batch reject a set of registrants for a meeting by the meeting host or cohost."
},
{
"info": {
"name": "Batch Cancel Meeting Registrants",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/registrants/cancel",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series.\n + Default: `false`\n"
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Batch cancel a set of registrants for a meeting by the meeting host or cohost."
},
{
"info": {
"name": "Batch Delete Meeting Registrants",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/registrants/bulkDelete",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. See the [Meetings Overview](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for more information about meeting types."
},
{
"name": "current",
"value": "false",
"type": "query",
"description": "Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series.\n + Default: `false`\n"
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "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 details for a meeting that is hosted by that user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Batch delete a set of registrants for a meeting by the meeting host or cohost."
},
{
"info": {
"name": "Update Meeting Simultaneous interpretation",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/meetings/:meetingId/simultaneousInterpretation",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Does not support meeting IDs for a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates simultaneous interpretation options of a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances."
},
{
"info": {
"name": "List Meeting Interpreters",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/interpreters",
"params": [
{
"name": "meetingId",
"value": "870f51ff287b41be84648412901e0402",
"type": "path",
"description": "Unique identifier for the meeting for which interpreters are being requested. The meeting can be meeting series, scheduled meeting or meeting instance which has ended or is ongoing. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API."
},
{
"name": "hostEmail",
"value": "brenda.song@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return interpreters of the meeting that is hosted by that user."
}
]
},
"docs": "Lists meeting interpreters for a meeting with a specified `meetingId`.\n\nThis operation can be used for meeting series, scheduled meeting and ended or ongoing meeting instance objects. If the specified `meetingId` is for a meeting series, the interpreters for the series will be listed; if the `meetingId` is for a scheduled meeting, the interpreters for the particular scheduled meeting will be listed; if the `meetingId` is for an ended or ongoing meeting instance, the interpreters for the particul"
},
{
"info": {
"name": "Create a Meeting Interpreter",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/interpreters",
"params": [
{
"name": "meetingId",
"value": "870f51ff287b41be84648412901e0402_2628962",
"type": "path",
"description": "Unique identifier for the meeting to which the interpreter is to be assigned."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign an interpreter to a bi-directional simultaneous interpretation language channel for a meeting."
},
{
"info": {
"name": "Get a Meeting Interpreter",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/interpreters/:interpreterId",
"params": [
{
"name": "meetingId",
"value": "870f51ff287b41be84648412901e0402",
"type": "path",
"description": "Unique identifier for the meeting to which the interpreter has been assigned."
},
{
"name": "interpreterId",
"value": "OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM",
"type": "path",
"description": "Unique identifier for the interpreter whose details are being requested."
},
{
"name": "hostEmail",
"value": "brenda.song@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for an interpreter of the meeting that is hosted by that user."
}
]
},
"docs": "Retrieves details for a meeting interpreter identified by `meetingId` and `interpreterId` in the URI."
},
{
"info": {
"name": "Update a Meeting Interpreter",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/meetings/:meetingId/interpreters/:interpreterId",
"params": [
{
"name": "meetingId",
"value": "870f51ff287b41be84648412901e0402",
"type": "path",
"description": "Unique identifier for the meeting whose interpreters were belong to."
},
{
"name": "interpreterId",
"value": "OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM",
"type": "path",
"description": "Unique identifier for the interpreter whose details are being requested."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates details for a meeting interpreter identified by `meetingId` and `interpreterId` in the URI."
},
{
"info": {
"name": "Delete a Meeting Interpreter",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/meetings/:meetingId/interpreters/:interpreterId",
"params": [
{
"name": "meetingId",
"value": "870f51ff287b41be84648412901e0402",
"type": "path",
"description": "Unique identifier for the meeting whose interpreters were belong to."
},
{
"name": "interpreterId",
"value": "OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM",
"type": "path",
"description": "Unique identifier for the interpreter to be removed."
},
{
"name": "hostEmail",
"value": "brenda.song@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will delete an interpreter of the meeting that is hosted by that user."
},
{
"name": "sendEmail",
"value": "true",
"type": "query",
"description": "If `true`, send email to the interpreter."
}
]
},
"docs": "Removes a meeting interpreter identified by `meetingId` and `interpreterId` in the URI. The deleted meeting interpreter cannot be recovered."
},
{
"info": {
"name": "List Meeting Breakout Sessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/breakoutSessions",
"headers": [
{
"name": "hostEmail",
"value": "`john.andersen@example.com` (string, optional) - 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 details for a meeting that is hosted by that user."
}
],
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. This parameter applies to meeting series, scheduled meeting and ended or ongoing meeting instance objects. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API."
}
]
},
"docs": "Lists meeting breakout sessions for a meeting with a specified `meetingId`.\n\nThis operation can be used for meeting series, scheduled meeting and ended or ongoing meeting instance objects. See the [Webex Meetings](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) guide for more information about the types of meetings.\n\n* If the meeting of `meetingId` is in progress, the operation returns the breakout sessions which are currently held in the meeting.\n\n* If the meeting of `me"
},
{
"info": {
"name": "Update Meeting Breakout Sessions",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/meetings/:meetingId/breakoutSessions",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Does not support meeting IDs for a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates breakout sessions of a meeting with a specified meeting ID in the pre-meeting state. This operation applies to meeting series and scheduled meetings."
},
{
"info": {
"name": "Delete Meeting Breakout Sessions",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/meetings/:meetingId/breakoutSessions",
"headers": [
{
"name": "hostEmail",
"value": "`john.andersen@example.com` (string, optional) - 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 delete breakout sessions that are created by that user."
}
],
"params": [
{
"name": "meetingId",
"value": "e8a6557d3c964824ba346a0800d92575",
"type": "path",
"description": "Unique identifier for the meeting. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances."
},
{
"name": "sendEmail",
"value": "true",
"type": "query",
"description": "Whether or not to send emails to host and invitees. It is an optional field and default value is true."
}
]
},
"docs": "Deletes breakout sessions with a specified meeting ID. The deleted breakout sessions cannot be recovered. The value of `enabledBreakoutSessions` attribute is set to `false` automatically.\nThis operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances."
},
{
"info": {
"name": "Get a Meeting Survey",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/survey",
"headers": [
{
"name": "hostEmail",
"value": "john.andersen@example.com"
}
],
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Please note that only the meeting ID of a scheduled webinar is supported for this API."
}
]
},
"docs": "Retrieves details for a meeting survey identified by `meetingId`.\n\n#### Request Header\n\n* `hostEmail`: Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return survey details of that user."
},
{
"info": {
"name": "List Meeting Survey Results",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/surveyResults",
"headers": [
{
"name": "timezone",
"value": "UTC"
},
{
"name": "hostEmail",
"value": "john.andersen@example.com"
}
],
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Please note that only the meeting ID of a scheduled webinar is supported for this API."
},
{
"name": "meetingStartTimeFrom",
"value": "2019-03-18T09:30:00Z",
"type": "query",
"description": "Start date and time (inclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested. `meetingStartTimeFrom` cannot be after `meetingStartTimeTo`. This parameter will be ignored if `meetingId` is the unique identifier for the specific meeting instance.\nWhen `meetingId` is not the unique identifier for the specific meeting instance, the `meetingStartTimeFrom`, if not specified, equals `meetingStartTimeTo` minus `1` month; if `meetingStartTimeTo` is also not specified, the default value for `meetingStartTimeFrom` is `1` month before the current date and time.\n"
},
{
"name": "meetingStartTimeTo",
"value": "2019-03-25T09:30:00Z",
"type": "query",
"description": "End date and time (exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested. `meetingStartTimeTo` cannot be prior to `meetingStartTimeFrom`. This parameter will be ignored if `meetingId` is the unique identifier for the specific meeting instance.\nWhen `meetingId` is not the unique identifier for the specific meeting instance, if `meetingStartTimeFrom` is also not specified, the default value for `meetingStartTimeTo` is the current date and time;For example,if `meetingStartTimeFrom` is a month ago, the default value for `meetingStartTimeTo` is `1` month after `meetingStartTimeFrom`.Otherwise it is the current date and time.\n"
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of meetings in the response, up to 100. The default is 10."
}
]
},
"docs": "Retrieves results for a meeting survey identified by `meetingId`.\n\n#### Request Header\n\n* `timezone`: Time zone for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.\n\n* `hostEmail`: Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site"
},
{
"info": {
"name": "Get Meeting Survey Links",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/surveyLinks",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only applies to webinars. Meetings and personal room meetings are not supported."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get survey links of a meeting for different users.\n\n#### Request Header\n\n* `timezone`: Time zone for the `meetingStartTimeFrom` and `meetingStartTimeTo` parameters and defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified."
},
{
"info": {
"name": "List Invitation Sources",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/:meetingId/invitationSources",
"headers": [
{
"name": "hostEmail",
"value": "john.andersen@example.com"
},
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI"
}
],
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the meeting ID of a scheduled webinar is supported for this API."
}
]
},
"docs": "Lists invitation sources for a meeting.\n\n#### Request Header\n\n* `hostEmail`: Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.\n\n* `personId`: Unique identifier for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level "
},
{
"info": {
"name": "Create Invitation Sources",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/invitationSources",
"params": [
{
"name": "meetingId",
"value": "560d7b784f5143e3be2fc3064a5c4999",
"type": "path",
"description": "Unique identifier for the meeting. Only the meeting ID of a scheduled webinar is supported for this API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates one or more invitation sources for a meeting."
},
{
"info": {
"name": "List Meeting Tracking Codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/meetings/trackingCodes",
"params": [
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
},
{
"name": "service",
"value": "MeetingCenter",
"type": "query",
"description": "Service for schedule or sign-up pages."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if a user or application calling the API has the admin-level scopes. The admin may specify the email of a user on a site they manage and the API will return meeting participants of the meetings that are hosted by that user."
}
]
},
"docs": "Lists tracking codes on a site by a meeting host. The result indicates which tracking codes and what options can be used to create or update a meeting on the specified site.\n\n* The `options` here differ from those in the [site-level tracking codes](/docs/api/v1/tracking-codes/get-a-tracking-code) and the [user-level tracking codes](/docs/api/v1/tracking-codes/get-user-tracking-codes). It is the result of a selective combination of the two.\n\n* For a tracking code, if there is no user-level tracki"
},
{
"info": {
"name": "Reassign Meetings to a New Host",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/reassignHost",
"headers": [
{
"name": "siteUrl",
"value": "example.webex.com"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Reassigns a list of meetings to a new host by an admin user.\n\nAll the meetings of `meetingIds` should belong to the same site, which is the `siteUrl` in the request header, if specified, or the admin user's preferred site, if not specified. All available Webex sites and the preferred sites of a user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\nIf the user of `hostEmail` is not qualified to be a host of the target site, the API returns an error with th"
},
{
"info": {
"name": "End a Meeting",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/meetings/:meetingId/end",
"params": [
{
"name": "meetingId",
"value": "e8a6557d3c964824ba346a0800d92575",
"type": "path",
"description": "Unique identifier for the meeting to be ended."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Ends a meeting with a specified meeting ID. This operation applies to meeting series, scheduled meetings, and in-progress meetings. Only the meeting host, cohost, or compliance officer can end a meeting with this API.\n\n* If the `meetingId` value specified is for a scheduled meeting, the operation ends that meeting without impacting other scheduled meetings of the parent meeting series.\n\n* If the `meetingId` value specified is for a meeting series, the operation ends the current meeting occurrenc"
}
]
}
],
"bundled": true
}