openapi: 3.0.0 info: title: Webex Admin Address Book Meetings API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: Meetings paths: /admin/meetings/{meetingId}: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingObjectForAdminListMeeting' example: id: 870f51ff287b41be84648412901e0402_20191101T120000Z meetingSeriesId: 870f51ff287b41be84648412901e0402 meetingNumber: '123456789' title: Example Daily Meeting meetingType: scheduledMeeting state: ready hostDidJoin: true attendeeDidJoin: true isModified: false timezone: UTC start: '2019-11-01T12:00:00Z' end: '2019-11-01T13:00:00Z' hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com siteUrl: site4-example.webex.com enabledAutoRecordMeeting: false allowAnyUserToBeCoHost: false enabledJoinBeforeHost: false enableConnectAudioBeforeHost: false joinBeforeHostMinutes: 0 excludePassword: false publicMeeting: false reminderTime: 10 unlockedMeetingJoinSecurity: allowJoin sessionTypeId: 3 enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false telephony: callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers method: GET 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 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions method: GET trackingCodes: - name: Department value: Engineering - name: Division value: Full-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 10 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: false entryAndExitTone: beep allowHostToUnmuteParticipants: false allowAttendeeToUnmuteSelf: true muteAttendeeUponEntry: false enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Meeting By an Admin operationId: adminGetMeetingById description: '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`. * 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. * 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 meeting series. * If the `meetingId` value specified is for a scheduled meeting from a meeting series, the operation returns details for that scheduled meeting. * If the `meetingId` value specified is for a meeting instance which is happening or has happened, the operation returns details for that meeting instance. * `trackingCodes` is not supported for ended meeting instances. * To learn more about which attributes are available for different meeting states, please refer to [Available Meeting Attributes for Different Meeting States](/docs/meetings#available-meeting-attributes-for-different-meeting-states). #### Request Header * `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.' tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting being requested. required: true example: 25bbf831-5be9-4c25-b4b0-9b592c8a086b schema: type: string - name: current in: 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`. example: false schema: type: boolean default: false - name: timezone in: header description: e.g. UTC required: false schema: type: string example: UTC /admin/meetings: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json;charset=UTF-8: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeetingObjectForAdminListMeeting' description: Meetings array. example: items: - id: 870f51ff287b41be84648412901e0402_20191101T120000Z meetingSeriesId: 870f51ff287b41be84648412901e0402 meetingNumber: '123456789' title: Example Daily Meeting meetingType: scheduledMeeting state: ready hostDidJoin: true attendeeDidJoin: true isModified: false timezone: UTC start: '2019-11-01T12:00:00Z' end: '2019-11-01T13:00:00Z' hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com siteUrl: site4-example.webex.com enabledAutoRecordMeeting: false allowAnyUserToBeCoHost: false enabledJoinBeforeHost: false enableConnectAudioBeforeHost: false joinBeforeHostMinutes: 0 excludePassword: false publicMeeting: false reminderTime: 10 unlockedMeetingJoinSecurity: allowJoin sessionTypeId: 3 enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false telephony: callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers method: GET 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 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions method: GET trackingCodes: - name: Department value: Engineering - name: Division value: Full-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 10 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: false entryAndExitTone: beep allowHostToUnmuteParticipants: false allowAttendeeToUnmuteSelf: true muteAttendeeUponEntry: false enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meetings By an Admin operationId: adminListMeetings description: '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 listed, but the ended and ongoing ad-hoc meeting instances will be listed. The following sensitive attributes are hidden from the response: `agenda`, `hostKey`, `password`, `phoneAndVideoSystemPassword`, `panelistPassword`, `phoneAndVideoSystemPanelistPassword`, `webLink`, `sipAddress`, `dialInIpAddress`, `registration` and `telephony.accessCode`. * If `meetingNumber` is specified, the operation returns an array of meeting objects specified by the `meetingNumber`. Each object in the array can be a scheduled meeting or a meeting series depending on whether the `current` parameter is `true` or `false`, and each object contains the simultaneous interpretation object. Please note that `meetingNumber` and `webLink` are mutually exclusive and they cannot be specified simultaneously. * If `webLink` is specified, the operation returns an array of meeting objects specified by the `webLink`. Each object in the array can be a scheduled meeting or a meeting series depending on whether the `current` parameter is `true` or `false`, and each object contains the simultaneous interpretation object. Please note that `meetingNumber` and `webLink` are mutually exclusive and they cannot be specified simultaneously. * The `current` parameter only applies to meeting series. If it''s `false`, the `start` and `end` attributes of each returned meeting series object are for the first scheduled meeting of that series. If it''s `true` or not specified, the `start` and `end` attributes are for the scheduled meeting which is ready to start or join or the upcoming scheduled meeting of that series. * To learn more about which attributes are available for different meeting states, please refer to [Available Meeting Attributes for Different Meeting States](/docs/meetings#available-meeting-attributes-for-different-meeting-states). #### Request Header * `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.' tags: - Meetings parameters: - name: meetingNumber in: 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. example: '123456789' schema: type: string - name: webLink in: query description: URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. example: https%3A%2F%2Fgo.webex.com%2Fgo%2Fj.php%3FMTID%3Dm066878aef4343e74c98b48439b71acfd schema: type: string - name: current in: 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`. example: false schema: type: boolean default: true - name: timezone in: header description: e.g. UTC required: false schema: type: string example: UTC /meetings: post: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingSeriesObject' example: id: 870f51ff287b41be84648412901e0402 meetingNumber: '123456789' title: Example Daily Meeting agenda: Example Agenda password: BgJep@43 phoneAndVideoSystemPassword: '12345678' meetingType: meetingSeries state: active timezone: Asia/Shanghai start: '2019-11-01T20:00:00+08:00' end: '2019-11-01T21:00:00+08:00' recurrence: FREQ=DAILY;COUNT=10;INTERVAL=1 hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com hostKey: '123456' siteUrl: site4-example.webex.com webLink: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e registerLink: https://cisco.webex.com/weblink/register/r55981368ee48e2a6f00b93231508c404 sipAddress: 123456789@site4-example.webex.com dialInIpAddress: 192.168.100.100 enabledAutoRecordMeeting: false allowAnyUserToBeCoHost: false enabledJoinBeforeHost: false enableConnectAudioBeforeHost: false joinBeforeHostMinutes: 0 excludePassword: false publicMeeting: false reminderTime: 10 unlockedMeetingJoinSecurity: allowJoin sessionTypeId: 3 enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers method: GET 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 requireCompanyName: true requireCountryRegion: false requireWorkPhone: true enabledRegistrationId: false customizedQuestions: - id: '3386787' question: What color do you like? required: true type: checkbox options: - id: '1' value: green - id: '2' value: black - id: '3' value: yellow - id: '4' value: red rules: - condition: notEquals value: red result: reject matchCase: true order: 1 - id: '3386792' question: Project Team required: false type: singleLineTextBox maxLength: 120 - id: '3386797' question: How are you required: false type: multiLineTextBox maxLength: 999 - id: '3386802' question: Dropdownlist Q required: false type: dropdownList options: - id: '1' value: A1 - id: '2' value: A2 - id: '3386891' question: weather required: false type: radioButtons maxLength: 120 options: - id: '1' value: sunny - id: '2' value: rain rules: - question: lastName condition: endsWith value: tom result: reject matchCase: false order: 1 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting simultaneousInterpretation: enabled: true interpreters: - id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann - id: 3GQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MAJiZDBjNWVlNDC4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: fr email: antoine.martin@example.com displayName: Martin enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions method: GET trackingCodes: - name: Department value: Engineering - name: Division value: Full-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 10 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: false entryAndExitTone: beep allowHostToUnmuteParticipants: false allowAttendeeToUnmuteSelf: true muteAttendeeUponEntry: false enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 '400': description: Bad Request headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The input parameters contain invalid items. errors: - description: Meeting password validation failed. A mix of uppercase and lowercase letters (A, a, B, b, C, c, etc.) is required. trackingId: 19085D1FCFEE445DA358375500D25E44_1598154356721 '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Meeting operationId: createMeeting description: '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. * The `spark:all` scope is required when `roomId` is specified. * 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 immediately after being created for a quick collaboration. There''s only one ad-hoc meeting for a room at the same time. So, if there''s already an ongoing ad-hoc meeting for the room, the API returns this ongoing meeting instead of creating a new one. If it''s a [direct](/docs/api/v1/rooms/get-room-details) room, both members of the room can create an ad-hoc meeting for the room. If it''s a [group](/docs/api/v1/rooms/get-room-details) room, only room members that are in the same [organization](/docs/api/v1/organizations/get-organization-details) as the room can create an ad-hoc meeting for the room. Please note that an ad-hoc meeting is for the purpose of an instant collaboration with people in a room, user should not persist the `id` and `meetingNumber` of the ad-hoc meeting when it''s been created since this meeting may become an inactive ad-hoc meeting for the room if it''s not been started after being created for a while or it has been started and ended. Each time a user needs an ad-hoc meeting for a room, they should create one instead of reusing the previous persisted one. Moreover, for the same reason, no email will be sent when an ad-hoc meeting is created. Ad-hoc meetings cannot be updated by [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) or deleted by [Delete a Meeting](/docs/api/v1/meetings/delete-a-meeting). Ad-hoc meetings cannot be listed by [List Meetings](/docs/api/v1/meetings/list-meetings) and the scheduled meetings of an ad-hoc meeting cannot be listed by [List Meetings of a Meeting Series](/docs/api/v1/meetings/list-meetings-of-a-meeting-series), but the ended and ongoing instances of ad-hoc meetings can be listed by [List Meetings](/docs/api/v1/meetings/list-meetings) and [List Meetings of a Meeting Series](/docs/api/v1/meetings/list-meetings-of-a-meeting-series). * If the parameter `adhoc` is `true`, `roomId` is required and the others are optional or ignored. * The default value of `title` for an ad-hoc meeting is the user''s name if not specified. The following parameters for an ad-hoc meeting have default values and the user''s input values will be ignored: `scheduledType` is always `meeting`; `start` and `end` are 5 minutes after the current time and 20 minutes after the current time respectively; `timezone` is `UTC`; `allowAnyUserToBeCoHost`, `allowAuthenticatedDevices`, `enabledJoinBeforeHost`, `enableConnectAudioBeforeHost` are always `true`; `allowFirstUserToBeCoHost`, `enableAutomaticLock`, `publicMeeting`, `sendEmail` are always `false`; `invitees` is the room members except "me"; `joinBeforeHostMinutes` is 5; `automaticLockMinutes` is null; `unlockedMeetingJoinSecurity` is `allowJoinWithLobby`. An ad-hoc meeting can be started immediately even if the `start` is 5 minutes after the current time. * The following parameters are not supported and will be ignored for an ad-hoc meeting: `templateId`, `recurrence`, `excludePassword`, `reminderTime`, `registration`, `integrationTags`, `enabledWebcastView`, and `panelistPassword`. * If the value of the parameter `recurrence` is null, a non-recurring meeting is created. * If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting. * If the parameter `templateId` has a value, the meeting is created based on the meeting template specified by `templateId`. The list of meeting templates that is available for the authenticated user can be retrieved from [List Meeting Templates](/docs/api/v1/meetings/list-meeting-templates). * If the parameter `siteUrl` has a value, the meeting is created on the specified site. Otherwise, the meeting is created on the user''s preferred site. All available Webex sites and preferred site of the user can be retrieved by `Get Site List` API. * If the parameter `scheduledType` equals "personalRoomMeeting", the meeting is created in the user''s [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings). * If the parameter `roomId` has a value, the meeting is created for the Webex space specified by `roomId`. If `roomId` is specified but the user calling the API is not a member of the Webex space specified by `roomId`, the API will fail even if the user has the admin-level scopes or he is calling the API on behalf of another user which is specified by `hostEmail` and is a member of the Webex space. * If the parameter `enabledAudioWatermark` is `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. * If the parameter `enabledVisualWatermark` is `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. * The default value of `visualWatermarkOpacity` is 10 if not specified. 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`. * When `enabledLiveStream` is `true`, `liveStream` must be specified. With these setting, the RTMP streaming specified by `liveStream.rtmpUrl` can be started and viewed during the meeting without any ad-hoc settings. * The `registration` can be specified when creating a meeting, but it can''t be updated by [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) or [Patch a Meeting](/docs/api/v1/meetings/patch-a-meeting). Create a registration form for a meeting that doesn''t have one or update the registration form for a meeting that already has one by using [Update Meeting Registration Form](/docs/api/v1/meetings/update-meeting-registration-form). Delete the registration form for a meeting by using [Delete Meeting Registration Form](/docs/api/v1/meetings/delete-meeting-registration-form). * You can''t create a meeting that starts 10 years or more in the future. * If all meeting invitees of a meeting should not receive emails, the host can create a meeting with invitees, and the parameter `sendEmail` is set to `false`. If only some meeting invitees should not receive emails and others can, the host should not invite these invitees along with creating a meeting request. Instead, the host should add the invitees by [Create a Meeting Invitee](/docs/api/v1/meeting-invitees/create-a-meeting-invitee) or [Create Meeting Invitees](/docs/api/v1/meeting-invitees/create-meeting-invitees) with the parameter `sendEmail` is set to `false` after the meeting has been created.' tags: - Meetings parameters: [] requestBody: content: application/json: example: title: Example Daily Meeting agenda: Example Agenda password: BgJep@43 start: '2019-11-01 20:00:00' end: '2019-11-01 21:00:00' timezone: Asia/Shanghai recurrence: FREQ=DAILY;INTERVAL=1;COUNT=10 enabledAutoRecordMeeting: false allowAnyUserToBeCoHost: false enabledJoinBeforeHost: false enableConnectAudioBeforeHost: false joinBeforeHostMinutes: 0 excludePassword: false publicMeeting: false reminderTime: 10 unlockedMeetingJoinSecurity: allowJoin enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false invitees: - email: john.andersen@example.com displayName: John Andersen coHost: false panelist: false - email: brenda.song@example.com displayName: Brenda Song coHost: false panelist: false sendEmail: true hostEmail: john.andersen@example.com siteUrl: site4-example.webex.com registration: requireFirstName: true requireLastName: true requireEmail: true requireCompanyName: true requireCountryRegion: false requireWorkPhone: true enabledRegistrationId: false customizedQuestions: - question: What color do you like? required: true type: checkbox options: - value: green - value: black - value: yellow - value: red rules: - condition: notEquals value: red result: reject matchCase: true - question: Project Team type: singleLineTextBox maxLength: 120 - question: How are you type: multiLineTextBox - question: Dropdownlist Q type: dropdownList options: - value: A1 - value: A2 - question: weather required: false type: radioButtons maxLength: 120 options: - value: sunny - value: rain rules: - question: lastName condition: endsWith value: tom result: reject matchCase: false order: 1 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 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 enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 10 scheduledType: meeting audioConnectionOptions: audioConnectionType: VoIP enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 schema: $ref: '#/components/schemas/CreateMeetingObject' get: responses: '200': description: OK headers: Link: schema: type: string content: application/json;charset=UTF-8: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeetingObjectForListMeeting' description: Meetings array. example: items: - id: 870f51ff287b41be84648412901e0402_20191101T120000Z meetingSeriesId: 870f51ff287b41be84648412901e0402 meetingNumber: '123456789' title: Example Daily Meeting agenda: Example Agenda password: BgJep@43 phoneAndVideoSystemPassword: '12345678' meetingType: scheduledMeeting state: ready hostDidJoin: true attendeeDidJoin: true isModified: false timezone: UTC start: '2019-11-01T12:00:00Z' end: '2019-11-01T13:00:00Z' hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com hostKey: '123456' siteUrl: site4-example.webex.com webLink: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e sipAddress: 123456789@site4-example.webex.com dialInIpAddress: 192.168.100.100 enabledAutoRecordMeeting: false allowAnyUserToBeCoHost: false enabledJoinBeforeHost: false enableConnectAudioBeforeHost: false joinBeforeHostMinutes: 0 excludePassword: false publicMeeting: false reminderTime: 10 unlockedMeetingJoinSecurity: allowJoin sessionTypeId: 3 enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers method: GET 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 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions method: GET trackingCodes: - name: Department value: Engineering - name: Division value: Full-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 10 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: false entryAndExitTone: beep allowHostToUnmuteParticipants: false allowAttendeeToUnmuteSelf: true muteAttendeeUponEntry: false enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 - id: 870f51ff287b41be84648412901e0402_I_167427437874906709 meetingSeriesId: 870f51ff287b41be84648412901e0402 scheduledMeetingId: 870f51ff287b41be84648412901e0402_20191101T120000Z title: Example Daily Meeting agenda: Example Agenda password: BgJep@43 meetingType: meeting excludePassword: false publicMeeting: false enableAutomaticLock: false sessionTypeId: 3 state: ended timezone: UTC start: '2019-11-01T12:12:15Z' end: '2019-11-01T12:51:33Z' hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com hostKey: '123456' siteUrl: site4-example.webex.com webLink: https://site4-example.webex.com/site4/j.php?MTID=870f51ff287b41be84648412901e0402_I_167427437874906709 hasChat: true hasRecording: true hasTranscription: true hasSummary: true hasClosedCaption: true hasPolls: true hasQA: true hasSlido: true telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers method: GET 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 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions method: GET enabledVisualWatermark: true visualWatermarkOpacity: 10 audioConnectionOptions: audioConnectionType: webexAudio enabledTollFreeCallIn: true enabledGlobalCallIn: true enabledAudienceCallBack: false entryAndExitTone: beep allowHostToUnmuteParticipants: false allowAttendeeToUnmuteSelf: true muteAttendeeUponEntry: false enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 - id: 870f51ff287b41be84648412901e0402_20191102T120000Z meetingSeriesId: 870f51ff287b41be84648412901e0402 meetingNumber: '123456789' title: Example Daily Meeting agenda: Example Agenda password: BgJep@43 phoneAndVideoSystemPassword: '12345678' meetingType: scheduledMeeting state: scheduled isModified: false timezone: UTC start: '2019-11-02T12:00:00Z' end: '2019-11-02T13:00:00Z' hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com hostKey: '123456' siteUrl: site4-example.webex.com webLink: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e sipAddress: 123456789@site4-example.webex.com dialInIpAddress: 192.168.100.100 enabledAutoRecordMeeting: false allowAnyUserToBeCoHost: false enabledJoinBeforeHost: false enableConnectAudioBeforeHost: false joinBeforeHostMinutes: 0 excludePassword: false publicMeeting: false reminderTime: 10 unlockedMeetingJoinSecurity: allowJoin sessionTypeId: 3 enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers method: GET 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 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions method: GET trackingCodes: - name: Department value: Engineering - name: Division value: Full-time enabledAudioWatermark: false enabledVisualWatermark: false audioConnectionOptions: audioConnectionType: webexAudio enabledTollFreeCallIn: true enabledGlobalCallIn: true enabledAudienceCallBack: false entryAndExitTone: beep allowHostToUnmuteParticipants: false allowAttendeeToUnmuteSelf: true muteAttendeeUponEntry: false enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 - id: 870f51ff287b41be84648412901e0402_I_167549011372279170 meetingSeriesId: 870f51ff287b41be84648412901e0402 scheduledMeetingId: 870f51ff287b41be84648412901e0402_20191101T120000Z title: Example Daily Meeting agenda: Example Agenda password: BgJep@43 meetingType: meeting state: ended excludePassword: false publicMeeting: false sessionTypeId: 3 enableAutomaticLock: false timezone: UTC start: '2019-11-02T12:07:30Z' end: '2019-11-02T12:58:53Z' hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com hostKey: '123456' siteUrl: site4-example.webex.com webLink: https://site4-example.webex.com/site4/j.php?MTID=870f51ff287b41be84648412901e0402_I_167549011372279170 hasChat: true hasRecording: true hasTranscription: true hasSummary: true hasClosedCaption: true hasPolls: true hasQA: true hasSlido: true telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers method: GET 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 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions method: GET enabledAudioWatermark: false enabledVisualWatermark: true visualWatermarkOpacity: 10 audioConnectionOptions: audioConnectionType: webexAudio enabledTollFreeCallIn: true enabledGlobalCallIn: true enabledAudienceCallBack: false entryAndExitTone: beep allowHostToUnmuteParticipants: false allowAttendeeToUnmuteSelf: true muteAttendeeUponEntry: false enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meetings operationId: listMeetings description: '
The previous `List Meetings of a Meeting Series` API is merged into the [List Meetings](/docs/api/v1/meetings/list-meetings) API.
Retrieves 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 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 listed, but the ended and ongoing ad-hoc meeting instances will be listed. Lists scheduled meeting and meeting instances of a meeting series identified by `meetingSeriesId`. Scheduled meetings of an ad-hoc meeting created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` are not listed, but the ended and ongoing meeting instances of it are. Each _scheduled meeting_ or _meeting_ instance of a _meeting series_ has its own `start`, `end`, etc. Thus, for example, when a daily meeting has been scheduled from `2019-04-01` to `2019-04-10`, there are 10 scheduled meeting instances in this series, one instance for each day, and each one has its own attributes. When a scheduled meeting has been started and ended or is happening, there are even more ended or in-progress meeting instances. Long result sets are split into [pages](/docs/basics#pagination). * The default value of `meetingSeries` will be used if `meetingType` is not specified. When listing meetings with `meetingType=meetingSeries` implicitly or explicitly, the API returns all the recurring meeting series where the user is the meeting host or an invitee to the meeting. Please note that a meeting with no `recurrence` attribute is considered a meeting series with only one occurrence and it can also be listed with `meetingType=meetingSeries`. A recurring meeting series may have multiple occurrences which are scattered over weeks, months, or years. So, any meeting series that overlaps with the time range specified by `from` and `to` will be listed. For example, a monthly meeting series with `start=2024-01-01T10:00:00Z`, `end=2024-01-01T11:00:00Z` and `recurrence=FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=1;UNTIL=20250210T000000Z` can be listed with `meetingType=meetingSeries&from=2024-10-01&to=2024-11-01` even if the `start` and `end` are not in the specified time range. * If `meetingType` is specified and equals `meeting`, it lists ongoing and ended instances of the meeting series. The default value of `from` and `to` is: `from` equals the current date and time minus 7 days, and `to` equals the current date and time. * If `meetingSeriesId` is specified, `meetingNumber`, `webLink`, `roomId`, `current`, `integrationTag`, `scheduledType`, `siteUrl` will be ignored. * If `meetingNumber` is specified, the operation returns an array of meeting objects specified by the `meetingNumber`. Each object in the array can be a scheduled meeting or a meeting series depending on whether the `current` parameter is `true` or `false`, and each object contains the simultaneous interpretation object. When `meetingNumber` is specified, parameters of `from`, `to`, `meetingType`, `state`, `isModified` and `siteUrl` will be ignored. Please note that `meetingNumber`, `webLink` and `roomId` are mutually exclusive and they cannot be specified simultaneously. * If `webLink` is specified, the operation returns an array of meeting objects specified by the `webLink`. Each object in the array can be a scheduled meeting or a meeting series depending on whether the `current` parameter is `true` or `false`, and each object contains the simultaneous interpretation object. When `webLink` is specified, parameters of `from`, `to`, `meetingType`, `state`, `isModified` and `siteUrl` will be ignored. Please note that `meetingNumber`, `webLink` and `roomId` are mutually exclusive and they cannot be specified simultaneously. * If `roomId` is specified, the operation returns an array of meeting objects of the Webex space specified by the `roomId`. When `roomId` is specified, parameters of `current`, `meetingType`, `state` and `isModified` will be ignored. The meeting objects are queried on the user''s preferred site if no `siteUrl` is specified; otherwise, queried on the specified site. `meetingNumber`, `webLink` and `roomId` are mutually exclusive and they cannot be specified simultaneously. * If `state` parameter is specified, the returned array only has items in the specified state. If `state` is not specified, return items of all states. * If `meetingType` equals "meetingSeries", the `scheduledType` parameter can be "meeting", "webinar" or null. If `scheduledType` is specified, the returned array only has items of the specified scheduled type; otherwise, it has items of "meeting" and "webinar". * If `meetingType` equals "scheduledMeeting", the `scheduledType` parameter can be "meeting", "webinar", "personalRoomMeeting" or null. If `scheduledType` is specified, the returned array only has items of the specified scheduled type; otherwise, it has items of all scheduled types. * If `meetingType` equals "meeting", the `scheduledType` parameter can be "meeting", "webinar" or null. If `scheduledType` is specified, the returned array only has items of the specified scheduled type; otherwise, it has items of "meeting" and "webinar". Please note that ended or in-progress meeting instances of [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) also fall into the category of "meeting" `scheduledType`. * If `meetingType` equals "meeting", a maximum of 10000 meeting instances can be listed even if pagination is enabled. * If `isModified` parameter is specified, the returned array only has items which have been modified to exceptional meetings. This parameter only applies to scheduled meeting. * If any of the `hasChat`, `hasRecording`, `hasTranscription`, `hasSummary`, `hasClosedCaption`, `hasPolls `, `hasQA` and `hasSlido` parameters is specified, the `meetingType` must be "meeting" and `state` must be "ended". These parameters are null by default. * The `current` parameter only applies to meeting series. If it''s `false`, the `start` and `end` attributes of each returned meeting series object are for the first scheduled meeting of that series. If it''s `true` or not specified, the `start` and `end` attributes are for the scheduled meeting which is ready to start or join or the upcoming scheduled meeting of that series. * If `from` and `to` are specified, the operation returns an array of meeting objects in that specified time range. * If the parameter `siteUrl` has a value, the operation lists meetings on the specified site; otherwise, lists meetings on the user''s all sites. All available Webex sites of the user can be retrieved by `Get Site List` API. * `trackingCodes` is not supported for ended meeting instances. * A full admin or a content admin can list all the ended and ongoing meeting instances of the organization he manages with the `meeting:admin_schedule_read` scope and `meetingType=meeting` parameter. * To learn more about which attributes are available for different meeting states, please refer to [Available Meeting Attributes for Different Meeting States](/docs/meetings#available-meeting-attributes-for-different-meeting-states). #### Request Header * `password`: Meeting password. Required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost or invitee of the meeting. * `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.' tags: - Meetings parameters: - name: meetingNumber in: 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. example: '123456789' schema: type: string - name: webLink in: query description: URL encoded link to information page for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive. example: https%3A%2F%2Fgo.webex.com%2Fgo%2Fj.php%3FMTID%3Dm066878aef4343e74c98b48439b71acfd schema: type: string - name: roomId in: query description: Associated Webex space ID for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive. example: Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2 schema: type: string - name: meetingSeriesId in: 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. required: false example: 25bbf831-5be9-4c25-b4b0-9b592c8a086b schema: type: string - name: max in: 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. example: 100 schema: type: number - name: from in: 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. When `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.' example: '2019-03-18T09:30:00+08:00' schema: type: string - name: to in: 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. When `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.' example: '2019-03-25T09:30:00+08:00' schema: type: string - name: meetingType in: query description: Meeting type for the meeting objects being requested. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified. example: scheduledMeeting schema: type: string enum: - meetingSeries - scheduledMeeting - meeting - name: state in: 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. example: inProgress schema: type: string enum: - active - scheduled - ready - lobby - inProgress - ended - missed - expired - name: scheduledType in: query description: Scheduled type for the meeting objects being requested. example: personalRoomMeeting schema: type: string enum: - meeting - webinar - personalRoomMeeting - name: isModified in: 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. example: false schema: type: boolean default: false - name: hasChat in: 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. example: false schema: type: boolean default: false - name: hasRecording in: 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. example: false schema: type: boolean default: false - name: hasTranscription in: 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. example: false schema: type: boolean default: false - name: hasSummary in: 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. example: false schema: type: boolean default: false - name: hasClosedCaption in: 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. example: false schema: type: boolean default: false - name: hasPolls in: 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. example: false schema: type: boolean default: false - name: hasQA in: 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. example: false schema: type: boolean default: false - name: hasSlido in: 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. example: false schema: type: boolean default: false - name: current in: 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. example: false schema: type: boolean default: true - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string - name: siteUrl in: 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. example: example.webex.com schema: type: string - name: integrationTag in: 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". example: dbaeceebea5c4a63ac9d5ef1edfe36b9 schema: type: string - name: password in: header description: e.g. BgJep@4323 required: false schema: type: string example: BgJep@4323 - name: timezone in: header description: e.g. UTC required: false schema: type: string example: UTC /meetings/{meetingId}: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingSeriesObject' example: id: 870f51ff287b41be84648412901e0402 meetingNumber: '123456789' title: Example Daily Meeting agenda: Example Agenda password: BgJep@43 phoneAndVideoSystemPassword: '12345678' meetingType: meetingSeries state: active timezone: UTC start: '2019-11-01T12:00:00Z' end: '2019-11-01T13:00:00Z' recurrence: FREQ=DAILY;COUNT=10;INTERVAL=1 hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com hostKey: '123456' siteUrl: site4-example.webex.com webLink: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e sipAddress: 123456789@site4-example.webex.com dialInIpAddress: 192.168.100.100 enabledAutoRecordMeeting: false allowAnyUserToBeCoHost: false enabledJoinBeforeHost: false enableConnectAudioBeforeHost: false joinBeforeHostMinutes: 0 excludePassword: false publicMeeting: false reminderTime: 10 unlockedMeetingJoinSecurity: allowJoin enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: false telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers method: GET 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: true requireAddress1: false requireAddress2: false requireCity: false requireState: false requireZipCode: false requireCountryRegion: true requireWorkPhone: true requireFax: false enabledRegistrationId: false customizedQuestions: - id: '3386787' question: What color do you like? required: true type: checkbox options: - id: '1' value: green - id: '2' value: black - id: '3' value: yellow - id: '4' value: red rules: - condition: notEquals value: red result: reject matchCase: true order: 1 - id: '3386792' question: Project Team required: false type: singleLineTextBox maxLength: 120 - id: '3386797' question: How are you required: false type: multiLineTextBox maxLength: 999 - id: '3386802' question: Dropdownlist Q required: false type: dropdownList options: - id: '1' value: A1 - id: '2' value: A2 - id: '3386891' question: weather required: false type: radioButtons maxLength: 120 options: - id: '1' value: sunny - id: '2' value: rain rules: - question: lastName condition: endsWith value: tom result: reject matchCase: false order: 1 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting simultaneousInterpretation: enabled: true interpreters: - id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann - id: 3GQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MAJiZDBjNWVlNDC4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: fr email: antoine.martin@example.com displayName: Martin enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions method: GET trackingCodes: - name: Department value: Engineering - name: Division value: Full-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 10 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: false entryAndExitTone: beep allowHostToUnmuteParticipants: false allowAttendeeToUnmuteSelf: true muteAttendeeUponEntry: false enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Meeting operationId: getMeetingById description: 'Retrieves details for a meeting with a specified meeting ID. * 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. * 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 meeting series. * If the `meetingId` value specified is for a scheduled meeting from a meeting series, the operation returns details for that scheduled meeting. * If the `meetingId` value specified is for a meeting instance which is happening or has happened, the operation returns details for that meeting instance. * `trackingCodes` is not supported for ended meeting instances. * To learn more about which attributes are available for different meeting states, please refer to [Available Meeting Attributes for Different Meeting States](/docs/meetings#available-meeting-attributes-for-different-meeting-states). #### Request Header * `password`: Meeting password. Required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost or invitee of the meeting. * `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.' tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting being requested. required: true example: 25bbf831-5be9-4c25-b4b0-9b592c8a086b schema: type: string - name: current in: 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. example: false schema: type: boolean default: false - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string - name: password in: header description: e.g. BgJep@4323 required: false schema: type: string example: BgJep@4323 - name: timezone in: header description: e.g. UTC required: false schema: type: string example: UTC patch: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingObjectForListMeeting' example: id: 1d824a4a205042eba9574e00b711b226_20200127T120000Z meetingSeriesId: 1d824a4a205042eba9574e00b711b226 meetingNumber: '123456789' title: Example Daily Meeting Modified agenda: Example Agenda Modified password: P@ssword789 phoneAndVideoSystemPassword: '12345678' meetingType: scheduledMeeting state: scheduled isModified: true timezone: Asia/Shanghai start: '2020-01-27T20:30:00+08:00' end: '2020-01-27T21:30:00+08:00' hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com hostKey: '123456' siteUrl: site4-example.webex.com webLink: https://site4-example.webex.com/site4/j.php?MTID=m31a1db24db78ac569f739e0cfb2741c1 sipAddress: 123456789@site4-example.webex.com dialInIpAddress: 192.168.100.100 enabledAutoRecordMeeting: true allowAnyUserToBeCoHost: true enabledJoinBeforeHost: true enableConnectAudioBeforeHost: true joinBeforeHostMinutes: 15 excludePassword: false publicMeeting: false reminderTime: 30 unlockedMeetingJoinSecurity: allowJoin sessionTypeId: 3 enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: true telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/1d824a4a205042eba9574e00b711b226_20200127T120000Z/globalCallinNumbers method: GET 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: true requireAddress1: false requireAddress2: false requireCity: false requireState: false requireZipCode: false requireCountryRegion: true requireWorkPhone: true requireFax: false enabledRegistrationId: false integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting simultaneousInterpretation: enabled: true interpreters: - id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/1d824a4a205042eba9574e00b711b226/breakoutSessions method: GET trackingCodes: - name: Department value: Sales - name: Division value: Part-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 40 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: true entryAndExitTone: beep allowHostToUnmuteParticipants: true allowAttendeeToUnmuteSelf: false muteAttendeeUponEntry: true enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Patch a Meeting operationId: patchMeeting description: '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. * 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 meeting series. * If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated. * The `agenda`, `recurrence`, and `trackingCodes` attributes can be specified as `null` so that these attributes become null and hidden from the response after the patch. Note that it''s the keyword `null` not the string "null". * If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting. * You can''t update a meeting that starts 10 years or more in the future. * Updating a meeting in the API that was created via a calendar connector is not allowed. The meeting may be updated in Webex, but the calendar event may not be updated, resulting in duplicate entries. This action is therefore blocked. In case you must overwrite this behavior, please contact devsupport@webex.com.' tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 1d824a4a205042eba9574e00b711b226_20200127T120000Z schema: type: string requestBody: content: application/json-patch+json: example: title: Example Daily Meeting Modified agenda: Example Agenda Modified password: P@ssword789 timezone: Asia/Shanghai start: '2020-01-27T20:30:00+08:00' end: '2020-01-27T21:30:00+08:00' enabledAutoRecordMeeting: true allowAnyUserToBeCoHost: true enabledJoinBeforeHost: true enableConnectAudioBeforeHost: true joinBeforeHostMinutes: 15 excludePassword: false publicMeeting: false reminderTime: 30 unlockedMeetingJoinSecurity: allowJoin enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: true sendEmail: true hostEmail: john.andersen@example.com 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 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 enabledBreakoutSessions: true trackingCodes: - name: Department value: Sales - name: Division value: Part-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 40 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: true entryAndExitTone: beep allowHostToUnmuteParticipants: true allowAttendeeToUnmuteSelf: false muteAttendeeUponEntry: true enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 schema: $ref: '#/components/schemas/PatchMeetingObject' put: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingObjectForListMeeting' example: id: 1d824a4a205042eba9574e00b711b226_20200127T120000Z meetingSeriesId: 1d824a4a205042eba9574e00b711b226 meetingNumber: '123456789' title: Example Daily Meeting Modified agenda: Example Agenda Modified password: P@ssword789 phoneAndVideoSystemPassword: '12345678' meetingType: scheduledMeeting state: scheduled isModified: true timezone: Asia/Shanghai start: '2020-01-27T20:30:00+08:00' end: '2020-01-27T21:30:00+08:00' hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY hostDisplayName: John Andersen hostEmail: john.andersen@example.com hostKey: '123456' siteUrl: site4-example.webex.com webLink: https://site4-example.webex.com/site4/j.php?MTID=m31a1db24db78ac569f739e0cfb2741c1 sipAddress: 123456789@site4-example.webex.com dialInIpAddress: 192.168.100.100 enabledAutoRecordMeeting: true allowAnyUserToBeCoHost: true enabledJoinBeforeHost: true enableConnectAudioBeforeHost: true joinBeforeHostMinutes: 15 excludePassword: false publicMeeting: false reminderTime: 30 unlockedMeetingJoinSecurity: allowJoin sessionTypeId: 3 enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: true telephony: accessCode: '1234567890' callInNumbers: - label: US Toll callInNumber: '123456789' tollType: toll links: - rel: globalCallinNumbers href: /api/v1/meetings/1d824a4a205042eba9574e00b711b226_20200127T120000Z/globalCallinNumbers method: GET 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: true requireAddress1: false requireAddress2: false requireCity: false requireState: false requireZipCode: false requireCountryRegion: true requireWorkPhone: true requireFax: false enabledRegistrationId: false integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 scheduledType: meeting simultaneousInterpretation: enabled: true interpreters: - id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann enabledBreakoutSessions: true links: - rel: breakoutSessions href: /v1/meetings/1d824a4a205042eba9574e00b711b226/breakoutSessions method: GET trackingCodes: - name: Department value: Sales - name: Division value: Part-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 40 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: true entryAndExitTone: beep allowHostToUnmuteParticipants: true allowAttendeeToUnmuteSelf: false muteAttendeeUponEntry: true enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Meeting operationId: updateMeeting description: '
The PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.
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. * 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 meeting series. * If the `meetingId` value specified is for a meeting series, the operation updates the entire meeting series. **Note**: If the value of `start`, `end`, or `recurrence` for the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated. * If the parameter `recurrence` has a value, a recurring meeting is created based on the rule defined by the value of `recurrence`. For a non-recurring meeting which has no `recurrence` value set, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting. * You can''t update a meeting that starts 10 years or more in the future. * Updating a meeting created using the API via a calendar connector is not supported. While the meeting may be updated in Webex, the calendar event may not be updated resulting in duplicate entries. If you need to override this behavior, contact devsupport@webex.com.' tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 1d824a4a205042eba9574e00b711b226_20200127T120000Z schema: type: string requestBody: content: application/json: example: title: Example Daily Meeting Modified agenda: Example Agenda Modified password: P@ssword789 timezone: Asia/Shanghai start: '2020-01-27T20:30:00+08:00' end: '2020-01-27T21:30:00+08:00' enabledAutoRecordMeeting: true allowAnyUserToBeCoHost: true enabledJoinBeforeHost: true enableConnectAudioBeforeHost: true joinBeforeHostMinutes: 15 excludePassword: false publicMeeting: false reminderTime: 30 unlockedMeetingJoinSecurity: allowJoin enableAutomaticLock: false automaticLockMinutes: 0 allowFirstUserToBeCoHost: false allowAuthenticatedDevices: true sendEmail: true hostEmail: john.andersen@example.com 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 integrationTags: - dbaeceebea5c4a63ac9d5ef1edfe36b9 - 85e1d6319aa94c0583a6891280e3437d - 27226d1311b947f3a68d6bdf8e4e19a1 enabledBreakoutSessions: true trackingCodes: - name: Department value: Sales - name: Division value: Part-time enabledAudioWatermark: true enabledVisualWatermark: true visualWatermarkOpacity: 40 audioConnectionOptions: audioConnectionType: VoIP enabledTollFreeCallIn: false enabledGlobalCallIn: false enabledAudienceCallBack: true entryAndExitTone: beep allowHostToUnmuteParticipants: true allowAttendeeToUnmuteSelf: false muteAttendeeUponEntry: true enabledLiveStream: true liveStream: destination: Youtube rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming streamUrl: https://example.com/Webex-Streaming/index_a.m3u8 layoutWithoutSharedContent: grid layoutWithSharedContent: stack allowChangeLayoutInMeeting: false followStageLayoutWhenSynced: true resolution: 1920x1080 schema: $ref: '#/components/schemas/UpdateMeetingObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: Not Found headers: {} content: {} '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Meeting operationId: deleteMeeting description: '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. * If the `meetingId` value specified is for a scheduled meeting, the operation deletes that scheduled meeting without impact on other scheduled meeting of the parent meeting series. * If the `meetingId` value specified is for a meeting series, the operation deletes the entire meeting series.' tags: - Meetings parameters: - name: meetingId in: 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. required: true example: e8a6557d3c964824ba346a0800d92575 schema: type: string - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string - name: sendEmail in: query description: Whether or not to send emails to host and invitees. It is an optional field and default value is true. example: true schema: type: boolean default: true /meetings/join: post: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/JoinMeetingLinkObject' example: startLink: https://convergedint.dmz.webex.com/wbxmjs/joinservice/sites/convergedint/meeting/download/b711f29256e54ed780f2a1b7f96d202f?siteurl=convergedint&integrationJoinToken=QUhTSwAAAIXWmx57bQgiYLuAYZvEKAN6taYj3h2th5jIusReBmnOZBLmjPHQIhknV9%2FVOtZTRfvHek%2FbN%2BUA3CcmfqiYEisTZyWhIWboxRG3KGzVQxijZV0z%2B%2FTdXqgX3Cvo%2B3FfO3tIgh1dcP5bprqYxuwJu%2BhW13nctAZPsLuyLaCuADQ%2FsQ%3D%3D&principal=QUhTSwAAAIUNvqV715wdKSiJfpQz9G2uUjyNlBeu0bcNYoXwvYPyHeysQAgve3XrsM83KS10rU34VjuJjPyOi225Po2n3q2MTUmMgIk9hgkDXHxO476xlMoDPsQONMp8vBY9uVybKgBOyTkJsMa%2F2pFES4hk101q&integrationEndUrl=https%3A%2F%2Fconvergedint.dmz.webex.com%2Fmc3300%2Fmeetingcenter%2Fmeetingend%2Fmeetingend.do%3Fsiteurl%3Dconvergedint%26from%3Dmeeting%26backurl%3D joinLink: https://convergedint.dmz.webex.com/wbxmjs/joinservice/sites/convergedint/meeting/download/b711f29256e54ed780f2a1b7f96d202f?siteurl=convergedint&integrationJoinToken=QUhTSwAAAIXWmx57bQgiYLuAYZvEKAN6taYj3h2th5jIusReBmnOZBLmjPHQIhknV9%2FVOtZTRfvHek%2FbN%2BUA3CcmfqiYEisTZyWhIWboxRG3KGzVQxijZV0z%2B%2FTdXqgX3Cvo%2B3FfO3tIgh1dcP5bprqYxuwJu%2BhW13nctAZPsLuyLaCuADQ%2FsQ%3D%3D&principal=QUhTSwAAAIUNvqV715wdKSiJfpQz9G2uUjyNlBeu0bcNYoXwvYPyHeysQAgve3XrsM83KS10rU34VjuJjPyOi225Po2n3q2MTUmMgIk9hgkDXHxO476xlMoDPsQONMp8vBY9uVybKgBOyTkJsMa%2F2pFES4hk101q&integrationEndUrl=https%3A%2F%2Fconvergedint.dmz.webex.com%2Fmc3300%2Fmeetingcenter%2Fmeetingend%2Fmeetingend.do%3Fsiteurl%3Dconvergedint%26from%3Dmeeting%26backurl%3D expiration: '2022-05-30T09:44:08Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Join a Meeting operationId: meetingJoin description: '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. * Please note that `meetingId`, `meetingNumber` and `webLink` are mutually exclusive and they cannot be specified simultaneously. * 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 HTTP response code 200 and `joinLink` will be returned in response body. * Only the meeting host or cohost can generate the `startLink`. * An admin user or a [Service App](/docs/service-apps) can generate the `startLink` and `joinLink` on behalf of another meeting host using the `hostEmail` parameter. When a [Service App](/docs/service-apps) generates the `startLink` and `joinLink`, the `hostEmail` parameter is required. The `hostEmail` parameter only applies to meetings, not webinars. * For Service Apps, `hostEmail` must be provided in the request. * Generating a join link or a start link before the time specified by `joinBeforeHostMinutes` for a webinar is not supported. * The `joinLink` and `startLink` generated by the API only work in a web browser, not in mobile apps. When the `joinLink` or `startLink` is used in a mobile app, the user can''t join or start the meeting directly by the dial-in or dial-out phone numbers displayed in the app. * When `createJoinLinkAsWebLink` or `createStartLinkAsWebLink` is set to true, a user cannot join or start the meeting using the `joinLink` or `startLink` returned in the response, and must complete the login flow. Those options are typically useful if mandatory user login is configured in Control Hub. * Appending the parameter `&launchApp=true` to the weblink will launch directly into the browser experience without showing the user the download selection for the native client. * [Embedded Apps](/docs/embedded-apps) are not supported in a meeting which is started from the `startLink` generated by this API.
When the `email` or `displayName` is omitted from the API request, the backend inserts the data from the user making the request. That may lead to situations where an attendee is shown in the roster with the hostname which should be avoided. In the future, we will make those two fields required.
' tags: - Meetings parameters: [] requestBody: content: application/json: example: meetingId: 98d8c2212c9d62b162b9565932735e59 meetingNumber: '123456789' webLink: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e joinDirectly: false email: brenda.song@example.com displayName: Brenda Song password: BgJep@43 expirationMinutes: 5 hostEmail: john.andersen@example.com createJoinLinkAsWebLink: false createStartLinkAsWebLink: false schema: $ref: '#/components/schemas/JoinMeetingObject' /meetings/templates: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/TemplateObject' description: Meeting templates array. example: 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meeting Templates operationId: listTemplates description: '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 `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. * If `locale` is specified, the operation returns an array of meeting template objects specified by the `locale`; otherwise, returns an array of meeting template objects of the default `en_US` locale. Refer to [Meeting Template Locales](/docs/meetings#meeting-template-locales) for all the locales supported by Webex. * If the parameter `siteUrl` has 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 by `Get Site List` API.' tags: - Meetings parameters: - name: templateType in: query description: Meeting template type for the meeting template objects being requested. If not specified, return meeting templates of all types. example: meeting schema: type: string enum: - meeting - webinar - name: locale in: 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. example: en_US schema: type: string - name: isDefault in: 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. example: false schema: type: boolean - name: isStandard in: 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. example: false schema: type: boolean - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string - name: siteUrl in: 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. example: site4-example.webex.com schema: type: string /meetings/templates/{templateId}: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DetailedTemplateObject' example: 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Meeting Template operationId: getTemplateById description: 'Retrieves details for a meeting template with a specified meeting template ID. #### Request Header * `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.' tags: - Meetings parameters: - name: templateId in: path description: Unique identifier for the meeting template being requested. required: true example: N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM schema: type: string - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string - name: timezone in: header description: e.g. UTC required: false schema: type: string example: UTC /meetings/controls: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Control' example: locked: false recordingStarted: true recordingPaused: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Meeting Control Status operationId: getMeetingControl description: 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. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Control' example: locked: false recordingStarted: true recordingPaused: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Meeting Control Status operationId: updateMeetingControl description: To start, pause, resume, or stop a meeting recording; To lock or unlock an on-going meeting. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string requestBody: content: application/json: example: recordingStarted: true recordingPaused: true locked: true schema: type: object properties: recordingStarted: type: boolean example: true description: The value can be true or false. true means to start the recording, false to end the recording. recordingPaused: type: boolean example: true description: The value can be true or false, will be ignored if 'recordingStarted' sets to false, and true to resume the recording only if the recording is paused vise versa. locked: type: boolean description: The value is true or false. /meetings/sessionTypes: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeetingSessionTypeObject' description: Meeting session type array example: items: - id: '628' name: Webex Meetings EC 2.0 meeting type: meeting attendeesCapacity: 1000 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meeting Session Types operationId: listMeetingSessionTypes description: List all the meeting session types enabled for a given user. tags: - Meetings parameters: - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string - name: siteUrl in: 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. example: site4-example.webex.com schema: type: string /meetings/sessionTypes/{sessionTypeId}: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/MeetingSessionTypeObject' example: id: '628' name: Webex Meetings EC 2.0 meeting type: meeting attendeesCapacity: 1000 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Meeting Session Type operationId: getMeetingSessionTypeById description: Retrieves details for a meeting session type with a specified session type ID. tags: - Meetings parameters: - name: sessionTypeId in: path description: A unique identifier for the sessionType. required: true example: 628 schema: type: number - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string - name: siteUrl in: 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. example: site4-example.webex.com schema: type: string /meetings/{meetingId}/registration: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Registration' example: 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 customizedQuestions: - id: '330521' question: How are you required: true type: singleLineTextBox options: - id: '1' value: green rules: - condition: contains value: tom result: approve matchCase: true order: 1 rules: - question: state condition: contains value: tom result: approve matchCase: true order: 1 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get registration form for a meeting operationId: getMeetingRegistration description: Get a meeting's registration form to understand which fields are required. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: current in: 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. example: false schema: type: boolean default: false - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Registration' example: autoAcceptRequest: false requireFirstName: true requireLastName: true requireEmail: true requireJobTitle: false requireCompanyName: true requireAddress1: false requireAddress2: false requireCity: false requireState: false requireZipCode: false requireCountryRegion: true requireWorkPhone: true requireFax: false enabledRegistrationId: false customizedQuestions: - id: '3386787' question: What color do you like? required: true type: checkbox options: - id: '1' value: green - id: '2' value: black - id: '3' value: yellow - id: '4' value: red rules: - condition: notEquals value: red result: reject matchCase: true order: 1 - id: '3386792' question: Project Team required: false type: singleLineTextBox maxLength: 120 - id: '3386797' question: How are you required: false type: multiLineTextBox maxLength: 999 - id: '3386802' question: DropDownList Q required: false type: dropdownList options: - id: '1' value: A1 - id: '2' value: A2 - id: '3386891' question: weather required: false type: radioButtons maxLength: 120 options: - id: '1' value: sunny - id: '2' value: rain rules: - question: lastName condition: endsWith value: tom result: reject matchCase: false order: 1 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Meeting Registration Form operationId: updateMeetingRegistration description: Enable or update a registration form for a meeting. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string requestBody: content: application/json: example: hostEmail: john.andersen@example.com requireFirstName: true requireLastName: true requireEmail: true requireCompanyName: true requireCountryRegion: true requireWorkPhone: true enabledRegistrationId: false customizedQuestions: - question: What color do you like? required: true type: checkbox options: - value: green - value: black - value: yellow - value: red rules: - condition: notEquals value: red result: reject matchCase: true - question: Project Team type: singleLineTextBox maxLength: 120 - question: How are you type: multiLineTextBox - question: DropDownList Q type: dropdownList options: - value: A1 - value: A2 - question: weather required: false type: radioButtons maxLength: 120 options: - value: sunny - value: rain rules: - question: lastName condition: endsWith value: tom result: reject matchCase: false order: 1 schema: $ref: '#/components/schemas/RegistrationForUpdate' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Meeting Registration Form operationId: deleteMeetingRegistration description: Disable the registration form for a meeting. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: hostEmail in: header description: e.g. `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. required: false schema: type: string example: '`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.' /meetings/{meetingId}/registrants: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RegistrantCreateResponse' example: id: fbd83190-97b2-4bb0-b56b-8fde463d137b status: pending firstName: bob lastName: Lee email: bob@example.com jobTitle: manager companyName: cisco address1: address1 string address2: address2 string city: New York state: New York zipCode: 123456 countryRegion: United States workPhone: +1 123456 fax: '123456' registrationTime: '2021-09-07T09:29:13+08:00' registrationId: '566476' customizedQuestions: - questionId: 330087 answers: - optionId: 1 answer: green '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Register a Meeting Registrant operationId: createRegistrant description: 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. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: current in: 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. example: false schema: type: boolean default: false - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string requestBody: content: application/json: example: firstName: Bob lastName: Lee email: bob@example.com sendEmail: true jobTitle: manager companyName: Cisco Systems, Inc. address1: address1 string address2: address2 string city: New York state: New York zipCode: 123456 countryRegion: United States workPhone: +1 123456 fax: '123456' customizedQuestions: - questionId: 330087 answers: - optionId: 1 answer: green schema: $ref: '#/components/schemas/RegistrantFormObject' get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/Registrant' description: Registrants array. example: items: - id: fbd83190-97b2-4bb0-b56b-8fde463d137b status: pending firstName: bob lastName: Lee email: bob@example.com jobTitle: manager companyName: cisco address1: address1 string address2: address2 string city: New York state: New York zipCode: 123456 countryRegion: United States workPhone: +1 123456 fax: '123456' registrationTime: '2021-09-07T09:29:13+08:00' customizedQuestions: - questionId: 330087 answers: - optionId: 1 answer: green sourceId: cisco registrationId: '566476' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meeting Registrants operationId: listMeetingRegistrants description: Meeting's host and cohost can retrieve the list of registrants for a meeting with a specified meeting Id. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: max in: query description: Limit the maximum number of registrants in the response, up to 100. The default is 10. example: 100 schema: type: number - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string - name: current in: 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. example: false schema: type: boolean default: false - name: email in: query description: Registrant's email to filter registrants. example: abc@test.com schema: type: string - name: registrationTimeFrom in: 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. example: '2022-10-22T09:30:00' schema: type: string - name: registrationTimeTo in: 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. example: '2022-10-25T09:30:00' schema: type: string /meetings/{meetingId}/registrants/bulkInsert: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/RegistrantCreateResponse' example: items: - id: fbd83190-97b2-4bb0-b56b-8fde463d137b status: pending firstName: bob lastName: Lee email: bob@example.com jobTitle: manager companyName: cisco address1: address1 string address2: address2 string city: New York state: New York zipCode: 123456 countryRegion: United States workPhone: +1 123456 fax: '123456' registrationTime: '2021-09-07T09:29:13+08:00' registrationId: '566476' customizedQuestions: - questionId: 330087 answers: - optionId: 1 answer: green '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Batch register Meeting Registrants operationId: createRegistrants description: 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. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: current in: 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. example: false schema: type: boolean default: false - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string requestBody: content: application/json: example: items: - firstName: Bob lastName: Lee email: bob@example.com sendEmail: true jobTitle: manager companyName: Cisco Systems, Inc. address1: address1 string address2: address2 string city: New York state: New York zipCode: 123456 countryRegion: United States workPhone: +1 123456 fax: '123456' customizedQuestions: - questionId: 330087 answers: - optionId: 1 answer: green schema: type: object properties: items: type: array items: $ref: '#/components/schemas/RegistrantFormObject' description: Registrants array. /meetings/{meetingId}/registrants/{registrantId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Registrant' example: id: fbd83190-97b2-4bb0-b56b-8fde463d137b status: pending firstName: bob lastName: Lee email: bob@example.com jobTitle: manager companyName: cisco address1: address1 string address2: address2 string city: New York state: New York zipCode: 123456 countryRegion: United States workPhone: +1 123456 fax: '123456' registrationTime: '2021-09-07T09:29:13+08:00' customizedQuestions: - questionId: 330087 answers: - optionId: 1 answer: green sourceId: cisco registrationId: '566476' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Detailed Information for a Meeting Registrant operationId: getRegistrant description: Retrieves details for a meeting registrant with a specified registrant Id. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: registrantId in: path description: Unique identifier for the registrant required: true example: 89012b46-ee1d-4c4d-9c3f-0f1b27b47f19 schema: type: string - name: current in: 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. example: false schema: type: boolean default: false - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Meeting Registrant operationId: deleteRegistrant description: Meeting's host or cohost can delete a registrant with a specified registrant ID. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: registrantId in: path description: Unique identifier for the registrant. required: true example: 89012b46-ee1d-4c4d-9c3f-0f1b27b47f19 schema: type: string - name: current in: 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. example: false schema: type: boolean default: false - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string /meetings/{meetingId}/registrants/query: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/Registrant' description: Registrants array. example: items: - id: fbd83190-97b2-4bb0-b56b-8fde463d137b status: pending firstName: bob lastName: Lee email: bob@example.com jobTitle: manager companyName: cisco address1: address1 string address2: address2 string city: New York state: New York zipCode: 123456 countryRegion: United States workPhone: +1 123456 fax: '123456' registrationTime: '2021-09-07T09:29:13+08:00' customizedQuestions: - questionId: 330087 answers: - optionId: 1 answer: green sourceId: cisco registrationId: '566476' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Query Meeting Registrants operationId: queryMeetingRegistrants description: Meeting's host and cohost can query the list of registrants for a meeting with a specified meeting ID and registrants email. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: max in: query description: Limit the maximum number of registrants in the response, up to 100. The default is 10. example: 1000 schema: type: number - name: current in: 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. example: false schema: type: boolean default: false - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string requestBody: content: application/json: example: status: pending orderType: DESC orderBy: firstName emails: - bob@example.com schema: $ref: '#/components/schemas/queryRegistrants' /meetings/{meetingId}/registrants/approve: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Batch Approve Meeting Registrants operationId: batchApproveMeetingRegistrants description: Batch approve a set of registrants for a meeting by the meeting host or cohost. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: current in: 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" example: false schema: type: boolean - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string requestBody: content: application/json: example: sendEmail: true registrants: - id: 6e341788-3bad-4bf0-8037-93709fe8b427 - id: 8919b6bf-01f6-4693-9c0b-cc75e956ba06 schema: type: object properties: sendEmail: type: boolean example: true description: 'If `true` send email to registrants. Default: `true`.' registrants: type: array items: $ref: '#/components/schemas/Registrants' description: Registrants array. /meetings/{meetingId}/registrants/reject: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Batch Reject Meeting Registrants operationId: batchRejectMeetingRegistrants description: Batch reject a set of registrants for a meeting by the meeting host or cohost. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: current in: 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" example: false schema: type: boolean - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string requestBody: content: application/json: example: sendEmail: true registrants: - id: 6e341788-3bad-4bf0-8037-93709fe8b427 - id: 8919b6bf-01f6-4693-9c0b-cc75e956ba06 schema: type: object properties: sendEmail: type: boolean example: true description: 'If `true` send email to registrants. Default: `true`.' registrants: type: array items: $ref: '#/components/schemas/Registrants' description: Registrants array. /meetings/{meetingId}/registrants/cancel: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Batch Cancel Meeting Registrants operationId: batchCancelMeetingRegistrants description: Batch cancel a set of registrants for a meeting by the meeting host or cohost. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: current in: 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" example: false schema: type: boolean - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string requestBody: content: application/json: example: sendEmail: true registrants: - id: 6e341788-3bad-4bf0-8037-93709fe8b427 - id: 8919b6bf-01f6-4693-9c0b-cc75e956ba06 schema: type: object properties: sendEmail: type: boolean example: true description: 'If `true` send email to registrants. Default: `true`.' registrants: type: array items: $ref: '#/components/schemas/Registrants' description: Registrants array. /meetings/{meetingId}/registrants/bulkDelete: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Batch Delete Meeting Registrants operationId: batchDeleteMeetingRegistrants description: Batch delete a set of registrants for a meeting by the meeting host or cohost. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: current in: 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" example: false schema: type: boolean - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string requestBody: content: application/json: example: sendEmail: true registrants: - id: 6e341788-3bad-4bf0-8037-93709fe8b427 - id: 8919b6bf-01f6-4693-9c0b-cc75e956ba06 schema: type: object properties: sendEmail: type: boolean example: true description: 'If `true` send email to registrants. Default: `true`.' registrants: type: array items: $ref: '#/components/schemas/Registrants' description: Registrants array. /meetings/{meetingId}/simultaneousInterpretation: put: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/GetMeetingSimultaneousInterpretationObject' example: enabled: true interpreters: - id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann '400': description: Bad Request headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string errors: type: array items: type: object properties: description: type: string trackingId: type: string example: message: The request could not be understood by the server due to malformed syntax. See 'errors' for more details. errors: - description: '''interpreters'' should be empty when simultaneous interpretation is disabled.' trackingId: 19085D1FCFEE445DA358375500D25E44_1598154356721 '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Meeting Simultaneous interpretation operationId: updateMeetingSimultaneousInterpretation description: 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. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string requestBody: content: application/json: example: enabled: true interpreters: - languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann hostEmail: john.andersen@example.com schema: $ref: '#/components/schemas/UpdateMeetingSimultaneousInterpretationObject' /meetings/{meetingId}/interpreters: post: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/GetInterpreterObject' example: id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann '400': description: Bad Request headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string trackingId: type: string example: message: '''marcus.hoffmann@example.com'' is found in more than one interpreter.' trackingId: 8E12317727354470B5258F5B28D93FB9_1562296858685 '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Meeting Interpreter operationId: createInterpreter description: Assign an interpreter to a bi-directional simultaneous interpretation language channel for a meeting. tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting to which the interpreter is to be assigned. required: true example: 870f51ff287b41be84648412901e0402_2628962 schema: type: string requestBody: content: application/json: example: languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann schema: $ref: '#/components/schemas/CreateInterpreterObject' get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/GetInterpreterObject' description: Array of meeting interpreters. example: items: - id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann - id: 3GQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MAJiZDBjNWVlNDC4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: fr email: antoine.martin@example.com displayName: Martin '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meeting Interpreters operationId: listInterpreters description: 'Lists meeting interpreters for a meeting with a specified `meetingId`. This 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 particular meeting instance will be listed. See the [Webex Meetings](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) guide for more information about the types of meetings. The list returned is sorted in descending order by when interpreters were created.' tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 870f51ff287b41be84648412901e0402 schema: type: string - name: hostEmail in: 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. example: brenda.song@example.com schema: type: string /meetings/{meetingId}/interpreters/{interpreterId}: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/GetInterpreterObject' example: id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.hoffmann@example.com displayName: Hoffmann '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: Not Found headers: {} content: {} '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Meeting Interpreter operationId: getInterpreterById description: Retrieves details for a meeting interpreter identified by `meetingId` and `interpreterId` in the URI. tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting to which the interpreter has been assigned. required: true example: 870f51ff287b41be84648412901e0402 schema: type: string - name: interpreterId in: path description: Unique identifier for the interpreter whose details are being requested. required: true example: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM schema: type: string - name: hostEmail in: 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. example: brenda.song@example.com schema: type: string put: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/GetInterpreterObject' example: id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM languageCode1: en languageCode2: de email: marcus.tuchel@example.com displayName: Tuchel '400': description: Bad Request headers: {} content: application/json;charset=UTF-8: schema: type: object properties: message: type: string trackingId: type: string example: message: '''marcus.tuchel@example.com'' is found in more than one interpreter.' trackingId: 8E12317727354470B5258F5B28D93FB9_1562296858685 '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Meeting Interpreter operationId: updateInterpreterById description: Updates details for a meeting interpreter identified by `meetingId` and `interpreterId` in the URI. tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting whose interpreters were belong to. required: true example: 870f51ff287b41be84648412901e0402 schema: type: string - name: interpreterId in: path description: Unique identifier for the interpreter whose details are being requested. required: true example: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM schema: type: string requestBody: content: application/json: example: languageCode1: en languageCode2: de email: marcus.tuchel@example.com displayName: Tuchel schema: $ref: '#/components/schemas/UpdateInterpreterObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: Not Found headers: {} content: {} '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Meeting Interpreter operationId: deleteInterpreterById description: Removes a meeting interpreter identified by `meetingId` and `interpreterId` in the URI. The deleted meeting interpreter cannot be recovered. tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting whose interpreters were belong to. required: true example: 870f51ff287b41be84648412901e0402 schema: type: string - name: interpreterId in: path description: Unique identifier for the interpreter to be removed. required: true example: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM schema: type: string - name: hostEmail in: 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. example: brenda.song@example.com schema: type: string - name: sendEmail in: query description: If `true`, send email to the interpreter. example: true schema: type: boolean default: true /meetings/{meetingId}/breakoutSessions: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PrePostMeetingBreakoutSessionsObject' example: items: - id: 18d2e565770c4eee918784ee333510ec name: Breakout Session 1 invitees: - rachel.green@example.com - monica.geller@example.com - id: 7ec0782fccf84a5b8cb56d97c69cc771 name: Breakout Session N invitees: - ross.geller@example.com - chandler.bing@example.com '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meeting Breakout Sessions operationId: listBreakoutSessions description: 'Lists meeting breakout sessions for a meeting with a specified `meetingId`. This 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. * If the meeting of `meetingId` is in progress, the operation returns the breakout sessions which are currently held in the meeting. * If the meeting of `meetingId` is ended meeting instance, the operation returns the breakout sessions which happended during the meeting instance. * Otherwise, if it''s a meeting series or scheduled meeting and it''s not in progress, the operation returns the breakout sessions which are created when the meeting is scheduled.' tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: hostEmail in: header description: e.g. `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. required: false schema: type: string example: '`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.' put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PreMeetingBreakoutSessionsObject' example: items: - id: 18d2e565770c4eee918784ee333510ec name: Breakout Session 1 invitees: - rachel.green@example.com - monica.geller@example.com - id: 7ec0782fccf84a5b8cb56d97c69cc771 name: Breakout Session N invitees: - ross.geller@example.com - chandler.bing@example.com '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Meeting Breakout Sessions operationId: updateBreakoutSessions description: 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. tags: - Meetings parameters: - name: meetingId in: 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. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string requestBody: content: application/json: example: hostEmail: john.andersen@example.com sendEmail: true items: - 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 schema: $ref: '#/components/schemas/UpdateMeetingBreakoutSessionsObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: Not Found headers: {} content: {} '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Meeting Breakout Sessions operationId: deleteBreakoutSessions description: '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. This operation applies to meeting series and scheduled meetings. It doesn''t apply to ended or in-progress meeting instances.' tags: - Meetings parameters: - name: meetingId in: 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. required: true example: e8a6557d3c964824ba346a0800d92575 schema: type: string - name: sendEmail in: query description: Whether or not to send emails to host and invitees. It is an optional field and default value is true. example: true schema: type: boolean - name: hostEmail in: header description: e.g. `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. required: false schema: type: string example: '`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.' /meetings/{meetingId}/survey: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SurveyObject' example: id: f2d58ef6cc5848c9a0fb41e3b7aa0ed3 surveyName: Webinar User Experience Survey meetingId: fe32230212b7421286a1f300572a6517 description: A survey about user experience with webinars allowAnonymousSubmit: false questions: - id: 3388057 question: First text question required: true type: text - id: 3388062 question: Second text question required: true type: text - id: 3388067 question: like rating required: true type: rating fromScore: 1 fromLabel: Not Likely toScore: 5 toLabel: Very Likely - id: 3388072 question: check box question required: false type: checkbox options: - id: 1 value: Answer 1 - id: 2 value: Answer 2 - id: 3 value: Answer 3 - id: 4 value: Answer 4 - id: 3388077 question: dropdown list question required: false type: singleDropdown options: - id: 1 value: Answer 1 - id: 2 value: Answer 2 - id: 3 value: Answer 3 - id: 4 value: Answer 4 - id: 3388082 question: radio button question required: true type: singleRadio options: - id: 1 value: Answer 1 - id: 2 value: Answer 2 - id: 3 value: Answer 3 - id: 4 value: Answer 4 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Meeting Survey operationId: getSurveyByMeetingId description: 'Retrieves details for a meeting survey identified by `meetingId`. #### Request Header * `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.' tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting. Please note that only the meeting ID of a scheduled webinar is supported for this API. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: hostEmail in: header description: e.g. john.andersen@example.com required: false schema: type: string example: john.andersen@example.com /meetings/{meetingId}/surveyResults: get: responses: '200': description: OK headers: {} content: application/json;charset=UTF-8: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/SurveyResultObject' description: SurveyResult array example: items: - id: 01c98ac1-e741-4bc1-b92b-6eb42f66caea surveyName: Webinar User Experience Survey meetingId: 870f51ff287b41be84648412901e0402 email: kingu1@example.com displayName: kingu1 createTime: '2022-07-06T14:13:06Z' questions: - id: 3388057 question: First text question type: text answers: - optionId: 1 answer: 'yes' - id: 3388062 question: Second text question type: text answers: - optionId: 1 answer: 'no' - id: 3388067 question: like rating type: rating answers: - optionId: 1 answer: '4' - id: 3388072 question: check box question type: checkbox answers: - optionId: 2 answer: Answer 2 - optionId: 3 answer: Answer 3 - optionId: 4 answer: Answer 4 - id: 3388077 question: dropdown list question type: singleDropdown answers: - optionId: 2 answer: Answer 2 - id: 3388082 question: radio button question type: singleRadio answers: - optionId: 3 answer: Answer 3 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meeting Survey Results operationId: listSurveyResultsByMeetingId description: 'Retrieves results for a meeting survey identified by `meetingId`. #### Request Header * `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. * `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 the survey results of that user.' tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting. Please note that only the meeting ID of a scheduled webinar is supported for this API. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: meetingStartTimeFrom in: 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. When `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. ' example: '2019-03-18T09:30:00Z' schema: type: string - name: meetingStartTimeTo in: 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. When `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. ' example: '2019-03-25T09:30:00Z' schema: type: string - name: max in: query description: Limit the maximum number of meetings in the response, up to 100. The default is 10. example: 100 schema: type: number - name: timezone in: header description: e.g. UTC required: false schema: type: string example: UTC - name: hostEmail in: header description: e.g. john.andersen@example.com required: false schema: type: string example: john.andersen@example.com /meetings/{meetingId}/surveyLinks: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/SurveyLinkObject' description: Survey link array example: items: - email: kingu1@example.com surveyLink: https://example.webex.com/webappng/sites/example/meeting/surveyPage/fa1fc86f70d74c08bc7dc5a3b499ab98?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaXRlSWQiOjIwNjI4NDIsImJpcnRoVGltZSI6MTY4ODQzODYwODY4NCwiZW1haWwiOiJRVWhUU3dBQUFJVllnWEhTSVJLa2hzN2pIR0lCNzJxVDM3SDc5a1NLWjcwUFNBVG9aekJYeHV3KzhJenZnd3l6ZEJ5ZGFDeGc1TnZLcW9mRHV4RjlqdWpGeWhld3EyRmFsWVpNTU9Sa3drNVRNQWZZR2lTUVFRPT0iLCJtZWV0aW5nSW5zdGFuY2VJZCI6Ijc0Y2YyZTJhMjI0ZDQ3OTViM2QwMjliMDZjMGI4NWFjX0lfMjY0Mzg5MTg4NzU2OTY1MjUxIn0.SDJTSwAAAIVIzXgb0wNfEdKwDeRiGzxLWfhoSG5blNcDoCslAiserg - email: kingu2@example.com surveyLink: https://example.webex.com/webappng/sites/example/meeting/surveyPage/fa1fc86f70d74c08bc7dc5a3b499ab98?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaXRlSWQiOjIwNjI4NDIsImJpcnRoVGltZSI6MTY4ODQzODYwODY4NSwiZW1haWwiOiJRVWhUU3dBQUFJVXJDOGlEUjdDNFRlbkRNdlI3MVNMZEk5R0p0YXI1c29SeG9Uenh5enNvRjRvSFlJSW02YXN1aVBydGJ5eTUxdDVaVE9pcGxLVzJhbGg2ZlVmZjZJMUd5dWtqaFVVRnRaNnFqZENIMmdBaEJBPT0iLCJtZWV0aW5nSW5zdGFuY2VJZCI6Ijc0Y2YyZTJhMjI0ZDQ3OTViM2QwMjliMDZjMGI4NWFjX0lfMjY0Mzg5MTg4NzU2OTY1MjUxIn0.SDJTSwAAAIUANDHzUhKprSjQD1zzgLS-TX7BodJK5ANv60x1HmhgDw - email: kingu3@example.com surveyLink: https://example.webex.com/webappng/sites/example/meeting/surveyPage/fa1fc86f70d74c08bc7dc5a3b499ab98?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaXRlSWQiOjIwNjI4NDIsImJpcnRoVGltZSI6MTY4ODQzODYwODY4NSwiZW1haWwiOiJRVWhUU3dBQUFJV0JtaWhFeVA5STh2V2E3RlllQ3dwS1NvQVZ5eXhlNHYzRHNrbXZrNDdZbi9jRmtVUXNSUkF2cThxWEJnajl6K0tkMGVNeCtxbmNEczJ1blNwQjdycnBlb0FCNlBoWVFNU3REQzc4QmdKbE1RPT0iLCJtZWV0aW5nSW5zdGFuY2VJZCI6Ijc0Y2YyZTJhMjI0ZDQ3OTViM2QwMjliMDZjMGI4NWFjX0lfMjY0Mzg5MTg4NzU2OTY1MjUxIn0.SDJTSwAAAIWuP7djKYELnXoOC1P812DKZUYlOT9uI5bbgd8bTiu-Wg '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Meeting Survey Links operationId: generateSurveyLink description: 'Get survey links of a meeting for different users. #### Request Header * `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.' tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting. Only applies to webinars. Meetings and personal room meetings are not supported. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: timezone in: header description: e.g. UTC required: false schema: type: string example: UTC requestBody: content: application/json: example: hostEmail: john.andersen@example.com meetingStartTimeFrom: '2019-03-18T09:30:00Z' meetingStartTimeTo: '2019-03-25T09:30:00Z' emails: - kingu1@example.com - kingu2@example.com - kingu3@example.com schema: $ref: '#/components/schemas/SurveyLinkRequestObject' /meetings/{meetingId}/invitationSources: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/InvitationSourceObject' description: Invitation source array. example: items: - id: '1' sourceId: cisco joinLink: https://example.webex.com/example/j.php?MTID=m6d75f1c875b3e3c5d18c7598036bdd8b registerLink: https://example.webex.com/example/j.php?RGID=rb05b31307b5b820e16594da9d1cfc5c7 sourceEmail: john001@example.com - id: '2' sourceId: webex joinLink: https://example.webex.com/example/j.php?MTID=m6d75f1c875b3e3c5d18c7598036bdd8b registerLink: https://example.webex.com/example/j.php?RGID=rb05b31307b5b820e16594da9d1cfc588 sourceEmail: john002@example.com '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Invitation Sources operationId: createInvitationSources description: Creates one or more invitation sources for a meeting. tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting. Only the meeting ID of a scheduled webinar is supported for this API. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string requestBody: content: application/json: example: hostEmail: john.andersen@example.com personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYTY5MmE2Mi00MTNmLTRjYWEtYjdkOS0wYzg0ZDZmMDdlNzY items: - sourceId: cisco sourceEmail: john001@example.com - sourceId: webex sourceEmail: john002@example.com schema: type: object properties: hostEmail: type: string example: john.andersen@example.com 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. personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI description: Unique identifier for the meeting host. 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. items: type: array items: $ref: '#/components/schemas/InvitationSourceCreateObject' get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/InvitationSourceObject' description: Invitation source array. example: items: - id: '1' sourceId: cisco joinLink: https://example.webex.com/example/j.php?MTID=m6d75f1c875b3e3c5d18c7598036bdd8b registerLink: https://example.webex.com/example/j.php?RGID=rb05b31307b5b820e16594da9d1cfc5c7 sourceEmail: john001@example.com - id: '2' sourceId: webex joinLink: https://example.webex.com/example/j.php?MTID=m6d75f1c875b3e3c5d18c7598036bdd8b registerLink: https://example.webex.com/example/j.php?RGID=rb05b31307b5b820e16594da9d1cfc588 sourceEmail: john002@example.com '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Invitation Sources operationId: listInvitationSources description: 'Lists invitation sources for a meeting. #### Request Header * `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. * `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 scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.' tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting. Only the meeting ID of a scheduled webinar is supported for this API. required: true example: 560d7b784f5143e3be2fc3064a5c4999 schema: type: string - name: hostEmail in: header description: e.g. john.andersen@example.com required: false schema: type: string example: john.andersen@example.com - name: personId in: header description: e.g. Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI required: false schema: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI /meetings/trackingCodes: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/MeetingTrackingCodesObject' description: Tracking code array. example: items: - id: '1' name: Department siteUrl: example.webex.com inputMode: text options: - value: Engineering defaultValue: false - value: Design defaultValue: true - value: Sales defaultValue: false service: MeetingCenter type: optional '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: Not Found headers: {} content: {} '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Meeting Tracking Codes operationId: getMeetingHostTrackingCodes description: '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. * 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. * For a tracking code, if there is no user-level tracking code, the API returns the site-level options, and the `defaultValue` of the site-level default option is `true`. If there is a user-level tracking code, it is merged into the `options`. Meanwhile, the `defaultValue` of this user-level option is `true` and the site-level default option becomes non default. * If `siteUrl` is specified, tracking codes of the specified site will be listed; otherwise, tracking codes of the user''s preferred site will be listed. 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.' tags: - Meetings parameters: - name: siteUrl in: 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. example: example.webex.com schema: type: string - name: service in: query description: Service for schedule or sign-up pages. required: true example: MeetingCenter schema: type: string - name: hostEmail in: 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. example: john.andersen@example.com schema: type: string /meetings/reassignHost: post: responses: '204': description: No Content headers: {} content: {} '207': description: Multi-Status headers: {} content: application/json;charset=UTF-8: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/ReassignMeetingResponseObject' description: Array of meeting reassignment results. example: items: - meetingId: 870f51ff287b41be84648412901e0402 httpStatus: 200 - meetingId: 1d824a4a205042eba9574e00b711b226 httpStatus: 404 message: The requested resource could not be found. errors: - description: The meeting is not found. - meetingId: 41be84640b711b8414a4a205042ebba9 httpStatus: 200 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Reassign Meetings to a New Host operationId: reassignHost description: 'Reassigns a list of meetings to a new host by an admin user. All 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. If the user of `hostEmail` is not qualified to be a host of the target site, the API returns an error with the HTTP status code `403`. If all the meetings referenced by `meetingIds` have been reassigned the new host successfully, the API returns an empty response with the HTTP status code `204`. Otherwise, if all the meetings of `meetingIds` fail or some of them fail, the API returns a "Multi-Status" response with status code of `207`, and individual errors for each meeting in the response body. If a meeting already has several ended meeting instances before it''s assigned to a new host, the existing ended instances are accessible to the original host and not accessible to the new host, but the new meeting instances which happen after the reassignment are only accessible to the new host. After the reassignment, the original host will receive an email of meeting cancellation. However, the meeting in the original host''s calendar will not necessarily be removed because user''s calendar, e.g. Outlook calendar, is not managed by the meeting system directly. **Note**: Only IDs of meeting series are supported for the `meetingIds`. IDs of scheduled meetings, meeting instances, or scheduled personal room meetings are not supported. To learn more about different types of meetings, please refer to [Meeting Series, Scheduled Meetings, and Meeting Instances](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances). There are several limitations when reassigning meetings: * Users cannot assign an in-progress meeting. * Users cannot assign a meeting to a user who is not a Webex user, or an attendee who does not have host privilege. * Users cannot assign a meeting with calling/callback to a host user who does not have calling/callback privileges * Users cannot assign a meeting with session type A to a host user who does not have session type A privileges. * Users cannot assign an MC or Webinar to a new host who does not have an MC license or a Webinar license. * Users cannot assign a TC/EC1.0/SC meeting, or a meeting that is created by on-behalf to a new host. * Users can reassign hosts for meetings from third-party integrations, such as Outlook or Google. Note that this is not recommended because it may result in inconsistent data between both parties. #### Request Header * `siteUrl`: Optional request header parameter. All the meetings of `meetingIds` should belong to the site referenced by siteUrl if specified. Otherwise, the meetings should belong to the admin user''s preferred sites. 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.' tags: - Meetings parameters: - name: siteUrl in: header description: e.g. example.webex.com required: false schema: type: string example: example.webex.com requestBody: content: application/json: example: hostEmail: john.andersen@example.com meetingIds: - 870f51ff287b41be84648412901e0402 - 1d824a4a205042eba9574e00b711b226 - 41be84640b711b8414a4a205042ebba9 schema: $ref: '#/components/schemas/ReassignMeetingRequestObject' /meetings/{meetingId}/end: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: End a Meeting operationId: endMeeting description: '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. * 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. * If the `meetingId` value specified is for a meeting series, the operation ends the current meeting occurrence.' tags: - Meetings parameters: - name: meetingId in: path description: Unique identifier for the meeting to be ended. required: true example: e8a6557d3c964824ba346a0800d92575 schema: type: string requestBody: content: application/json: example: reason: Agenda has been completed and the meeting is ended. schema: $ref: '#/components/schemas/EndMeetingRequestObject' components: schemas: CreateMeetingObject: type: object required: - title - start - end properties: adhoc: type: boolean description: Whether or not to create an ad-hoc meeting for the room specified by `roomId`. When `true`, `roomId` is required. roomId: type: string example: Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2 description: Unique identifier for the Webex space which the meeting is to be associated with. It can be retrieved by [List Rooms](/docs/api/v1/rooms/list-rooms). `roomId` is required when `adhoc` is `true`. When `roomId` is specified, the parameter `hostEmail` will be ignored. templateId: type: string example: N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM description: 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](/docs/api/v1/meetings/list-meeting-templates). This parameter is ignored for an ad-hoc meeting. title: type: string example: John's Meeting description: 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: type: string example: John's Agenda description: Meeting agenda. The agenda can be a maximum of 1300 characters long. password: type: string example: BgJep@43 description: Meeting password. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. If not specified, a random password conforming to the site's password rules will be generated automatically. start: type: string example: '2020-05-15T20:30:00-08:00' description: Date and time for the start of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/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: type: string example: '2020-05-15T21:30:00-08:00' description: Date and time for the end of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/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: type: string example: America/Los_Angeles description: '[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in which the meeting was originally scheduled (conforming with the [IANA time zone database](https://www.iana.org/time-zones)). The default value for an ad-hoc meeting is `UTC` and the user''s input value will be ignored.' recurrence: type: string example: FREQ=DAILY;INTERVAL=1;COUNT=20 description: Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)), 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: type: boolean description: Whether or not meeting is recorded automatically. allowAnyUserToBeCoHost: type: boolean description: 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: type: boolean description: 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: type: boolean description: 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: type: number example: 15 description: 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: type: boolean description: Whether or not to exclude the meeting password from the email invitation. This parameter is ignored for an ad-hoc meeting. publicMeeting: type: boolean description: 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: type: number example: 10 description: 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: type: string enum: - allowJoin - allowJoinWithLobby - blockFromJoin description: "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.\n * `allowJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoin`, people can join the unlocked meeting directly.\n * `allowJoinWithLobby` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoinWithLobby`, people will wait in the lobby until the host admits them.\n * `blockFromJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `blockFromJoin`, people can't join the unlocked meeting.\n" sessionTypeId: type: number example: 3 description: 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](/docs/api/v1/meetings/list-meeting-session-types) API. scheduledType: type: string enum: - meeting - webinar - personalRoomMeeting description: "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](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings). 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.\n * `meeting` - Set the value of `scheduledType` attribute to `meeting` for creating a regular meeting.\n * `webinar` - Set the value of `scheduledType` attribute to `webinar` for creating a webinar meeting.\n * `personalRoomMeeting` - Set the value of `scheduledType` attribute to `personalRoomMeeting` for creating a meeting in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings). Please note that `templateId`, `roomId`, `integrationTags`, `enabledWebcastView`, `enabledAutoRecordMeeting` and `registration` are not supported when creating a personal room meeting.\n" enabledWebcastView: type: boolean description: Whether or not webcast view is enabled. This parameter is ignored for an ad-hoc meeting. panelistPassword: type: string example: GwLqa@78 description: Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) 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: type: boolean description: 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: type: number example: 10 description: 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: type: boolean description: 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: type: boolean description: 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: type: array items: $ref: '#/components/schemas/InviteeObjectForCreateMeeting' description: 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. sendEmail: type: boolean example: true description: 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: type: string example: john.andersen@example.com description: 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: type: string example: example.webex.com description: 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: type: object properties: enabledChat: type: boolean example: true description: Whether or not to allow any attendee to chat in the meeting. Also depends on the session type. enabledVideo: type: boolean example: true description: Whether or not to allow any attendee to have video in the meeting. Also depends on the session type. enabledPolling: type: boolean description: 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: type: boolean example: true description: 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: type: string enum: - allowAll - allowOne description: "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.\n * `allowAll` - If the value of `noteType` attribute is `allowAll`, all participants can take notes.\n * `allowOne` - If the value of `noteType` attribute is `allowOne`, only a single note taker is allowed.\n" enabledFileTransfer: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to share [Universal Communications Format](https://www.cisco.com/c/en/us/td/docs/collaboration/training_center/wbs30/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions_chapter_0110.pdf) 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. description: Meeting Options. attendeePrivileges: type: object properties: enabledShareContent: type: boolean example: true description: Whether or not to allow any attendee to share content in the meeting. enabledSaveDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledPrintDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledAnnotate: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewParticipantList: type: boolean example: true description: Whether or not to allow any attendee to view participants. enabledViewThumbnails: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledRemoteControl: type: boolean example: true description: Whether or not to allow any attendee to control applications, web browsers, or desktops remotely. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewAnyDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewAnyPage: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledContactOperatorPrivately: type: boolean description: Whether or not to allow any attendee to contact the operator privately. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatHost: type: boolean example: true description: Whether or not to allow any attendee to chat with the host in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatPresenter: type: boolean example: true description: Whether or not to allow any attendee to chat with the presenter in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatOtherParticipants: type: boolean example: true description: Whether or not to allow any attendee to chat with other participants in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). description: Attendee Privileges. This attribute is not supported for a webinar. registration: type: object properties: autoAcceptRequest: type: boolean description: Whether or not meeting registration request is accepted automatically. requireFirstName: type: boolean example: true description: Whether or not a registrant's first name is required for meeting registration. This option must always be `true`. requireLastName: type: boolean example: true description: Whether or not a registrant's last name is required for meeting registration. This option must always be `true`. requireEmail: type: boolean example: true description: Whether or not a registrant's email is required for meeting registration. This option must always be `true`. requireJobTitle: type: boolean description: Whether or not a registrant's job title is shown or required for meeting registration. requireCompanyName: type: boolean description: Whether or not a registrant's company name is shown or required for meeting registration. requireAddress1: type: boolean description: Whether or not a registrant's first address field is shown or required for meeting registration. requireAddress2: type: boolean description: Whether or not a registrant's second address field is shown or required for meeting registration. requireCity: type: boolean description: Whether or not a registrant's city is shown or required for meeting registration. requireState: type: boolean description: Whether or not a registrant's state is shown or required for meeting registration. requireZipCode: type: boolean description: Whether or not a registrant's postal code is shown or required for meeting registration. requireCountryRegion: type: boolean description: Whether or not a registrant's country or region is shown or required for meeting registration. requireWorkPhone: type: boolean description: Whether or not a registrant's work phone number is shown or required for meeting registration. requireFax: type: boolean description: Whether or not a registrant's fax number is shown or required for meeting registration. maxRegisterNum: type: number example: 1000 description: 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. customizedQuestions: type: array items: $ref: '#/components/schemas/CustomizedQuestionForCreateMeeting' description: Customized questions for meeting registration. rules: type: array items: $ref: '#/components/schemas/StandardRegistrationApproveRule' description: The approval rules for standard questions. description: 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](https://help.webex.com/en-us/nmgmeff/Register-for-a-Meeting-in-Cisco-Webex-Meetings) for details. integrationTags: type: array items: type: string description: 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: type: object required: - enabled properties: enabled: type: boolean description: Whether or not simultaneous interpretation is enabled. interpreters: type: array items: $ref: '#/components/schemas/InterpreterObjectForSimultaneousInterpretationOfCreateOrUpdateMeeting' description: Interpreters for meeting. description: Simultaneous interpretation information for a meeting. enabledBreakoutSessions: type: boolean description: Whether or not breakout sessions are enabled. breakoutSessions: type: array items: $ref: '#/components/schemas/PreMeetingBreakoutSessionWithoutIdObject' description: 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. trackingCodes: type: array items: $ref: '#/components/schemas/TrackingCodeItemForCreateMeetingObject' description: Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by [List Meeting Tracking Codes](/docs/api/v1/meetings/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. enabledAudioWatermark: type: boolean description: 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: type: boolean description: 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: type: number example: 10 description: 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: type: object properties: audioConnectionType: type: string enum: - webexAudio - VoIP - other - none description: "Choose how meeting attendees join the audio portion of the meeting.\n * `webexAudio` - Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.\n * `VoIP` - Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.\n * `other` - Other teleconference services.\n * `none` - The way of attendees join the audio portion of the meeting is the default value.\n" enabledTollFreeCallIn: type: boolean example: true description: Whether or not to show toll-free call-in numbers. enabledGlobalCallIn: type: boolean example: true description: Whether or not to show global call-in numbers to attendees. enabledAudienceCallBack: type: boolean description: 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: type: string enum: - beep - announceName - noTone description: "Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.\n * `beep` - All call-in users joining the meeting will hear the beep.\n * `announceName` - All call-in users joining the meeting will hear their names.\n * `noTone` - Turn off beeps and name announcements.\n" allowHostToUnmuteParticipants: type: boolean description: Whether or not to allow the host to unmute participants. allowAttendeeToUnmuteSelf: type: boolean example: true description: Whether or not to allow attendees to unmute themselves. muteAttendeeUponEntry: type: boolean description: Whether or not to auto-mute attendees when attendees enter meetings. description: Audio connection options. requireAttendeeLogin: type: boolean description: 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: type: boolean description: 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: type: boolean description: Whether or not live streaming is enabled. If it's 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: $ref: '#/components/schemas/LiveStreamObject' description: Live streaming settings. It applies when `enabledLiveStream` is `true`. Registration: type: object properties: autoAcceptRequest: type: boolean description: Whether or not meeting registration requests are accepted automatically. requireFirstName: type: boolean example: true description: Whether or not a registrant's first name is required for meeting registration. This option must always be `true`. requireLastName: type: boolean example: true description: Whether or not a registrant's last name is required for meeting registration. This option must always be `true`. requireEmail: type: boolean example: true description: Whether or not a registrant's email is required for meeting registration. This option must always be `true`. requireJobTitle: type: boolean description: Whether or not a registrant's job title is shown or required for meeting registration. requireCompanyName: type: boolean description: Whether or not a registrant's company name is shown or required for meeting registration. requireAddress1: type: boolean description: Whether or not a registrant's first address field is shown or required for meeting registration. requireAddress2: type: boolean description: Whether or not a registrant's second address field is shown or required for meeting registration. requireCity: type: boolean description: Whether or not a registrant's city is shown or required for meeting registration. requireState: type: boolean description: Whether or not a registrant's state is shown or required for meeting registration. requireZipCode: type: boolean description: Whether or not a registrant's postal code is shown or required for meeting registration. requireCountryRegion: type: boolean description: Whether or not a registrant's country or region is shown or required for meeting registration. requireWorkPhone: type: boolean description: Whether or not a registrant's work phone number is shown or required for meeting registration. requireFax: type: boolean description: Whether or not a registrant's fax number is shown or required for meeting registration. customizedQuestions: type: array items: $ref: '#/components/schemas/CustomizedQuestionForGetMeeting' description: Customized questions for meeting registration. rules: type: array items: $ref: '#/components/schemas/StandardRegistrationApproveRule' description: The approval rules for standard questions. PatchMeetingObject: type: object properties: title: type: string example: John's Meeting description: Meeting title. The title can be a maximum of 128 characters long. agenda: type: string example: John's Agenda description: Meeting agenda. The agenda can be a maximum of 1300 characters long. It can be specified `null` so that it becomes null and hidden from the response after the patch. password: type: string example: BgJep@43 description: Meeting password. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. start: type: string example: '2020-05-15T20:30:00-08:00' description: Date and time for the start of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/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. Refer to the [Webex Meetings](/docs/meetings#restrictions-on-updating-a-meeting) guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, `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`. end: type: string example: '2020-05-15T21:30:00-08:00' description: Date and time for the end of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/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. Refer to the [Webex Meetings](/docs/meetings#restrictions-on-updating-a-meeting) guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, `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`. timezone: type: string example: America/Los_Angeles description: '[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in which the meeting was originally scheduled (conforming with the [IANA time zone database](https://www.iana.org/time-zones)).' recurrence: type: string example: FREQ=DAILY;INTERVAL=1;COUNT=20 description: Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)). Applies only to a recurring meeting series, not to a meeting series with only one scheduled 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". It can be specified `null` so that the meeting becomes non-recurring and the `recurrence` attribute becomes null and hidden from the response after the patch. enabledAutoRecordMeeting: type: boolean description: Whether or not meeting is recorded automatically. allowAnyUserToBeCoHost: type: boolean description: 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. enabledJoinBeforeHost: type: boolean description: Whether or not to allow any attendee to join the meeting before the host joins the meeting. enableConnectAudioBeforeHost: type: boolean description: 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. joinBeforeHostMinutes: type: number example: 15 description: Number of minutes an attendee can join the meeting before the meeting start time and the host joins. 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 is `0` if not specified. excludePassword: type: boolean description: Whether or not to exclude the meeting password from the email invitation. publicMeeting: type: boolean description: Whether or not to allow the meeting to be listed on the public calendar. reminderTime: type: number example: 30 description: The number of minutes before the meeting begins, that an email reminder is sent to the host. unlockedMeetingJoinSecurity: type: string enum: - allowJoin - allowJoinWithLobby - blockFromJoin description: "Specifies how the people who aren't on the invite can join the unlocked meeting.\n * `allowJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoin`, people can join the unlocked meeting directly.\n * `allowJoinWithLobby` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoinWithLobby`, people will wait in the lobby until the host admits them.\n * `blockFromJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `blockFromJoin`, people can't join the unlocked meeting.\n" sessionTypeId: type: number example: 3 description: Unique identifier for a meeting session type for the user. This attribute is required while scheduling webinar meeting. All available meeting session types enabled for the user can be retrieved by [List Meeting Session Types](/docs/api/v1/meetings/list-meeting-session-types) API. enabledWebcastView: type: boolean description: Whether or not webcast view is enabled. panelistPassword: type: string example: GwLqa@78 description: Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. If not specified, a random password conforming to the site's password rules will be generated automatically. enableAutomaticLock: type: boolean description: Whether or not to automatically lock the meeting after it starts. automaticLockMinutes: type: number example: 10 description: The number of minutes after the meeting begins, for automatically locking it. allowFirstUserToBeCoHost: type: boolean description: 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. allowAuthenticatedDevices: type: boolean description: Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. sendEmail: type: boolean example: true description: Whether or not to send emails to host and invitees. It is an optional field and default value is true. hostEmail: type: string example: john.andersen@example.com description: 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. The field is not editable and is only used to patch a meeting on behalf of the real meeting host. Please use the [Reassign Meetings to a New Host](/docs/api/v1/meetings/reassign-meetings-to-a-new-host) API if you need to update the meeting host. meetingOptions: type: object properties: enabledChat: type: boolean example: true description: Whether or not to allow any attendee to chat in the meeting. Also depends on the session type. enabledVideo: type: boolean example: true description: Whether or not to allow any attendee to have video in the meeting. Also depends on the session type. enabledPolling: type: boolean description: 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: type: boolean example: true description: 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: type: string enum: - allowAll - allowOne description: "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.\n * `allowAll` - If the value of `noteType` attribute is `allowAll`, all participants can take notes.\n * `allowOne` - If the value of `noteType` attribute is `allowOne`, only a single note taker is allowed.\n" enabledFileTransfer: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to share [Universal Communications Format](https://www.cisco.com/c/en/us/td/docs/collaboration/training_center/wbs30/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions_chapter_0110.pdf) 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. description: Meeting Options. attendeePrivileges: type: object properties: enabledShareContent: type: boolean example: true description: Whether or not to allow any attendee to share content in the meeting. enabledSaveDocument: type: boolean description: 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: type: boolean description: 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: type: boolean description: 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: type: boolean example: true description: Whether or not to allow any attendee to view participants. enabledViewThumbnails: type: boolean description: 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: type: boolean example: true description: Whether or not to allow any attendee to control applications, web browsers, or desktops remotely. enabledViewAnyDocument: type: boolean description: 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: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to contact the operator privately. enabledChatHost: type: boolean example: true description: Whether or not to allow any attendee to chat with the host in private. enabledChatPresenter: type: boolean example: true description: Whether or not to allow any attendee to chat with the presenter in private. enabledChatOtherParticipants: type: boolean example: true description: Whether or not to allow any attendee to chat with other participants in private. description: Attendee Privileges. This attribute is not supported for a webinar. integrationTags: type: array items: type: string description: 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. Please note that an empty or null `integrationTags` will delete all existing integration tags for the meeting implicitly. Developer can update integration tags for a `meetingSeries` but he cannot update it for a `scheduledMeeting` or a `meeting` instance. enabledBreakoutSessions: type: boolean description: Whether or not breakout sessions are enabled. If the value of `enabledBreakoutSessions` is false, users can not set breakout sessions. If the value of `enabledBreakoutSessions` is true, users can update breakout sessions using the [Update Breakout Sessions](/docs/api/v1/meetings/{meetingId}/breakoutSessions) API. Updating breakout sessions are not supported by this API. trackingCodes: type: array items: $ref: '#/components/schemas/TrackingCodeItemForCreateMeetingObject' description: Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by [List Meeting Tracking Codes](/docs/api/v1/meetings/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. It can be specified `null` so that it becomes null and hidden from the response after the patch. enabledAudioWatermark: type: boolean description: 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: type: boolean description: 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: type: number example: 10 description: 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: type: object properties: audioConnectionType: type: string enum: - webexAudio - VoIP - other - none description: "Choose how meeting attendees join the audio portion of the meeting.\n * `webexAudio` - Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.\n * `VoIP` - Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.\n * `other` - Other teleconference services.\n * `none` - The way of attendees join the audio portion of the meeting is the default value.\n" enabledTollFreeCallIn: type: boolean example: true description: Whether or not to show toll-free call-in numbers. enabledGlobalCallIn: type: boolean example: true description: Whether or not to show global call-in numbers to attendees. enabledAudienceCallBack: type: boolean description: 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: type: string enum: - beep - announceName - noTone description: "Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.\n * `beep` - All call-in users joining the meeting will hear the beep.\n * `announceName` - All call-in users joining the meeting will hear their names.\n * `noTone` - Turn off beeps and name announcements.\n" allowHostToUnmuteParticipants: type: boolean description: Whether or not to allow the host to unmute participants. allowAttendeeToUnmuteSelf: type: boolean example: true description: Whether or not to allow attendees to unmute themselves. muteAttendeeUponEntry: type: boolean description: Whether or not to auto-mute attendees when attendees enter meetings. description: Audio connection options. requireAttendeeLogin: type: boolean description: 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: type: boolean description: 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: type: boolean description: Whether or not live streaming is enabled. liveStream: $ref: '#/components/schemas/LiveStreamObject' description: Live streaming settings. It applies when `enabledLiveStream` is `true`. ReassignMeetingResponseObject: type: object required: - meetingId - httpStatus properties: meetingId: type: string example: 560d7b784f5143e3be2fc3064a5c5888 description: Unique identifier for the meeting to be reassigned host. httpStatus: type: string example: '404' description: HTTP status code for the meeting reassignment result. message: type: string example: The requested resource could not be found. description: General message for the host reassignment of `meetingId` if it fails. errors: type: array items: $ref: '#/components/schemas/ReassignMeetingErrorDescriptionObject' description: Detailed descriptions for the host reassignment of `meetingId` if it fails. TemplateObject: type: object required: - id - name - locale - siteUrl - templateType - isDefault - isStandard properties: id: type: string example: N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM description: Unique identifier for meeting template. name: type: string example: Meeting template 1 description: Meeting template name. locale: type: string example: en_US description: Meeting template locale. siteUrl: type: string example: site4-example.webex.com description: Site URL for the meeting template. templateType: type: string enum: - meeting - webinar description: "Meeting template type.\n * `meeting` - Webex meeting.\n * `webinar` - Webex webinar.\n" isDefault: type: boolean description: Whether or not the meeting template is a default template. isStandard: type: boolean description: Whether or not the meeting template is a standard template. UpdateMeetingObject: type: object properties: title: type: string example: John's Meeting description: Meeting title. The title can be a maximum of 128 characters long. agenda: type: string example: John's Agenda description: Meeting agenda. The agenda can be a maximum of 1300 characters long. password: type: string example: BgJep@43 description: Meeting password. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. start: type: string example: '2020-05-15T20:30:00-08:00' description: Date and time for the start of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/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. Refer to the [Webex Meetings](/docs/meetings#restrictions-on-updating-a-meeting) guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, `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`. end: type: string example: '2020-05-15T21:30:00-08:00' description: Date and time for the end of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/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. Refer to the [Webex Meetings](/docs/meetings#restrictions-on-updating-a-meeting) guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, `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`. timezone: type: string example: America/Los_Angeles description: '[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in which the meeting was originally scheduled (conforming with the [IANA time zone database](https://www.iana.org/time-zones)).' recurrence: type: string example: FREQ=DAILY;INTERVAL=1;COUNT=20 description: Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)). Applies only to a recurring meeting series, not to a meeting series with only one scheduled 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: type: boolean description: Whether or not meeting is recorded automatically. allowAnyUserToBeCoHost: type: boolean description: 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. enabledJoinBeforeHost: type: boolean description: Whether or not to allow any attendee to join the meeting before the host joins the meeting. enableConnectAudioBeforeHost: type: boolean description: 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. joinBeforeHostMinutes: type: number example: 15 description: Number of minutes an attendee can join the meeting before the meeting start time and the host joins. 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 is `0` if not specified. excludePassword: type: boolean description: Whether or not to exclude the meeting password from the email invitation. publicMeeting: type: boolean description: Whether or not to allow the meeting to be listed on the public calendar. reminderTime: type: number example: 30 description: The number of minutes before the meeting begins, that an email reminder is sent to the host. unlockedMeetingJoinSecurity: type: string enum: - allowJoin - allowJoinWithLobby - blockFromJoin description: "Specifies how the people who aren't on the invite can join the unlocked meeting.\n * `allowJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoin`, people can join the unlocked meeting directly.\n * `allowJoinWithLobby` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoinWithLobby`, people will wait in the lobby until the host admits them.\n * `blockFromJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `blockFromJoin`, people can't join the unlocked meeting.\n" sessionTypeId: type: number example: 3 description: Unique identifier for a meeting session type for the user. This attribute is required while scheduling webinar meeting. All available meeting session types enabled for the user can be retrieved by [List Meeting Session Types](/docs/api/v1/meetings/list-meeting-session-types) API. enabledWebcastView: type: boolean description: Whether or not webcast view is enabled. panelistPassword: type: string example: GwLqa@78 description: Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. If not specified, a random password conforming to the site's password rules will be generated automatically. enableAutomaticLock: type: boolean description: Whether or not to automatically lock the meeting after it starts. automaticLockMinutes: type: number example: 10 description: The number of minutes after the meeting begins, for automatically locking it. allowFirstUserToBeCoHost: type: boolean description: 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. allowAuthenticatedDevices: type: boolean description: Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. sendEmail: type: boolean example: true description: Whether or not to send emails to host and invitees. It is an optional field and default value is true. hostEmail: type: string example: john.andersen@example.com description: 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. The field is not editable and is only used to update a meeting on behalf of the real meeting host. Please use the [Reassign Meetings to a New Host](/docs/api/v1/meetings/reassign-meetings-to-a-new-host) API if you need to update the meeting host. meetingOptions: type: object properties: enabledChat: type: boolean example: true description: Whether or not to allow any attendee to chat in the meeting. Also depends on the session type. enabledVideo: type: boolean example: true description: Whether or not to allow any attendee to have video in the meeting. Also depends on the session type. enabledPolling: type: boolean description: 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: type: boolean example: true description: 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: type: string enum: - allowAll - allowOne description: "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.\n * `allowAll` - If the value of `noteType` attribute is `allowAll`, all participants can take notes.\n * `allowOne` - If the value of `noteType` attribute is `allowOne`, only a single note taker is allowed.\n" enabledFileTransfer: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to share [Universal Communications Format](https://www.cisco.com/c/en/us/td/docs/collaboration/training_center/wbs30/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions_chapter_0110.pdf) 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. description: Meeting Options. attendeePrivileges: type: object properties: enabledShareContent: type: boolean example: true description: Whether or not to allow any attendee to share content in the meeting. enabledSaveDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledPrintDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledAnnotate: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewParticipantList: type: boolean example: true description: Whether or not to allow any attendee to view participants. enabledViewThumbnails: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledRemoteControl: type: boolean example: true description: Whether or not to allow any attendee to control applications, web browsers, or desktops remotely. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewAnyDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewAnyPage: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledContactOperatorPrivately: type: boolean description: Whether or not to allow any attendee to contact the operator privately. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatHost: type: boolean example: true description: Whether or not to allow any attendee to chat with the host in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatPresenter: type: boolean example: true description: Whether or not to allow any attendee to chat with the presenter in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatOtherParticipants: type: boolean example: true description: Whether or not to allow any attendee to chat with other participants in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). description: Attendee Privileges. This attribute is not supported for a webinar. integrationTags: type: array items: type: string description: 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. Please note that an empty or null `integrationTags` will delete all existing integration tags for the meeting implicitly. Developer can update integration tags for a `meetingSeries` but he cannot update it for a `scheduledMeeting` or a `meeting` instance. enabledBreakoutSessions: type: boolean description: Whether or not breakout sessions are enabled. If the value of `enabledBreakoutSessions` is false, users can not set breakout sessions. If the value of `enabledBreakoutSessions` is true, users can update breakout sessions using the [Update Breakout Sessions](/docs/api/v1/meetings/{meetingId}/breakoutSessions) API. Updating breakout sessions are not supported by this API. trackingCodes: type: array items: $ref: '#/components/schemas/TrackingCodeItemForCreateMeetingObject' description: Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by [List Meeting Tracking Codes](/docs/api/v1/meetings/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. enabledAudioWatermark: type: boolean description: 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: type: boolean description: 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: type: number example: 10 description: 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: type: object properties: audioConnectionType: type: string enum: - webexAudio - VoIP - other - none description: "Choose how meeting attendees join the audio portion of the meeting.\n * `webexAudio` - Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.\n * `VoIP` - Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.\n * `other` - Other teleconference services.\n * `none` - The way of attendees join the audio portion of the meeting is the default value.\n" enabledTollFreeCallIn: type: boolean example: true description: Whether or not to show toll-free call-in numbers. enabledGlobalCallIn: type: boolean example: true description: Whether or not to show global call-in numbers to attendees. enabledAudienceCallBack: type: boolean description: 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: type: string enum: - beep - announceName - noTone description: "Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.\n * `beep` - All call-in users joining the meeting will hear the beep.\n * `announceName` - All call-in users joining the meeting will hear their names.\n * `noTone` - Turn off beeps and name announcements.\n" allowHostToUnmuteParticipants: type: boolean description: Whether or not to allow the host to unmute participants. allowAttendeeToUnmuteSelf: type: boolean example: true description: Whether or not to allow attendees to unmute themselves. muteAttendeeUponEntry: type: boolean description: Whether or not to auto-mute attendees when attendees enter meetings. description: Audio connection options. requireAttendeeLogin: type: boolean description: 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: type: boolean description: 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: type: boolean description: Whether or not live streaming is enabled. liveStream: $ref: '#/components/schemas/LiveStreamObject' description: Live streaming settings. It applies when `enabledLiveStream` is `true`. InviteeObjectForCreateMeeting: type: object required: - email properties: email: type: string example: brenda.song@example.com description: Email address of meeting invitee. displayName: type: string example: Brenda Song description: 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: type: boolean description: 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: type: boolean description: Whether or not an invitee is allowed to be a panelist. Only applies to webinars. StandardRegistrationApproveRule: type: object required: - question - condition - value - result - order properties: question: type: string enum: - lastName - email - jobTitle - companyName - address1 - address2 - city - state - zipCode - countryRegion - workPhone - fax description: "Name for standard question.\n * `lastName` - If the value is `lastName`, this approval rule applies to the standard question of \"Last Name\".\n * `email` - If the value is `email`, this approval rule applies to the standard question of \"Email\".\n * `jobTitle` - If the value is `jobTitle`, this approval rule applies to the standard question of \"Job Title\".\n * `companyName` - If the value is `companyName`, this approval rule applies to the standard question of \"Company Name\".\n * `address1` - If the value is `address1`, this approval rule applies to the standard question of \"Address 1\".\n * `address2` - If the value is `address2`, this approval rule applies to the standard question of \"Address 2\".\n * `city` - If the value is `city`, this approval rule applies to the standard question of \"City\".\n * `state` - If the value is `state`, this approval rule applies to the standard question of \"State\".\n * `zipCode` - If the value is `zipCode`, this approval rule applies to the standard question of \"Zip/Post Code\".\n * `countryRegion` - If the value is `countryRegion`, this approval rule applies to the standard question of \"Country Region\".\n * `workPhone` - If the value is `workPhone`, this approval rule applies to the standard question of \"Work Phone\".\n * `fax` - If the value is `fax`, this approval rule applies to the standard question of \"Fax\".\n" condition: type: string enum: - contains - notContains - beginsWith - endsWith - equals - notEquals description: "Judgment expression for approval rules.\n * `contains` - The content of the answer contains the value.\n * `notContains` - The content of the answer does not contain the value\n * `beginsWith` - The content of the answer begins with the value.\n * `endsWith` - The content of the answer ends with the value.\n * `equals` - The content of the answer is the same as the value.\n * `notEquals` - The content of the answer is not the same as the value.\n" value: type: string example: tom description: The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed. result: type: string enum: - approve - reject description: "The automatic approval result for the approval rule.\n * `approve` - If the user's registration value meets the criteria, the registration form will be automatically approved.\n * `reject` - If the user's registration value meets the criteria, the registration form will be automatically rejected.\n" matchCase: type: boolean example: true description: Whether to check the case of values. order: type: number example: 1 description: The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together. ReassignMeetingRequestObject: type: object required: - hostEmail - meetingIds properties: hostEmail: type: string example: john.andersen@example.com description: Email address of the new meeting host. meetingIds: type: array items: type: string description: List of meeting series IDs to be reassigned the new host. The size is between 1 and 100. All 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. PrePostMeetingBreakoutSessionsObject: type: object properties: items: type: array items: $ref: '#/components/schemas/PrePostMeetingBreakoutSessionObject' description: Breakout sessions information for meeting. SurveyObject: type: object required: - id - surveyName - meetingId - questions properties: id: type: string example: 18d2e565770c4eee918784ee333510ec description: Unique identifier for the survey. surveyName: type: string example: Survey name description: Name for the survey. meetingId: type: string example: 560d7b784f5143e3be2fc3064a5c4999 description: Unique identifier for the meeting. description: type: string example: Survey name description: Description for the survey. allowAnonymousSubmit: type: boolean example: true description: Whether the survey allows attendees to submit anonymously. questions: type: array items: $ref: '#/components/schemas/QuestionObject' description: Questions for the survey. Control: type: object properties: locked: type: boolean description: Whether the meeting is locked or not. recordingStarted: type: boolean example: true description: The value can be true or false, it indicates the meeting recording started or not. recordingPaused: type: boolean example: true description: The value can be true or false, it indicates the meeting recording paused or not. PreMeetingBreakoutSessionsObject: type: object properties: items: type: array items: $ref: '#/components/schemas/PreMeetingBreakoutSessionObject' description: Breakout sessions information for meeting. Registrants: type: object required: - id properties: id: type: string example: '123456' description: Registrant ID. LinksObjectForBreakoutSessions: type: object required: - rel - href - method properties: rel: type: string example: breakoutSessions description: Link relation describing how the target resource is related to the current context (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). href: type: string example: /api/v1/meetings/2c87cf8ece4e414a9fe5516e4a0aac76/breakoutSessions description: Target resource URI (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). method: type: string example: GET description: Target resource method (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). QuestionObject: type: object required: - id - question - type properties: id: type: number example: 3388057 description: Unique identifier for the question. question: type: string example: Do you like cisco? description: Details for the question. type: type: string enum: - text - rating - checkbox - singleDropdown - singleRadio description: "Type for the question.\n * `text` - Text input.\n * `rating` - Rating.\n * `checkbox` - Check box which requires `options`.\n * `singleDropdown` - Drop down list box which requires `options`.\n * `singleRadio` - Single radio button which requires `options`.\n" fromScore: type: number example: 1 description: The lowest score of the rating question. This attribute will be ingnored, if the value of `type` attribute is not `rating`. fromLabel: type: string example: disagree description: The lowest score label of the rating question. This attribute will be ingnored, if the value of `type` attribute is not `rating`. toScore: type: number example: 5 description: The highest score of the rating question. This attribute will be ingnored, if the value of `type` attribute is not `rating`. toLabel: type: string example: agree description: The highest score label of the rating question. This attribute will be ingnored, if the value of `type` attribute is not `rating`. options: type: array items: $ref: '#/components/schemas/QuestionOptionObject' description: Options for the question. This attribute will be ingnored, if the value of `type` attribute is `text` or `rating`. QuestionOptionObject: type: object required: - id - value properties: id: type: number example: 1 description: Unique identifier for the question option. value: type: string example: 'Yes' description: Value for the question option. SurveyResultObject: type: object required: - id - surveyName - meetingId - email - displayName - createTime - questions properties: id: type: string example: 18d2e565770c4eee918784ee333510ec description: Unique identifier for the survey result. surveyName: type: string example: Survey name description: Name for the survey. meetingId: type: string example: 560d7b784f5143e3be2fc3064a5c4999 description: Unique identifier for the meeting. email: type: string example: bob@example.com description: Email address of the user who submits the survey. displayName: type: string example: Bob description: Name of the user who submits the survey. createTime: type: string example: '2022-07-06T14:13:06+08:00' description: The time when the user submits the survey. questions: type: array items: $ref: '#/components/schemas/QuestionWithAnswersObject' description: User's answers for the questions GetInterpreterObject: type: object required: - id - languageCode1 - languageCode2 properties: id: type: string example: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM description: Unique identifier for meeting interpreter. languageCode1: type: string example: en description: The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). languageCode2: type: string example: de description: The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). email: type: string example: marcus.hoffmann@example.com description: Email address of meeting interpreter. displayName: type: string example: Hoffmann description: Display name of meeting interpreter. CustomizedQuestionForGetMeeting: type: object required: - id - question - type properties: id: type: number example: 330521 description: Unique identifier for the question. question: type: string example: How are you description: Title of the customized question. required: type: boolean example: true description: Whether or not the customized question is required to be answered by participants. type: type: string enum: - singleLineTextBox - multiLineTextBox - checkbox - dropdownList - radioButtons description: "Type of the question being asked.\n * `singleLineTextBox` - Single line text box.\n * `multiLineTextBox` - Multiple line text box.\n * `checkbox` - Check box which requires `options`.\n * `dropdownList` - Drop down list box which requires `options`.\n * `radioButtons` - Single radio button which requires `options`.\n" maxLength: type: number description: 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: type: array items: type: object required: - id - value properties: id: type: number example: 1 description: The unique id of options. value: type: string example: green description: The content of the option. description: TThe content of `options`. Required if the question type is one of `checkbox`, `dropdownList`, or `radioButtons`. rules: type: array items: type: object required: - condition - value - result - order properties: condition: type: string enum: - contains - notContains - beginsWith - endsWith - equals - notEquals description: "Judgment expression for approval rules.\n * `contains` - The content of the answer contains the value.\n * `notContains` - The content of the answer does not contain the value\n * `beginsWith` - The content of the answer begins with the value.\n * `endsWith` - The content of the answer ends with the value.\n * `equals` - The content of the answer is the same as the value.\n * `notEquals` - The content of the answer is not the same as the value.\n" value: type: string example: tom description: The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed. result: type: string enum: - approve - reject description: "The automatic approval result for the approval rule.\n * `approve` - If the user's registration value meets the criteria, the registration form will be automatically approved.\n * `reject` - If the user's registration value meets the criteria, the registration form will be automatically rejected.\n" matchCase: type: boolean example: true description: Whether to check the case of values. order: type: number example: 1 description: The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together. description: The automatic approval rules for customized questions. PreMeetingBreakoutSessionWithoutIdObject: type: object required: - name properties: name: type: string example: Breakout Session Name description: Name for breakout session. invitees: type: array items: type: string description: Invitees for breakout session. Please note that one invitee cannot be assigned to more than one breakout session. queryRegistrants: type: object required: - emails properties: status: type: string enum: - approved - pending - rejected description: "Registrant's status.\n * `approved` - Registrant has been approved.\n * `pending` - Registrant is in a pending list waiting for host or cohost approval.\n * `rejected` - Registrant has been rejected by the host or cohost.\n" orderType: type: string enum: - DESC - ASC description: Sort order for the registrants. orderBy: type: string enum: - firstName - lastName - status - email description: "Registrant ordering field. Ordered by `registrationTime` by default.\n * `firstName` - Registrant's first name.\n * `lastName` - Registrant's last name.\n * `status` - Registrant's status.\n * `email` - registrant's email.\n" emails: type: array items: type: string example: bob@example.com description: List of registrant email addresses. JoinMeetingObject: type: object properties: meetingId: type: string example: 98d8c2212c9d62b162b9565932735e59 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. 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 also supported for this API. meetingNumber: type: string example: '123456789' description: Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended. webLink: type: string example: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e description: Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join. joinDirectly: type: boolean description: Whether or not to redirect to `joinLink`. It is an optional field and default value is true. email: type: string example: brenda.song@example.com description: Email address of meeting participant. If `email` is specified, the link is generated for the user of `email`; otherwise, the API returns the link for the user calling the API. `email` is required for a [guest issuer](https://developer.webex.com/docs/guest-issuer). displayName: type: string example: Brenda Song description: Display name of meeting participant. If `displayName` is specified, `email` must be specified as well. If `email` is specified and `displayName` is not, display name is the same as `email`. If neither `displayName` nor `email` is specified, the API returns the link for the user calling the API. The maximum length of `displayName` is 128 characters. `displayName` is required for a [guest issuer](https://developer.webex.com/docs/guest-issuer). password: type: string example: BgJep@43 description: Required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost, or invitee. expirationMinutes: type: number example: 5 description: Expiration duration of `joinLink` in minutes. Must be between 1 and 60. registrationId: type: string example: '1111' description: Required when the meeting is webinar-enabled and enabled registration ID. hostEmail: type: string example: john.andersen@example.com description: Email address for the meeting host. This attribute should be set if the user or application calling the API has the admin on-behalf-of scopes. This parameter is required for a [Service App](/docs/service-apps). It only applies to meetings, not webinars. createJoinLinkAsWebLink: type: boolean description: When `createJoinLinkAsWebLink` is true, the returned `joinLink` is the webLink of the meeting, otherwise, the normal `joinLink` is returned. This parameter is applicable when the option to force the user to log in is set in Control Hub. When true, a user cannot join the meeting by the link directly and must go through the login flow. createStartLinkAsWebLink: type: boolean description: When `createStartLinkAsWebLink` is true, the returned `startLink` is the webLink of the meeting, otherwise, the normal `startLink` is returned. This parameter is applicable when the option to force the user to log in is set in Control Hub. When true, a user cannot start the meeting using the link and must go through the login flow. MeetingSeriesObject: type: object required: - id - title - password - meetingType - state - timezone - start - end - hostUserId - hostDisplayName - hostEmail - hostKey - siteUrl - webLink - telephony - enabledBreakoutSessions properties: id: type: string example: dfb45ece33264639a7bc3dd9535d53f7_20200516T230000Z description: Unique identifier for meeting. For a meeting series, the `id` is used to identify the entire series. For scheduled meetings from a series, the `id` is used to identify that scheduled meeting. For a meeting instance that is in progress or has concluded, the `id` is used to identify that instance. meetingNumber: type: string example: '123456789' description: Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended. title: type: string example: John's Meeting description: Meeting title. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. agenda: type: string example: John's Agenda description: Meeting agenda. The agenda can be a maximum of 1300 characters long. This attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. password: type: string example: BgJep@43 description: Meeting password. Applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. phoneAndVideoSystemPassword: type: string example: '12345678' description: 8-digit numeric password used to join a meeting from audio and video devices. This attribute applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. meetingType: type: string enum: - meetingSeries - scheduledMeeting - meeting description: "Meeting type.\n * `meetingSeries` - Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a `recurrence` rule. When a non-recurring meeting is scheduled with no `recurrence`, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling.\n * `scheduledMeeting` - Instance from a primary meeting series.\n * `meeting` - Meeting instance that is in progress or has completed.\n" state: type: string enum: - active - scheduled - ready - lobby - inProgress - ended - missed - expired description: "Meeting state.\n * `active` - Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.\n * `scheduled` - Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.\n * `ready` - Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.\n * `lobby` - Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.\n * `inProgress` - Applies to meeting series and meeting instances. For a meeting series, indicates that an instance of this series is happening now. For a meeting instance, indicates that the meeting has been joined and unlocked.\n * `ended` - Applies to scheduled meetings and meeting instances. For scheduled meetings, indicates that the meeting was started and is now over. For meeting instances, indicates that the meeting instance has concluded.\n * `missed` - This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.\n * `expired` - This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.\n" hostDidJoin: type: boolean description: Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state, whether or not the meeting host joined the meeting. If true, the meeting host has joined the meeitng even if they dropped off; otherwise, the meeting host hasn't ever join the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if `attendeeDidJoin` is true and `hostDidJoin` is false. attendeeDidJoin: type: boolean description: Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state. Whether or not anyone has joined the meeting. If true, the meeting host or any attendee has joined the meeting; otherwise, no one has joined the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if `attendeeDidJoin` is true and `hostDidJoin` is false. timezone: type: string example: UTC description: '[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) of `start` and `end`, conforming with the [IANA time zone database](https://www.iana.org/time-zones).' start: type: string example: '2019-03-18T11:26:30Z' description: Start time for meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If the meeting is a meeting series, `start` is the date and time the first meeting of the series starts. If the meeting is a meeting series and the `current` filter is true, `start` is the date and time the upcoming or ongoing meeting of the series starts. If the meeting is a scheduled meeting from a meeting series, `start` is the date and time when that scheduled meeting starts. If the meeting is a meeting instance that has happened or is happening, `start` is the date and time that the instance actually starts. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. end: type: string example: '2019-03-18T12:26:30Z' description: End time for a meeting in ISO 8601 compliant format. If the meeting is a meeting series, `end` is the date and time the first meeting of the series ends. If the meeting is a meeting series and the current filter is true, `end` is the date and time the upcoming or ongoing meeting of the series ends. If the meeting is a scheduled meeting from a meeting series, `end` is the date and time when that scheduled meeting ends. If the meeting is a meeting instance that has happened, `end` is the date and time that instance actually ends. If a meeting instance is in progress, `end` is not available. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. recurrence: type: string example: FREQ=DAILY;INTERVAL=1;COUNT=10 description: Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Can be modified for a meeting series using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. 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". For a non-recurring meeting which has no `recurrence`, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling. hostUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA description: Unique identifier for the meeting host. hostDisplayName: type: string example: John Andersen description: Display name for the meeting host. hostEmail: type: string example: john.andersen@example.com description: Email address for the meeting host. hostKey: type: string example: '123456' description: Key for joining the meeting as host. siteUrl: type: string example: site4-example.webex.com description: Site URL for the meeting. webLink: type: string example: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1 description: Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join. registerLink: type: string example: https://site4-example.webex.com/weblink/register/ra1c92369995314c0db8d53b2a44d78f6 description: Link to register a meeting which has enabled registration. sipAddress: type: string example: 123456789@site4-example.webex.com description: SIP address for callback from a video system. dialInIpAddress: type: string example: 192.168.100.100 description: IP address for callback from a video system. roomId: type: string example: Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2 description: Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings. enabledAutoRecordMeeting: type: boolean description: Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. allowAnyUserToBeCoHost: type: boolean description: 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 a `siteUrl` parameter when creating the meeting. If not specified, it's a user's preferred site. The `allowAnyUserToBeCoHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. enabledJoinBeforeHost: type: boolean description: Whether or not to allow any attendee to join the meeting before the host joins the meeting. The `enabledJoinBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. enableConnectAudioBeforeHost: type: boolean description: Whether or not to allow any attendee to connect to audio before the host joins the meeting. Only applicable if the `enabledJoinBeforeHost` attribute is set to `true`. The `enableConnectAudioBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. joinBeforeHostMinutes: type: number example: 15 description: Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the `enabledJoinBeforeHost` attribute is set to true. The `joinBeforeHostMinutes` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. 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 is `0` if not specified. excludePassword: type: boolean description: Whether or not to exclude the meeting password from the email invitation. publicMeeting: type: boolean description: Whether or not to allow the meeting to be listed on the public calendar. reminderTime: type: number example: 10 description: The number of minutes before the meeting begins, that an email reminder is sent to the host. unlockedMeetingJoinSecurity: type: string enum: - allowJoin - allowJoinWithLobby - blockFromJoin description: "Specifies how the people who aren't on the invite can join the unlocked meeting.\n * `allowJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoin`, people can join the unlocked meeting directly.\n * `allowJoinWithLobby` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoinWithLobby`, people will wait in the lobby until the host admits them.\n * `blockFromJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `blockFromJoin`, people can't join the unlocked meeting.\n" sessionTypeId: type: number example: 3 description: 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](/docs/api/v1/meetings/list-meeting-session-types) API. scheduledType: type: string enum: - meeting - webinar - personalRoomMeeting description: "Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings).\n * `meeting` - If the value of `scheduledType` attribute is `meeting`, it is a regular meeting.\n * `webinar` - If the value of `scheduledType` attribute is `webinar`, it is a webinar meeting.\n * `personalRoomMeeting` - If the value of `scheduledType` attribute is `personalRoomMeeting`, it is a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings).\n" enabledWebcastView: type: boolean description: Whether or not webcast view is enabled. panelistPassword: type: string example: GwLqa@78 description: Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. If not specified, a random password conforming to the site's password rules will be generated automatically. phoneAndVideoSystemPanelistPassword: type: string example: '12345678' description: 8-digit numeric panelist password to join a webinar meeting from audio and video devices. enableAutomaticLock: type: boolean description: Whether or not to automatically lock the meeting after it starts. automaticLockMinutes: type: number example: 10 description: The number of minutes after the meeting begins, for automatically locking it. allowFirstUserToBeCoHost: type: boolean description: 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 the `siteUrl` parameter when creating the meeting. If not specified, it's a user's preferred site. The `allowFirstUserToBeCoHost` attribute can be modified for a meeting series or a scheduled meeting uisng the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. allowAuthenticatedDevices: type: boolean description: Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. telephony: type: object required: - accessCode - callInNumbers properties: accessCode: type: string example: '1234567890' description: Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the `accessCode`. callInNumbers: type: array items: type: object required: - label - callInNumber - tollType properties: label: type: string example: Call-in toll-free number (US/Canada) description: Label for the call-in number. callInNumber: type: string example: '123456789' description: Call-in number to join the teleconference from a phone. tollType: type: string enum: - toll - tollFree description: Type of toll for the call-in number. description: Array of call-in numbers for joining a teleconference from a phone. links: type: array items: $ref: '#/components/schemas/LinksObjectForTelephony' description: '[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) information of global call-in numbers for joining a teleconference from a phone.' description: Information for callbacks from a meeting to phone or for joining a teleconference using a phone. meetingOptions: type: object properties: enabledChat: type: boolean example: true description: Whether or not to allow any attendee to chat in the meeting. Also depends on the session type. enabledVideo: type: boolean example: true description: Whether or not to allow any attendee to have video in the meeting. Also depends on the session type. enabledPolling: type: boolean description: 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: type: boolean example: true description: 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: type: string enum: - allowAll - allowOne description: "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.\n * `allowAll` - If the value of `noteType` attribute is `allowAll`, all participants can take notes.\n * `allowOne` - If the value of `noteType` attribute is `allowOne`, only a single note taker is allowed.\n" enabledFileTransfer: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to share [Universal Communications Format](https://www.cisco.com/c/en/us/td/docs/collaboration/training_center/wbs30/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions_chapter_0110.pdf) 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. description: Meeting Options. attendeePrivileges: type: object properties: enabledShareContent: type: boolean example: true description: Whether or not to allow any attendee to share content in the meeting. enabledSaveDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledPrintDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledAnnotate: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewParticipantList: type: boolean example: true description: Whether or not to allow any attendee to view participants. enabledViewThumbnails: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledRemoteControl: type: boolean example: true description: Whether or not to allow any attendee to control applications, web browsers, or desktops remotely. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewAnyDocument: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledViewAnyPage: type: boolean description: 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. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledContactOperatorPrivately: type: boolean description: Whether or not to allow any attendee to contact the operator privately. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatHost: type: boolean example: true description: Whether or not to allow any attendee to chat with the host in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatPresenter: type: boolean example: true description: Whether or not to allow any attendee to chat with the presenter in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). enabledChatOtherParticipants: type: boolean example: true description: Whether or not to allow any attendee to chat with other participants in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP). description: Attendee Privileges. This attribute is not supported for a webinar. registration: type: object properties: autoAcceptRequest: type: boolean description: Whether or not meeting registration requests are accepted automatically. requireFirstName: type: boolean example: true description: Whether or not a registrant's first name is required for meeting registration. requireLastName: type: boolean example: true description: Whether or not a registrant's last name is required for meeting registration. requireEmail: type: boolean example: true description: Whether or not a registrant's email is required for meeting registration. requireJobTitle: type: boolean description: Whether or not a registrant's job title is shown or required for meeting registration. requireCompanyName: type: boolean description: Whether or not a registrant's company name is shown or required for meeting registration. requireAddress1: type: boolean description: Whether or not a registrant's first address field is shown or required for meeting registration. requireAddress2: type: boolean description: Whether or not a registrant's second address field is shown or required for meeting registration. requireCity: type: boolean description: Whether or not a registrant's city is shown or required for meeting registration. requireState: type: boolean description: Whether or not a registrant's state is shown or required for meeting registration. requireZipCode: type: boolean description: Whether or not a registrant's postal code is shown or required for meeting registration. requireCountryRegion: type: boolean description: Whether or not a registrant's country or region is shown or required for meeting registration. requireWorkPhone: type: boolean description: Whether or not a registrant's work phone number is shown or required for meeting registration. requireFax: type: boolean description: Whether or not a registrant's fax number is shown or required for meeting registration. maxRegisterNum: type: number example: 1000 description: 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. customizedQuestions: type: array items: $ref: '#/components/schemas/CustomizedQuestionForGetMeeting' description: Customized questions for meeting registration. rules: type: array items: $ref: '#/components/schemas/StandardRegistrationApproveRule' description: The approval rules for standard questions. description: 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](https://help.webex.com/en-us/nmgmeff/Register-for-a-Meeting-in-Cisco-Webex-Meetings) for details. integrationTags: type: array items: type: string description: External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. simultaneousInterpretation: type: object required: - enabled properties: enabled: type: boolean description: Whether or not simultaneous interpretation is enabled. interpreters: type: array items: $ref: '#/components/schemas/InterpreterObjectForSimultaneousInterpretationOfGetOrListMeeting' description: Interpreters for meeting. description: Simultaneous interpretation information for a meeting. enabledBreakoutSessions: type: boolean description: Whether or not breakout sessions are enabled. links: type: array items: $ref: '#/components/schemas/LinksObjectForBreakoutSessions' description: '[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) Breakout Sessions information for meeting.' trackingCodes: type: array items: $ref: '#/components/schemas/TrackingCodeItemForGetMeetingObject' description: Tracking codes information. enabledAudioWatermark: type: boolean description: Whether or not the audio watermark is enabled. enabledVisualWatermark: type: boolean description: Whether or not the visual watermark is enabled. visualWatermarkOpacity: type: number example: 10 description: Opacity level for visual watermark. audioConnectionOptions: type: object properties: audioConnectionType: type: string enum: - webexAudio - VoIP - other - none description: "Choose how meeting attendees join the audio portion of the meeting.\n * `webexAudio` - Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.\n * `VoIP` - Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.\n * `other` - Other teleconference services.\n * `none` - The way of attendees join the audio portion of the meeting is the default value.\n" enabledTollFreeCallIn: type: boolean example: true description: Whether or not to show toll-free call-in numbers. enabledGlobalCallIn: type: boolean example: true description: Whether or not to show global call-in numbers to attendees. enabledAudienceCallBack: type: boolean description: 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: type: string enum: - beep - announceName - noTone description: "Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.\n * `beep` - All call-in users joining the meeting will hear the beep.\n * `announceName` - All call-in users joining the meeting will hear their names.\n * `noTone` - Turn off beeps and name announcements.\n" allowHostToUnmuteParticipants: type: boolean description: Whether or not to allow the host to unmute participants. allowAttendeeToUnmuteSelf: type: boolean example: true description: Whether or not to allow attendees to unmute themselves. muteAttendeeUponEntry: type: boolean description: Whether or not to auto-mute attendees when attendees enter meetings. description: Audio connection options. requireAttendeeLogin: type: boolean description: Require attendees to sign in before joining the webinar. restrictToInvitees: type: boolean description: Restrict webinar to invited attendees only. enabledLiveStream: type: boolean description: Whether or not live streaming is enabled. If it's 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: $ref: '#/components/schemas/LiveStreamObject' description: Live streaming settings. It applies when `enabledLiveStream` is `true`. InterpreterObjectForSimultaneousInterpretationOfGetOrListMeeting: type: object required: - id - languageCode1 - languageCode2 properties: id: type: string example: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM description: Unique identifier for meeting interpreter. languageCode1: type: string example: en description: Forms a set of simultaneous interpretation channels together with `languageCode2`. Standard language format from [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Read [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for details. languageCode2: type: string example: de description: Forms a set of simultaneous interpretation channels together with `languageCode1`. Standard language format from [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Read [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for details. email: type: string example: marcus.hoffmann@example.com description: Email address of meeting interpreter. displayName: type: string example: Hoffmann description: Display name of meeting interpreter. EndMeetingRequestObject: type: object properties: reason: type: string example: Agenda has been completed and the meeting is ended. description: The reason for ending the meeting. This field is optional. DetailedTemplateObject: type: object required: - id - name - locale - siteUrl - templateType - isDefault - isStandard - meeting properties: id: type: string example: N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM description: Unique identifier for meeting template. name: type: string example: Meeting template 1 description: Meeting template name. locale: type: string example: en_US description: Meeting template locale. siteUrl: type: string example: site4-example.webex.com description: Site URL for the meeting template. templateType: type: string enum: - meeting - webinar description: "Meeting template type.\n * `meeting` - Webex meeting.\n * `webinar` - Webex webinar.\n" isDefault: type: boolean description: Whether or not the meeting template is a default template. isStandard: type: boolean description: Whether or not the meeting template is a standard template. meeting: $ref: '#/components/schemas/CreateMeetingObject' description: Meeting object which is used to create a meeting by the meeting template. Please note that the meeting object should be used to create a meeting immediately after retrieval since the `start` and `end` may be invalid quickly after generation. SurveyLinkRequestObject: type: object properties: hostEmail: type: string example: john.andersen@example.com 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. An admin can specify the email of the meeting host who is in a site he manages and the API returns post survey links on behalf of the meeting host. meetingStartTimeFrom: type: string example: '2019-03-18T09:30:00Z' 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 and conforms with the `timezone` in the request header if specified. `meetingStartTimeFrom` cannot be after `meetingStartTimeTo`. Only applies when `meetingId` is not an instance ID. The API generates survey links for the last instance of `meetingId` in the time range specified by `meetingStartTimeFrom` and `meetingStartTimeTo`. If not specified, `meetingStartTimeFrom` 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. meetingStartTimeTo: type: string example: '2019-03-25T09:30:00Z' 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 and conforms with the `timezone` in the request header if specified. `meetingStartTimeTo` cannot be prior to `meetingStartTimeFrom`. Only applies when `meetingId` is not an instance ID. The API generates survey links for the last instance of `meetingId` in the time range specified by `meetingStartTimeFrom` and `meetingStartTimeTo`. If not specified, `meetingStartTimeTo` equals `meetingStartTimeFrom` plus `1` month; if `meetingStartTimeFrom` is also not specified, the default value for `meetingStartTimeTo` is the current date and time. emails: type: array items: type: string description: Participants' email list. The maximum size of `emails` is 100. ReassignMeetingErrorDescriptionObject: type: object required: - description properties: description: type: string example: The meeting is not found. description: Detailed description for the host reassignment of `meetingId` if it fails. JoinMeetingLinkObject: type: object properties: startLink: type: string example: https://example.dmz.webex.com/wbxmjs/joinservice/sites/example/meeting/download/b9dd6cac53564877b65589cc17d4233e?siteurl=example&integrationJoinToken=QUhTSwAAAIVboyqJZyO/aObaDYnIe0wkyteQTUFUGkboab2OL/M30apxnba6ZI4G37P0uvRMihtrYnt9wk+Wgj4GMTjeKJ0YuiEsi1PYJ9AfQcft60Mt/N6q6jEC+aldJ5PfmR+ic9dsgRn6Pgz9AmyjMSCr/3Zx7VOJXKPzWHZIc4q0EqOqDyUnWu5aEtJUldB/kZYKtUrbPUj4KUQKbc60e0tGt/St3uuBBVCuf7P45GmmyVk+b3xqlol2aUokcKlYtIig8It/NDIY5sCvCg+GHxtoEWHRGVj3+0lhNXiQfNe1vTRH7w== description: The link is used to start a meeting as the meeting host. Only the meeting host or cohost can generate the `startLink`. joinLink: type: string example: https://example.webex.com/wbxmjs/joinservice/sites/example/meeting/download/cdedf9ae847b4f9993f87e62a8889dad?siteurl=example&integrationJoinToken=QUhTSwAAAIVAFMmwcApsg+NPn9DlUdF1yv2eVVq2HaXr2vu0/4Ttl9P38kCzoA3A5CKTcDnLr79X4FSvZnZUmUPlv/4F/4/iverF7eOgZaYM5rgUayI3L9ye6lNyYGNb7ZYEAL6oo4xFUDRo8oE3+H/iBeu+nzQnkKcmnTQQPjzZVJQcZVM9tQ==&principal=QUhTSwAAAIXf3TeZvJmVBoXnIhYAIpNdFJ5pfxSftfCOhmwAlckVkd1ZuyfEMosdWeWGHDsThiN+5I55up8e5By/SIu5dUkL9QPu6qVPVhH24xIxkBHfhasau2XB0VZgyIG64tCkEcwf4s0/gJO3N/2RhWkmB669 description: The link is used to join the meeting. expiration: type: string example: '2022-05-30T09:44:08Z' description: Expiration time of `joinLink`. When both `createJoinLinkAsWebLink` and `createStartLinkAsWebLink` are true, this attribute is not returned in the response. InvitationSourceCreateObject: type: object required: - sourceId - sourceEmail properties: sourceId: type: string example: cisco description: Source ID for the invitation. sourceEmail: type: string example: john001@example.com description: Email for invitation source. QuestionWithAnswersObject: type: object required: - id - question - type properties: id: type: number example: 3388057 description: Unique identifier for the question. question: type: string example: Do you like cisco? description: Details for the question. type: type: string enum: - text - rating - checkbox - singleDropdown - singleRadio description: "Type for the question.\n * `text` - Text input.\n * `rating` - Rating.\n * `checkbox` - Check box which requires `options`.\n * `singleDropdown` - Drop down list box which requires `options`.\n * `singleRadio` - Single radio button which requires `options`.\n" answers: type: array items: $ref: '#/components/schemas/QuestionAnswerObject' description: The user's answers for the question. TrackingCodeItemForCreateMeetingObject: type: object required: - name - value properties: name: type: string example: Department description: Name of the tracking code. The name cannot be empty and the maximum size is 120 characters. value: type: string description: Value for the tracking code. `value` cannot be empty and the maximum size is 120 characters. RegistrantFormObject: type: object required: - firstName - lastName - email properties: firstName: type: string example: Bob description: The registrant's first name. lastName: type: string example: Lee description: The registrant's last name. (Required) email: type: string example: bob@example.com description: The registrant's email. sendEmail: type: boolean example: true description: 'If `true` send email to the registrant. Default: `true`.' jobTitle: type: string example: manager description: The registrant's job title. Registration options define whether or not this is required. companyName: type: string example: Cisco Systems, Inc. description: The registrant's company. Registration options define whether or not this is required. address1: type: string example: address1 string description: The registrant's first address line. Registration options define whether or not this is required. address2: type: string example: address2 string description: The registrant's second address line. Registration options define whether or not this is required. city: type: string example: New York description: The registrant's city name. Registration options define whether or not this is required. state: type: string example: New York description: The registrant's state. Registration options define whether or not this is required. zipCode: type: number example: 123456 description: The registrant's postal code. Registration options define whether or not this is required. countryRegion: type: string example: United States description: The America is not a country or a specific region. Registration options define whether or not this is required. workPhone: type: string example: +1 123456 description: The registrant's work phone number. Registration options define whether or not this is required. fax: type: string example: '123456' description: The registrant's FAX number. Registration options define whether or not this is required. customizedQuestions: type: array items: $ref: '#/components/schemas/CustomizedRegistrant' description: The registrant's answers for customized questions. Registration options define whether or not this is required. InterpreterObjectForSimultaneousInterpretationOfCreateOrUpdateMeeting: type: object required: - languageCode1 - languageCode2 properties: languageCode1: type: string example: en description: Forms a set of simultaneous interpretation channels together with `languageCode2`. Standard language format from [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Read [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for details. languageCode2: type: string example: de description: Forms a set of simultaneous interpretation channels together with `languageCode1`. Standard language format from [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code. Read [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for details. email: type: string example: marcus.hoffmann@example.com description: Email address of meeting interpreter. displayName: type: string example: Hoffmann description: Display name of meeting interpreter. OptionsForTrackingCodeObject: type: object required: - value - defaultValue properties: value: type: string description: The value of a tracking code option. `value` cannot be empty and the maximum size is 120 characters. defaultValue: type: boolean description: Whether or not the option is the default option of a tracking code. PreMeetingBreakoutSessionObject: type: object required: - id - name properties: id: type: string example: 18d2e565770c4eee918784ee333510ec description: Unique identifier for breakout session. name: type: string example: Breakout Session Name description: Name for breakout session. invitees: type: array items: type: string description: Invitees for breakout session. Only applies to breakout sessions which are created when meeting is scheduled. UpdateMeetingSimultaneousInterpretationObject: type: object required: - enabled properties: enabled: type: boolean description: Whether or not simultaneous interpretation is enabled. interpreters: type: array items: $ref: '#/components/schemas/InterpreterObjectForSimultaneousInterpretationOfCreateOrUpdateMeeting' description: Interpreters for meeting. QuestionAnswerObject: type: object required: - optionId - answer properties: optionId: type: number example: 1 description: Unique identifier for the question option. This attribute will be ingnored, if the value of `type` attribute is `text` or `rating`. answer: type: string example: 'Yes' description: The user's answers for the question. LinksObjectForTelephony: type: object required: - rel - href - method properties: rel: type: string example: globalCallinNumbers description: Link relation describing how the target resource is related to the current context (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). href: type: string example: /api/v1/meetings/2c87cf8ece4e414a9fe5516e4a0aac76/globalCallinNumbers description: Target resource URI (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). method: type: string example: GET description: Target resource method (conforming with [RFC5998](https://tools.ietf.org/html/rfc5988)). MeetingTrackingCodesObject: type: object required: - id - name - siteUrl - options - inputMode - service - type properties: id: type: string example: '1' description: Unique identifier for the tracking code. name: type: string example: Department description: Name for the tracking code. siteUrl: type: string example: example.webex.com description: Site URL for the tracking code. options: type: array items: $ref: '#/components/schemas/OptionsForTrackingCodeObject' description: Tracking code option list. 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. If there's user-level value for a tracking code, the user-level value becomes the default option for the tracking code, and the site-level default value becomes non-default. inputMode: type: string enum: - text - select - editableSelect - hostProfileSelect description: "The input mode in which the tracking code value can be assigned.\n * `text` - Text input.\n * `select` - Drop down list which requires `options`.\n * `editableSelect` - Both text input and select from list.\n * `hostProfileSelect` - An input method which is only available for the host profile and sign-up pages.\n" service: type: string enum: - All - MeetingCenter - EventCenter - TrainingCenter - SupportCenter description: "Service for schedule or sign up pages\n * `All` - Tracking codes apply to all services.\n * `MeetingCenter` - Users can set tracking codes when scheduling a meeting.\n * `EventCenter` - Users can set tracking codes when scheduling an event.\n * `TrainingCenter` - Users can set tracking codes when scheduling a training session.\n * `SupportCenter` - Users can set tracking codes when scheduling a support meeting.\n" type: type: string enum: - optional - required - adminSet - notUsed - notApplicable description: "Type for meeting scheduler or meeting start pages.\n * `optional` - Available to be chosen but not compulsory.\n * `required` - Officially compulsory.\n * `adminSet` - The value is set by admin.\n * `notUsed` - The value cannot be used.\n * `notApplicable` - This value only applies to the service of `All`. When the type of `All` for a tracking code is `notApplicable`, there are different types for different services. For example, `required` for `MeetingCenter`, `optional` for `EventCenter` and `notUsed` for others.\n" MeetingSessionTypeObject: type: object required: - id - name - type properties: id: type: string example: '628' description: Unique identifier for the meeting session type. name: type: string example: Webex Meetings EC 2.0 meeting description: Name of the meeting session type. type: type: string enum: - meeting - webinar - privateMeeting description: "Meeting session type.\n * `meeting` - Meeting session type for a meeting.\n * `webinar` - Meeting session type for a webinar.\n * `privateMeeting` - Meeting session type for a private meeting.\n" attendeesCapacity: type: number example: 1000 description: The maximum number of attendees for the meeting session type. CustomizedQuestionForCreateMeeting: type: object required: - question - type properties: question: type: string example: How are you description: Title of the customized question. required: type: boolean example: true description: Whether or not the customized question is required to be answered by participants. type: type: string enum: - singleLineTextBox - multiLineTextBox - checkbox - dropdownList - radioButtons description: "Type of the question being asked.\n * `singleLineTextBox` - Single line text box.\n * `multiLineTextBox` - Multiple line text box.\n * `checkbox` - Check box which requires `options`.\n * `dropdownList` - Drop down list box which requires `options`.\n * `radioButtons` - Single radio button which requires `options`.\n" maxLength: type: number description: 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: type: array items: type: object required: - value properties: value: type: string example: green description: The content of the option. description: The content of `options`. Required if the question type is one of `checkbox`, `dropdownList`, or `radioButtons`. rules: type: array items: type: object required: - condition - value - result properties: condition: type: string enum: - contains - notContains - beginsWith - endsWith - equals - notEquals description: "Judgment expression for approval rules.\n * `contains` - The content of the answer contains the value.\n * `notContains` - The content of the answer does not contain the value\n * `beginsWith` - The content of the answer begins with the value.\n * `endsWith` - The content of the answer ends with the value.\n * `equals` - The content of the answer is the same as the value.\n * `notEquals` - The content of the answer is not the same as the value.\n" value: type: string example: tom description: The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed. result: type: string enum: - approve - reject description: "The automatic approval result for the approval rule.\n * `approve` - If the user's registration value meets the criteria, the registration form will be automatically approved.\n * `reject` - If the user's registration value meets the criteria, the registration form will be automatically rejected.\n" matchCase: type: boolean example: true description: Whether to check the case of values. description: The automatic approval rules for customized questions. TrackingCodeItemForGetMeetingObject: type: object required: - name - value properties: name: type: string example: Department description: Name for the tracking code. value: type: string description: Value for the tracking code. InvitationSourceObject: type: object required: - id - sourceId - sourceEmail properties: id: type: string example: '1' description: Unique identifier for invitation source. sourceId: type: string example: cisco description: Source ID for invitation. sourceEmail: type: string example: john001@example.com description: Email for invitation source. joinLink: type: string example: https://example.webex.com/example/j.php?MTID=m6d75f1c875b3e3c5d18c7598036bdd8b description: The link bound to `sourceId` can directly join the meeting. If the meeting requires registration,`joinLink` is not returned. registerLink: type: string example: https://example.webex.com/example/j.php?RGID=rb05b31307b5b820e16594da9d1cfc588 description: The link bound to `sourceId` can directly register the meeting. If the meeting requires registration, `registerLink` is returned. SurveyLinkObject: type: object properties: email: type: string example: kingu1@example.com description: Participant email. surveyLink: type: string example: https://example.webex.com/webappng/sites/example/meeting/surveyPage/fa1fc86f70d74c08bc7dc5a3b499ab98?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaXRlSWQiOjIwNjI4NDIsImJpcnRoVGltZSI6MTY4ODQzODYwODY4NCwiZW1haWwiOiJRVWhUU3dBQUFJVllnWEhTSVJLa2hzN2pIR0lCNzJxVDM3SDc5a1NLWjcwUFNBVG9aekJYeHV3KzhJenZnd3l6ZEJ5ZGFDeGc1TnZLcW9mRHV4RjlqdWpGeWhld3EyRmFsWVpNTU9Sa3drNVRNQWZZR2lTUVFRPT0iLCJtZWV0aW5nSW5zdGFuY2VJZCI6Ijc0Y2YyZTJhMjI0ZDQ3OTViM2QwMjliMDZjMGI4NWFjX0lfMjY0Mzg5MTg4NzU2OTY1MjUxIn0.SDJTSwAAAIVIzXgb0wNfEdKwDeRiGzxLWfhoSG5blNcDoCslAiserg description: Meeting survey Link for the participant. LiveStreamObject: type: object required: - destination - rtmpUrl - streamUrl properties: destination: type: string example: Facebook description: A descriptive text to describe the destination of the live streaming. rtmpUrl: type: string example: rtmps://example.com:1935/MediaLive/WebexStreaming description: Live streaming RTMP URL. streamUrl: type: string example: https://example.com/Webex-Streaming/index_a.m3u8 description: The URL to view the live streaming, i.e. the playback URL. layoutWithoutSharedContent: type: string enum: - grid - stack - focus description: "Live streaming layout when there's no shared content.\n * `grid` - The video layout that allows you to see multiple participants in a meeting in grids.\n * `stack` - The video layout that displays the active speaker on the stage and up to six participants in thumbnails across the top.\n * `focus` - The video layout that only displays the active speaker.\n" layoutWithSharedContent: type: string enum: - stack - focusedContentWithActiveSpeaker - focusedContent description: "Live streaming layout when there's shared content.\n * `stack` - The video layout that displays the shared content on the stage and up to six participants in thumbnails across the top.\n * `focusedContentWithActiveSpeaker` - 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.\n * `focusedContent` - The layout that only displays the shared content in the main part of the screen and does not display the participants.\n" allowChangeLayoutInMeeting: type: boolean description: Whether or not to allow change the live streaming layout in the meeitng. followStageLayoutWhenSynced: type: boolean example: true description: Whether or not to follow the stage layout when it's being synchronized. resolution: type: string example: 1920x1080 description: Resolution of the live streaming. MeetingObjectForListMeeting: type: object required: - id - meetingSeriesId - title - password - meetingType - state - timezone - start - end - hostUserId - hostDisplayName - hostEmail - hostKey - siteUrl - webLink - telephony - enabledBreakoutSessions properties: id: type: string example: dfb45ece33264639a7bc3dd9535d53f7_20200516T230000Z description: Unique identifier for meeting. For a meeting series, the `id` is used to identify the entire series. For scheduled meetings from a series, the `id` is used to identify that scheduled meeting. For a meeting instance that is in progress or has concluded, the `id` is used to identify that instance. meetingSeriesId: type: string example: dfb45ece33264639a7bc3dd9535d53f7 description: Unique identifier for meeting series. It only apples to scheduled meeting and meeting instance. If it's a scheduled meeting from a series or a meeting instance that is happening or has happened, the `meetingSeriesId` is the `id` of the primary series. scheduledMeetingId: type: string example: dfb45ece33264639a7bc3dd9535d53f7 description: Unique identifier for scheduled meeting which current meeting is associated with. It only apples to meeting instance which is happening or has happened. It's the `id` of the scheduled meeting this instance is associated with. meetingNumber: type: string example: '123456789' description: Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended. title: type: string example: John's Meeting description: Meeting title. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. agenda: type: string example: John's Agenda description: Meeting agenda. The agenda can be a maximum of 1300 characters long. This attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. password: type: string example: BgJep@43 description: Meeting password. Applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. phoneAndVideoSystemPassword: type: string example: '12345678' description: 8-digit numeric password used to join a meeting from audio and video devices. This attribute applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. meetingType: type: string enum: - meetingSeries - scheduledMeeting - meeting description: "Meeting type.\n * `meetingSeries` - Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a `recurrence` rule. When a non-recurring meeting is scheduled with no `recurrence`, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling.\n * `scheduledMeeting` - Instance from a primary meeting series.\n * `meeting` - Meeting instance that is in progress or has completed.\n" state: type: string enum: - active - scheduled - ready - lobby - inProgress - ended - missed - expired description: "Meeting state.\n * `active` - Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.\n * `scheduled` - Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.\n * `ready` - Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.\n * `lobby` - Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.\n * `inProgress` - Applies to meeting series and meeting instance. For meeting series, indicates that an instance of this series is in progress; for a meeting instances, indicates that the meeting has been joined and unlocked.\n * `ended` - Applies to scheduled meetings and meeting instances. For scheduled meetings, indicates that the meeting was started and is now over. For meeting instances, indicates that the meeting instance has concluded.\n * `missed` - This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.\n * `expired` - This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.\n" hostDidJoin: type: boolean description: Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state, whether or not the meeting host joined the meeting. If true, the meeting host has joined the meeitng even if they dropped off; otherwise, the meeting host hasn't ever join the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if `attendeeDidJoin` is true and `hostDidJoin` is false. attendeeDidJoin: type: boolean description: Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state. Whether or not anyone has joined the meeting. If true, the meeting host or any attendee has joined the meeting; otherwise, no one has joined the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if `attendeeDidJoin` is true and `hostDidJoin` is false. isModified: type: boolean description: This state only applies to scheduled meeting. Flag identifying whether or not the scheduled meeting has been modified. timezone: type: string example: UTC description: '[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) of `start` and `end`, conforming with the [IANA time zone database](https://www.iana.org/time-zones).' start: type: string example: '2019-03-18T11:26:30Z' description: Start time for meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If the meetingType of a meeting is `meetingSeries`, `start` is the scheduled start time of the first occurrence of this series. If the meeting is a meeting series and the `current` filter is true, `start` is the date and time the upcoming or ongoing meeting of the series starts. If the meetingType of a meeting is `scheduledMeeting`, `start` is the scheduled start time of this occurrence. If the meetingType of a meeting is `meeting`, `start` is the actual start time of the meeting instance. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. end: type: string example: '2019-03-18T12:26:30Z' description: End time for a meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If the meetingType of a meeting is `meetingSeries`, `end` is the scheduled end time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, `end` is the date and time the upcoming or ongoing meeting of the series ends. If the meetingType of a meeting is `scheduledMeeting`, `end` is the scheduled end time of this occurrence. If the meetingType of a meeting is `meeting`, `end` is the actual end time of the meeting instance. If a meeting instance is in progress, `end` is not available. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. recurrence: type: string example: FREQ=DAILY;INTERVAL=1;COUNT=10 description: Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Can be modified for a meeting series using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. 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". hostUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA description: Unique identifier for the meeting host. hostDisplayName: type: string example: John Andersen description: Display name for the meeting host. hostEmail: type: string example: john.andersen@example.com description: Email address for the meeting host. hostKey: type: string example: '123456' description: Key for joining the meeting as host. siteUrl: type: string example: site4-example.webex.com description: Site URL for the meeting. webLink: type: string example: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1 description: Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join. sipAddress: type: string example: 123456789@site4-example.webex.com description: SIP address for callback from a video system. dialInIpAddress: type: string example: 192.168.100.100 description: IP address for callback from a video system. roomId: type: string example: Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2 description: Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings. enabledAutoRecordMeeting: type: boolean description: Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. allowAnyUserToBeCoHost: type: boolean description: 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 a `siteUrl` parameter when creating the meeting. If not specified, it's a user's preferred site. The `allowAnyUserToBeCoHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. enabledJoinBeforeHost: type: boolean description: Whether or not to allow any attendee to join the meeting before the host joins the meeting. The `enabledJoinBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. enableConnectAudioBeforeHost: type: boolean description: Whether or not to allow any attendee to connect to audio before the host joins the meeting. Only applicable if the `enabledJoinBeforeHost` attribute is set to `true`. The `enableConnectAudioBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. joinBeforeHostMinutes: type: number example: 15 description: Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the `enabledJoinBeforeHost` attribute is set to true. The `joinBeforeHostMinutes` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. 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 is `0` if not specified. excludePassword: type: boolean description: Whether or not to exclude the meeting password from the email invitation. publicMeeting: type: boolean description: Whether or not to allow the meeting to be listed on the public calendar. reminderTime: type: number example: 10 description: The number of minutes before the meeting begins, that an email reminder is sent to the host. unlockedMeetingJoinSecurity: type: string enum: - allowJoin - allowJoinWithLobby - blockFromJoin description: "Specifies how the people who aren't on the invite can join the unlocked meeting.\n * `allowJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoin`, people can join the unlocked meeting directly.\n * `allowJoinWithLobby` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoinWithLobby`, people will wait in the lobby until the host admits them.\n * `blockFromJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `blockFromJoin`, people can't join the unlocked meeting.\n" sessionTypeId: type: number example: 3 description: 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](/docs/api/v1/meetings/list-meeting-session-types) API. scheduledType: type: string enum: - meeting - webinar - personalRoomMeeting description: "Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings).\n * `meeting` - If the value of `scheduledType` attribute is `meeting`, it is a regular meeting.\n * `webinar` - If the value of `scheduledType` attribute is `webinar`, it is a webinar meeting.\n * `personalRoomMeeting` - If the value of `scheduledType` attribute is `personalRoomMeeting`, it is a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings).\n" enabledWebcastView: type: boolean description: Whether or not webcast view is enabled. panelistPassword: type: string example: GwLqa@78 description: Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. If not specified, a random password conforming to the site's password rules will be generated automatically. phoneAndVideoSystemPanelistPassword: type: string example: '12345678' description: 8-digit numeric panelist password to join a webinar meeting from audio and video devices. enableAutomaticLock: type: boolean description: Whether or not to automatically lock the meeting after it starts. automaticLockMinutes: type: number example: 10 description: The number of minutes after the meeting begins, for automatically locking it. allowFirstUserToBeCoHost: type: boolean description: 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 the `siteUrl` parameter when creating the meeting. If not specified, it's a user's preferred site. The `allowFirstUserToBeCoHost` attribute can be modified for a meeting series or a scheduled meeting uisng the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. allowAuthenticatedDevices: type: boolean description: Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. hasChat: type: boolean description: Whether or not this meeting instance has chat. hasRecording: type: boolean description: Whether or not this meeting instance has been recorded. `true` if the meeting instance has been recorded even if the recording has been deleted. hasTranscription: type: boolean description: Whether or not this meeting instance has a transcription. hasClosedCaption: type: boolean description: Whether or not this meeting instance has closed captions. hasPolls: type: boolean description: Whether or not this meeting instance has polls. hasQA: type: boolean description: Whether or not this meeting instance has Q&A. hasSlido: type: boolean description: Whether or not this meeting instance has Slido interactions. It's true if Slido is enabled in the meeting and there are interactions like Q&A or polling in Slido. hasRegistration: type: boolean description: Whether or not this meeting instance has a registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances. hasRegistrants: type: boolean description: Whether or not someone has registered a this meeting instance via the registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances. hasPostEventSurvey: type: boolean description: Whether this meeting instance has a survey and someone has responded to the survey. Only applies to ended webinar instances. Doesn't apply to meeting series, scheduled meetings, in-progress meeting or webinar instances, or ended meeting instances. telephony: type: object required: - accessCode - callInNumbers properties: accessCode: type: string example: '1234567890' description: Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the `accessCode`. callInNumbers: type: array items: type: object required: - label - callInNumber - tollType properties: label: type: string example: Call-in toll-free number (US/Canada) description: Label for the call-in number. callInNumber: type: string example: '123456789' description: Call-in number to join the teleconference from a phone. tollType: type: string enum: - toll - tollFree description: Type of toll for the call-in number. description: Array of call-in numbers for joining a teleconference from a phone. links: type: array items: $ref: '#/components/schemas/LinksObjectForTelephony' description: '[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) information of global call-in numbers for joining a teleconference from a phone.' description: Information for callbacks from a meeting to phone or for joining a teleconference using a phone. meetingOptions: type: object properties: enabledChat: type: boolean example: true description: Whether or not to allow any attendee to chat in the meeting. Also depends on the session type. enabledVideo: type: boolean example: true description: Whether or not to allow any attendee to have video in the meeting. Also depends on the session type. enabledPolling: type: boolean description: 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: type: boolean example: true description: 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: type: string enum: - allowAll - allowOne description: "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.\n * `allowAll` - If the value of `noteType` attribute is `allowAll`, all participants can take notes.\n * `allowOne` - If the value of `noteType` attribute is `allowOne`, only a single note taker is allowed.\n" enabledFileTransfer: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to share [Universal Communications Format](https://www.cisco.com/c/en/us/td/docs/collaboration/training_center/wbs30/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions_chapter_0110.pdf) 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. description: Meeting Options. attendeePrivileges: type: object properties: enabledShareContent: type: boolean example: true description: Whether or not to allow any attendee to share content in the meeting. enabledSaveDocument: type: boolean description: 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: type: boolean description: 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: type: boolean description: 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: type: boolean example: true description: Whether or not to allow any attendee to view participants. enabledViewThumbnails: type: boolean description: 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: type: boolean example: true description: Whether or not to allow any attendee to control applications, web browsers, or desktops remotely. enabledViewAnyDocument: type: boolean description: 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: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to contact the operator privately. enabledChatHost: type: boolean example: true description: Whether or not to allow any attendee to chat with the host in private. enabledChatPresenter: type: boolean example: true description: Whether or not to allow any attendee to chat with the presenter in private. enabledChatOtherParticipants: type: boolean example: true description: Whether or not to allow any attendee to chat with other participants in private. description: Attendee Privileges. This attribute is not supported for a webinar. registration: type: object properties: autoAcceptRequest: type: boolean description: Whether or not meeting registration requests are accepted automatically. requireFirstName: type: boolean example: true description: Whether or not a registrant's first name is required for meeting registration. requireLastName: type: boolean example: true description: Whether or not a registrant's last name is required for meeting registration. requireEmail: type: boolean example: true description: Whether or not a registrant's email is required for meeting registration. requireJobTitle: type: boolean description: Whether or not a registrant's job title is shown or required for meeting registration. requireCompanyName: type: boolean description: Whether or not a registrant's company name is shown or required for meeting registration. requireAddress1: type: boolean description: Whether or not a registrant's first address field is shown or required for meeting registration. requireAddress2: type: boolean description: Whether or not a registrant's second address field is shown or required for meeting registration. requireCity: type: boolean description: Whether or not a registrant's city is shown or required for meeting registration. requireState: type: boolean description: Whether or not a registrant's state is shown or required for meeting registration. requireZipCode: type: boolean description: Whether or not a registrant's postal code is shown or required for meeting registration. requireCountryRegion: type: boolean description: Whether or not a registrant's country or region is shown or required for meeting registration. requireWorkPhone: type: boolean description: Whether or not a registrant's work phone number is shown or required for meeting registration. requireFax: type: boolean description: Whether or not a registrant's fax number is shown or required for meeting registration. maxRegisterNum: type: number example: 1000 description: 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. description: 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](https://help.webex.com/en-us/nmgmeff/Register-for-a-Meeting-in-Cisco-Webex-Meetings) for details. integrationTags: type: array items: type: string description: External keys created by an integration application in its domain, for example, Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. simultaneousInterpretation: type: object required: - enabled properties: enabled: type: boolean description: Whether or not simultaneous interpretation is enabled. interpreters: type: array items: $ref: '#/components/schemas/InterpreterObjectForSimultaneousInterpretationOfGetOrListMeeting' description: Interpreters for meeting. description: Simultaneous interpretation information for the meeting. enabledBreakoutSessions: type: boolean description: Whether or not breakout sessions are enabled. links: type: array items: $ref: '#/components/schemas/LinksObjectForBreakoutSessions' description: '[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) Breakout Sessions information for meeting.' trackingCodes: type: array items: $ref: '#/components/schemas/TrackingCodeItemForGetMeetingObject' description: Tracking codes information. enabledAudioWatermark: type: boolean description: Whether or not the audio watermark is enabled. enabledVisualWatermark: type: boolean description: Whether or not the visual watermark is enabled. visualWatermarkOpacity: type: number example: 10 description: Opacity level for visual watermark. audioConnectionOptions: type: object properties: audioConnectionType: type: string enum: - webexAudio - VoIP - other - none description: "Choose how meeting attendees join the audio portion of the meeting.\n * `webexAudio` - Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.\n * `VoIP` - Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.\n * `other` - Other teleconference services.\n * `none` - The way of attendees join the audio portion of the meeting is the default value.\n" enabledTollFreeCallIn: type: boolean example: true description: Whether or not to show toll-free call-in numbers. enabledGlobalCallIn: type: boolean example: true description: Whether or not to show global call-in numbers to attendees. enabledAudienceCallBack: type: boolean description: 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: type: string enum: - beep - announceName - noTone description: "Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.\n * `beep` - All call-in users joining the meeting will hear the beep.\n * `announceName` - All call-in users joining the meeting will hear their names.\n * `noTone` - Turn off beeps and name announcements.\n" allowHostToUnmuteParticipants: type: boolean description: Whether or not to allow the host to unmute participants. allowAttendeeToUnmuteSelf: type: boolean example: true description: Whether or not to allow attendees to unmute themselves. muteAttendeeUponEntry: type: boolean description: Whether or not to auto-mute attendees when attendees enter meetings. description: Audio connection options. requireAttendeeLogin: type: boolean description: Require attendees to sign in before joining the webinar. restrictToInvitees: type: boolean description: Restrict webinar to invited attendees only. enabledLiveStream: type: boolean description: Whether or not live streaming is enabled. If it's 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: $ref: '#/components/schemas/LiveStreamObject' description: Live streaming settings. It applies when `enabledLiveStream` is `true`. RegistrantCreateResponse: type: object properties: id: type: string example: '123456' description: New registrant's ID. status: type: string enum: - approved - pending - rejected description: "New registrant's status.\n * `approved` - Registrant has been approved.\n * `pending` - Registrant is in a pending list waiting for host or cohost approval.\n * `rejected` - Registrant has been rejected by the host or cohost.\n" firstName: type: string example: bob description: Registrant's first name. lastName: type: string example: Lee description: Registrant's last name. email: type: string example: bob@example.com description: Registrant's email. jobTitle: type: string example: manager description: Registrant's job title. companyName: type: string example: cisco description: Registrant's company. address1: type: string example: address1 string description: Registrant's first address line. address2: type: string example: address2 string description: Registrant's second address line. city: type: string example: New York description: Registrant's city name. state: type: string example: New York description: Registrant's state. zipCode: type: number example: 123456 description: Registrant's postal code. countryRegion: type: string example: United States description: Registrant's country or region. workPhone: type: string example: +1 123456 description: Registrant's work phone number. fax: type: string example: '123456' description: Registrant's FAX number. registrationTime: type: string example: '2021-09-07T09:29:13+08:00' description: Registrant's registration time. customizedQuestions: type: array items: $ref: '#/components/schemas/CustomizedRegistrant' description: Registrant's answers for customized questions, Registration options define whether or not this is required. GetMeetingSimultaneousInterpretationObject: type: object required: - enabled properties: enabled: type: boolean description: Whether or not simultaneous interpretation is enabled. interpreters: type: array items: $ref: '#/components/schemas/InterpreterObjectForSimultaneousInterpretationOfGetOrListMeeting' description: Interpreters for meeting. MeetingObjectForAdminListMeeting: type: object required: - id - meetingSeriesId - title - meetingType - state - timezone - start - end - hostUserId - hostDisplayName - hostEmail - siteUrl - telephony - enabledBreakoutSessions properties: id: type: string example: dfb45ece33264639a7bc3dd9535d53f7_20200516T230000Z description: Unique identifier for meeting. For a meeting series, the `id` is used to identify the entire series. For scheduled meetings from a series, the `id` is used to identify that scheduled meeting. For a meeting instance that is in progress or has concluded, the `id` is used to identify that instance. meetingSeriesId: type: string example: dfb45ece33264639a7bc3dd9535d53f7 description: Unique identifier for meeting series. It only apples to scheduled meeting and meeting instance. If it's a scheduled meeting from a series or a meeting instance that is happening or has happened, the `meetingSeriesId` is the `id` of the primary series. scheduledMeetingId: type: string example: dfb45ece33264639a7bc3dd9535d53f7 description: Unique identifier for scheduled meeting which current meeting is associated with. It only apples to meeting instance which is happening or has happened. It's the `id` of the scheduled meeting this instance is associated with. meetingNumber: type: string example: '123456789' description: Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended. title: type: string example: John's Meeting description: Meeting title. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. meetingType: type: string enum: - meetingSeries - scheduledMeeting - meeting description: "Meeting type.\n * `meetingSeries` - Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a `recurrence` rule. When a non-recurring meeting is scheduled with no `recurrence`, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling.\n * `scheduledMeeting` - Instance from a primary meeting series.\n * `meeting` - Meeting instance that is in progress or has completed.\n" state: type: string enum: - active - scheduled - ready - lobby - inProgress - ended - missed - expired description: "Meeting state.\n * `active` - Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.\n * `scheduled` - Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.\n * `ready` - Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.\n * `lobby` - Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.\n * `inProgress` - Applies to meeting series and meeting instance. For meeting series, indicates that an instance of this series is in progress; for a meeting instances, indicates that the meeting has been joined and unlocked.\n * `ended` - Applies to scheduled meetings and meeting instances. For scheduled meetings, indicates that the meeting was started and is now over. For meeting instances, indicates that the meeting instance has concluded.\n * `missed` - This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.\n * `expired` - This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.\n" hostDidJoin: type: boolean description: Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state, whether or not the meeting host joined the meeting. If true, the meeting host has joined the meeitng even if they dropped off; otherwise, the meeting host hasn't ever join the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if `attendeeDidJoin` is true and `hostDidJoin` is false. attendeeDidJoin: type: boolean description: Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state. Whether or not anyone has joined the meeting. If true, the meeting host or any attendee has joined the meeting; otherwise, no one has joined the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if `attendeeDidJoin` is true and `hostDidJoin` is false. isModified: type: boolean description: This state only applies to scheduled meeting. Flag identifying whether or not the scheduled meeting has been modified. timezone: type: string example: UTC description: '[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) of `start` and `end`, conforming with the [IANA time zone database](https://www.iana.org/time-zones).' start: type: string example: '2019-03-18T11:26:30Z' description: Start time for meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If the meetingType of a meeting is `meetingSeries`, `start` is the scheduled start time of the first occurrence of this series. If the meeting is a meeting series and the `current` filter is true, `start` is the date and time the upcoming or ongoing meeting of the series starts. If the meetingType of a meeting is `scheduledMeeting`, `start` is the scheduled start time of this occurrence. If the meetingType of a meeting is `meeting`, `start` is the actual start time of the meeting instance. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. end: type: string example: '2019-03-18T12:26:30Z' description: End time for a meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If the meetingType of a meeting is `meetingSeries`, `end` is the scheduled end time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, `end` is the date and time the upcoming or ongoing meeting of the series ends. If the meetingType of a meeting is `scheduledMeeting`, `end` is the scheduled end time of this occurrence. If the meetingType of a meeting is `meeting`, `end` is the actual end time of the meeting instance. If a meeting instance is in progress, `end` is not available. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. recurrence: type: string example: FREQ=DAILY;INTERVAL=1;COUNT=10 description: Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Can be modified for a meeting series using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. 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". hostUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA description: Unique identifier for the meeting host. hostDisplayName: type: string example: John Andersen description: Display name for the meeting host. hostEmail: type: string example: john.andersen@example.com description: Email address for the meeting host. siteUrl: type: string example: site4-example.webex.com description: Site URL for the meeting. roomId: type: string example: Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2 description: Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings. enabledAutoRecordMeeting: type: boolean description: Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. allowAnyUserToBeCoHost: type: boolean description: 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 a `siteUrl` parameter when creating the meeting. If not specified, it's a user's preferred site. The `allowAnyUserToBeCoHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. enabledJoinBeforeHost: type: boolean description: Whether or not to allow any attendee to join the meeting before the host joins the meeting. The `enabledJoinBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. enableConnectAudioBeforeHost: type: boolean description: Whether or not to allow any attendee to connect to audio before the host joins the meeting. Only applicable if the `enabledJoinBeforeHost` attribute is set to `true`. The `enableConnectAudioBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. joinBeforeHostMinutes: type: number example: 15 description: Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the `enabledJoinBeforeHost` attribute is set to true. The `joinBeforeHostMinutes` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. 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 is `0` if not specified. excludePassword: type: boolean description: Whether or not to exclude the meeting password from the email invitation. publicMeeting: type: boolean description: Whether or not to allow the meeting to be listed on the public calendar. reminderTime: type: number example: 10 description: The number of minutes before the meeting begins, that an email reminder is sent to the host. unlockedMeetingJoinSecurity: type: string enum: - allowJoin - allowJoinWithLobby - blockFromJoin description: "Specifies how the people who aren't on the invite can join the unlocked meeting.\n * `allowJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoin`, people can join the unlocked meeting directly.\n * `allowJoinWithLobby` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoinWithLobby`, people will wait in the lobby until the host admits them.\n * `blockFromJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `blockFromJoin`, people can't join the unlocked meeting.\n" sessionTypeId: type: number example: 3 description: 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](/docs/api/v1/meetings/list-meeting-session-types) API. scheduledType: type: string enum: - meeting - webinar - personalRoomMeeting description: "Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings).\n * `meeting` - If the value of `scheduledType` attribute is `meeting`, it is a regular meeting.\n * `webinar` - If the value of `scheduledType` attribute is `webinar`, it is a webinar meeting.\n * `personalRoomMeeting` - If the value of `scheduledType` attribute is `personalRoomMeeting`, it is a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings).\n" enabledWebcastView: type: boolean description: Whether or not webcast view is enabled. enableAutomaticLock: type: boolean description: Whether or not to automatically lock the meeting after it starts. automaticLockMinutes: type: number example: 10 description: The number of minutes after the meeting begins, for automatically locking it. allowFirstUserToBeCoHost: type: boolean description: 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 the `siteUrl` parameter when creating the meeting. If not specified, it's a user's preferred site. The `allowFirstUserToBeCoHost` attribute can be modified for a meeting series or a scheduled meeting uisng the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. allowAuthenticatedDevices: type: boolean description: Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. hasChat: type: boolean description: Whether or not this meeting instance has chat. hasRecording: type: boolean description: Whether or not this meeting instance has been recorded. `true` if the meeting instance has been recorded even if the recording has been deleted. hasTranscription: type: boolean description: Whether or not this meeting instance has a transcription. hasSummary: type: boolean description: Whether or not this meeting instance has a summary. hasClosedCaption: type: boolean description: Whether or not this meeting instance has closed captions. hasPolls: type: boolean description: Whether or not this meeting instance has polls. hasQA: type: boolean description: Whether or not this meeting instance has Q&A. hasRegistration: type: boolean description: Whether or not this meeting instance has a registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances. hasRegistrants: type: boolean description: Whether or not someone has registered a this meeting instance via the registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances. hasPostEventSurvey: type: boolean description: Whether this meeting instance has a survey and someone has responded to the survey. Only applies to ended webinar instances. Doesn't apply to meeting series, scheduled meetings, in-progress meeting or webinar instances, or ended meeting instances. telephony: type: object required: - callInNumbers properties: callInNumbers: type: array items: type: object required: - label - callInNumber - tollType properties: label: type: string example: Call-in toll-free number (US/Canada) description: Label for the call-in number. callInNumber: type: string example: '123456789' description: Call-in number to join the teleconference from a phone. tollType: type: string enum: - toll - tollFree description: Type of toll for the call-in number. description: Array of call-in numbers for joining a teleconference from a phone. links: type: array items: $ref: '#/components/schemas/LinksObjectForTelephony' description: '[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) information of global call-in numbers for joining a teleconference from a phone.' description: Information for callbacks from a meeting to phone or for joining a teleconference using a phone. meetingOptions: type: object properties: enabledChat: type: boolean example: true description: Whether or not to allow any attendee to chat in the meeting. Also depends on the session type. enabledVideo: type: boolean example: true description: Whether or not to allow any attendee to have video in the meeting. Also depends on the session type. enabledPolling: type: boolean description: 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: type: boolean example: true description: 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: type: string enum: - allowAll - allowOne description: "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.\n * `allowAll` - If the value of `noteType` attribute is `allowAll`, all participants can take notes.\n * `allowOne` - If the value of `noteType` attribute is `allowOne`, only a single note taker is allowed.\n" enabledFileTransfer: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to share [Universal Communications Format](https://www.cisco.com/c/en/us/td/docs/collaboration/training_center/wbs30/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions_chapter_0110.pdf) 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. description: Meeting Options. attendeePrivileges: type: object properties: enabledShareContent: type: boolean example: true description: Whether or not to allow any attendee to share content in the meeting. enabledSaveDocument: type: boolean description: 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: type: boolean description: 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: type: boolean description: 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: type: boolean example: true description: Whether or not to allow any attendee to view participants. enabledViewThumbnails: type: boolean description: 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: type: boolean example: true description: Whether or not to allow any attendee to control applications, web browsers, or desktops remotely. enabledViewAnyDocument: type: boolean description: 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: type: boolean description: 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: type: boolean description: Whether or not to allow any attendee to contact the operator privately. enabledChatHost: type: boolean example: true description: Whether or not to allow any attendee to chat with the host in private. enabledChatPresenter: type: boolean example: true description: Whether or not to allow any attendee to chat with the presenter in private. enabledChatOtherParticipants: type: boolean example: true description: Whether or not to allow any attendee to chat with other participants in private. description: Attendee Privileges. This attribute is not supported for a webinar. integrationTags: type: array items: type: string description: External keys created by an integration application in its domain, for example, Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. simultaneousInterpretation: type: object required: - enabled properties: enabled: type: boolean description: Whether or not simultaneous interpretation is enabled. interpreters: type: array items: $ref: '#/components/schemas/InterpreterObjectForSimultaneousInterpretationOfGetOrListMeeting' description: Interpreters for meeting. description: Simultaneous interpretation information for the meeting. enabledBreakoutSessions: type: boolean description: Whether or not breakout sessions are enabled. links: type: array items: $ref: '#/components/schemas/LinksObjectForBreakoutSessions' description: '[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) Breakout Sessions information for meeting.' trackingCodes: type: array items: $ref: '#/components/schemas/TrackingCodeItemForGetMeetingObject' description: Tracking codes information. enabledAudioWatermark: type: boolean description: Whether or not the audio watermark is enabled. enabledVisualWatermark: type: boolean description: Whether or not the visual watermark is enabled. visualWatermarkOpacity: type: number example: 10 description: Opacity level for visual watermark. audioConnectionOptions: type: object properties: audioConnectionType: type: string enum: - webexAudio - VoIP - other - none description: "Choose how meeting attendees join the audio portion of the meeting.\n * `webexAudio` - Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.\n * `VoIP` - Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.\n * `other` - Other teleconference services.\n * `none` - The way of attendees join the audio portion of the meeting is the default value.\n" enabledTollFreeCallIn: type: boolean example: true description: Whether or not to show toll-free call-in numbers. enabledGlobalCallIn: type: boolean example: true description: Whether or not to show global call-in numbers to attendees. enabledAudienceCallBack: type: boolean description: 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: type: string enum: - beep - announceName - noTone description: "Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.\n * `beep` - All call-in users joining the meeting will hear the beep.\n * `announceName` - All call-in users joining the meeting will hear their names.\n * `noTone` - Turn off beeps and name announcements.\n" allowHostToUnmuteParticipants: type: boolean description: Whether or not to allow the host to unmute participants. allowAttendeeToUnmuteSelf: type: boolean example: true description: Whether or not to allow attendees to unmute themselves. muteAttendeeUponEntry: type: boolean description: Whether or not to auto-mute attendees when attendees enter meetings. description: Audio connection options. requireAttendeeLogin: type: boolean description: Require attendees to sign in before joining the webinar. restrictToInvitees: type: boolean description: Restrict webinar to invited attendees only. enabledLiveStream: type: boolean description: 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: $ref: '#/components/schemas/LiveStreamObject' description: Live streaming settings. Applies when `enabledLiveStream` is `true`. UpdateInterpreterObject: type: object required: - languageCode1 - languageCode2 properties: languageCode1: type: string example: en description: The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). languageCode2: type: string example: de description: The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). email: type: string example: marcus.tuchel@example.com description: Email address of meeting interpreter. If not specified, it'll be an empty interpreter for the bi-directional language channel. Please note that multiple interpreters with different emails can be assigned to the same bi-directional language channel, but the same email cannot be assigned to more than one interpreter. displayName: type: string example: Tuchel description: Display name of meeting interpreter. If the interpreter is already an invitee of the meeting and it has a different display name, that invitee's display name will be overwritten by this attribute. hostEmail: type: string example: brenda.song@example.com description: Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. sendEmail: type: boolean example: true description: If `true`, send email to the interpreter. CreateInterpreterObject: type: object required: - languageCode1 - languageCode2 properties: languageCode1: type: string example: en description: The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). languageCode2: type: string example: de description: The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). email: type: string example: marcus.hoffmann@example.com description: Email address of meeting interpreter. If not specified, an empty interpreter will be created for this bi-directional language channel, and a specific email can be assigned to this empty interpreter by `Update a Meeting Interpreter` API later. Please note that multiple interpreters with different emails can be assigned to the same bi-directional language channel, but the same email cannot be assigned to more than one interpreter. displayName: type: string example: Hoffmann description: Display name of meeting interpreter. If the interpreter is already an invitee of the meeting and it has a different display name, that invitee's display name will be overwritten by this attribute. hostEmail: type: string example: brenda.song@example.com description: Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. sendEmail: type: boolean example: true description: If `true`, send email to the interpreter. CustomizedRegistrant: type: object required: - questionId - answers properties: questionId: type: number example: 330087 description: Unique identifier for the customized questions retrieved from the registration form. answers: type: array items: $ref: '#/components/schemas/AnswerForCustomizedQuestion' description: The answers for customized questions. If the question type is checkbox, more than one answer can be set. AnswerForCustomizedQuestion: type: object required: - answer properties: optionId: type: number example: 1 description: Unique identifier for the option. answer: type: string example: green description: The content of the answer or the option for this question. RegistrationForUpdate: type: object properties: hostEmail: type: string example: '''john.andersen@example.com''' 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 an update for a meeting that is hosted by that user.' autoAcceptRequest: type: boolean description: Whether or not meeting registration requests are accepted automatically. requireFirstName: type: boolean example: true description: Whether or not a registrant's first name is required for meeting registration. This option must always be `true`. requireLastName: type: boolean example: true description: Whether or not a registrant's last name is required for meeting registration. This option must always be `true`. requireEmail: type: boolean example: true description: Whether or not a registrant's email is required for meeting registration. This option must always be `true`. requireJobTitle: type: boolean description: Whether or not a registrant's job title is shown or required for meeting registration. requireCompanyName: type: boolean description: Whether or not a registrant's company name is shown or required for meeting registration. requireAddress1: type: boolean description: Whether or not a registrant's first address field is shown or required for meeting registration. requireAddress2: type: boolean description: Whether or not a registrant's second address field is shown or required for meeting registration. requireCity: type: boolean description: Whether or not a registrant's city is shown or required for meeting registration. requireState: type: boolean description: Whether or not a registrant's state is shown or required for meeting registration. requireZipCode: type: boolean description: Whether or not a registrant's postal code is shown or required for meeting registration. requireCountryRegion: type: boolean description: Whether or not a registrant's country or region is shown or required for meeting registration. requireWorkPhone: type: boolean description: Whether or not a registrant's work phone number is shown or required for meeting registration. requireFax: type: boolean description: Whether or not a registrant's fax number is shown or required for meeting registration. maxRegisterNum: type: number example: 1000 description: 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. customizedQuestions: type: array items: $ref: '#/components/schemas/CustomizedQuestionForCreateMeeting' description: Customized questions for meeting registration. rules: type: array items: $ref: '#/components/schemas/StandardRegistrationApproveRule' description: The approval rule for standard questions. PrePostMeetingBreakoutSessionObject: type: object required: - id - name properties: id: type: string example: 18d2e565770c4eee918784ee333510ec description: Unique identifier for breakout session. name: type: string example: Breakout Session Name description: Name for breakout session. invitees: type: array items: type: string description: Invitees for breakout session. Only applies to breakout sessions which are created when meeting is scheduled. startTime: type: string example: '2022-10-25T09:10:00Z' description: The time the breakout session was started. Only applies to breakout sessions of ended meeting instances. endTime: type: string example: '2022-10-25T09:20:00Z' description: The time the breakout session was ended. Only applies to breakout sessions of ended meeting instances. Registrant: type: object properties: id: type: string example: fbd83190-97b2-4bb0-b56b-8fde463d137b description: New registrant's ID. status: type: string enum: - approved - pending - rejected description: "New registrant's status.\n * `approved` - Registrant has been approved.\n * `pending` - Registrant is in a pending list waiting for host or cohost approval.\n * `rejected` - Registrant has been rejected by the host or cohost.\n" firstName: type: string example: bob description: Registrant's first name. lastName: type: string example: Lee description: Registrant's last name. email: type: string example: bob@example.com description: Registrant's email. jobTitle: type: string example: manager description: Registrant's job title. companyName: type: string example: cisco description: Registrant's company. address1: type: string example: address1 string description: Registrant's first address line. address2: type: string example: address2 string description: Registrant's second address line. city: type: string example: New York description: Registrant's city name. state: type: string example: New York description: Registrant's state. zipCode: type: number example: 123456 description: Registrant's postal code. countryRegion: type: string example: United States description: Registrant's country or region. workPhone: type: string example: +1 123456 description: Registrant's work phone number. fax: type: string example: '123456' description: Registrant's FAX number. registrationTime: type: string example: '2021-09-07T09:29:13+08:00' description: Registrant's registration time. customizedQuestions: type: array items: $ref: '#/components/schemas/CustomizedRegistrant' description: Registrant's answers for customized questions, Registration options define whether or not this is required. sourceId: type: string example: cisco description: Registrant's source id.The `sourceId` is from [Create Invitation Sources](/docs/api/v1/meetings/create-invitation-sources) API. registrationId: type: string example: '1111' description: Registrant's registration ID. Registrants have a special number to identify a registrations if it is webinar-enabled and enabled registration ID. UpdateMeetingBreakoutSessionsObject: type: object properties: hostEmail: type: string example: john.andersen@example.com 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. sendEmail: type: boolean example: true description: Whether or not to send emails to host and invitees. It is an optional field and default value is true. items: type: array items: $ref: '#/components/schemas/PreMeetingBreakoutSessionWithoutIdObject' description: 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. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps