Summary of the meeting in HTML format
" }, "actionItems": [ { "content": "Action item No.1 in plaintext" }, { "content": "Action item No.2 in plaintext" }, { "content": "Action item No.3 in plaintext" } ] } ] } } } } }, "400": { "description": "Bad Request", "headers": {}, "content": {} }, "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 Summary by Meeting ID", "operationId": "getSummaryByMeetingID", "description": "Get the summary of an ended [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) by the meeting ID.\n\nPlease note that only **meeting instances** in state `ended` are supported, and currently the meeting ID of a meeting series, a scheduled meeting, an in-progress meeting instance, or a scheduled personal room meeting is not supported for this API. This API can only fetch summaries that you have access to, and if a meeting summary is deleted, you won't be able to see it either. And, this is an API for normal user. If you are a compliance officer, please use the Get Summary For Compliance Officer API", "tags": [ "Summaries" ], "parameters": [ { "name": "meetingId", "in": "query", "description": "Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the summary belongs. Please note that currently the meeting ID of a meeting series, a scheduled meeting, an in-progress meeting instance, or a scheduled personal room meeting is not supported for this API. If `meetingId` is not specified, the query will be rejected.", "example": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "schema": { "type": "string" } } ] } }, "/admin/meetingSummaries": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryObject" }, "description": "Meeting summary object" } }, "example": { "items": [ { "id": "75ddf169-eef0-45b4-9faa-0112a16ec9d0", "meetingId": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "status": "available", "notes": { "content": "Summary of the meeting in HTML format
" }, "actionItems": [ { "content": "Action item No.1 in plaintext" }, { "content": "Action item No.2 in plaintext" }, { "content": "Action item No.3 in plaintext" } ] } ] } } } } }, "400": { "description": "Bad Request", "headers": {}, "content": {} }, "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 Summary For Compliance Officer", "operationId": "getSummaryForComplianceOfficer", "description": "Lists available or deleted summaries of an ended [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) by meeting ID. This API can only be accessed by compliance officers. With this API, a compliance officer can list summaries of any ended meeting instances in his organization including available and deleted summaries", "tags": [ "Summaries" ], "parameters": [ { "name": "meetingId", "in": "query", "description": "Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the summary belongs. Please note that currently the meeting ID of a meeting series, a scheduled meeting, an in-progress meeting instance, or a scheduled personal room meeting is not supported for this API. If `meetingId` is not specified, the query will be rejected.", "example": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "schema": { "type": "string" } } ] } }, "/meetingSummaries/{summaryId}": { "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 Summary", "operationId": "deleteSummary", "description": "Removes a summary with a specified summary ID. The deleted summary cannot be recovered. A deleted summary can not be accessed by regular users, i.e. host or attendees, but can be access by compliance officers", "tags": [ "Summaries" ], "parameters": [ { "name": "summaryId", "in": "path", "description": "Unique identifier for the meeting summary.", "required": true, "example": "75ddf169-eef0-45b4-9faa-0112a16ec9d0", "schema": { "type": "string" } } ] } }, "/meetingTranscripts": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptObject" }, "description": "Transcript array." } } }, "example": { "items": [ { "id": "8ce1f918-c138-4041-bb4a-5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9", "startTime": "2020-06-02T20:30:15.042Z", "meetingId": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "meetingTopic": "John's Meeting 01", "siteUrl": "example.webex.com", "scheduledMeetingId": "0ed74a1c0551494fb7a04e2881bf50ae_20210401T232500Z", "meetingSeriesId": "0ed74a1c0551494fb7a04e2881bf50ae", "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA", "vttDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9/download?format=vtt", "txtDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9/download?format=txt", "status": "available" }, { "id": "074d892d-c7f7-4864-95db-31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e", "startTime": "2020-06-01T20:30:15.042Z", "meetingId": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "meetingTopic": "John's Meeting 02", "siteUrl": "example.webex.com", "scheduledMeetingId": "0ed74a1c0551494fb7a04e2881bf50ae_20210401T232500Z", "meetingSeriesId": "0ed74a1c0551494fb7a04e2881bf50ae", "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA", "vttDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e/download?format=vtt", "txtDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e/download?format=txt", "status": "available" } ] } } } }, "400": { "description": "Bad Request", "headers": {}, "content": {} }, "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 Transcripts", "operationId": "List Meeting Transcripts", "description": "Lists available transcripts of an ended [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances).\n\nUse this operation to list transcripts of an ended [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) when they are ready. Please note that only **meeting instances** in state `ended` are supported for `meetingId`. **Meeting series**, **scheduled meetings** and `in-progress` **meeting instances** are not supported.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "tags": [ "Transcripts" ], "parameters": [ { "name": "max", "in": "query", "description": "Maximum number of transcripts to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "schema": { "type": "number", "default": 10 } }, { "name": "from", "in": "query", "description": "Starting date and time (inclusive) for transcripts to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "example": "2020-07-12T09:30:00+08:00", "schema": { "type": "string", "default": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." } }, { "name": "to", "in": "query", "description": "Ending date and time (exclusive) for List transcripts to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "example": "2020-07-31T09:30:00+08:00", "schema": { "type": "string", "default": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." } }, { "name": "meetingId", "in": "query", "description": "Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the transcript belongs. Please note that currently 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 for this API. If `meetingId` is not specified, the operation returns an array of transcripts for all meetings of the current user.", "example": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "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 details for a meeting that is hosted by that user. If `meetingId` is not specified, it can not support `hostEmail`.", "example": "john.andersen@example.com", "schema": { "type": "string" } }, { "name": "siteUrl", "in": "query", "description": "URL of the Webex site from which the API lists transcripts. If not specified, the API lists transcripts from user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "example": "example.webex.com", "schema": { "type": "string" } } ] } }, "/admin/meetingTranscripts": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptObject" }, "description": "Transcript array" } } }, "example": { "items": [ { "id": "8ce1f918-c138-4041-bb4a-5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9", "startTime": "2020-06-02T20:30:15.042Z", "meetingId": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "meetingTopic": "John's Meeting 01", "siteUrl": "example.webex.com", "scheduledMeetingId": "0ed74a1c0551494fb7a04e2881bf50ae_20210401T232500Z", "meetingSeriesId": "0ed74a1c0551494fb7a04e2881bf50ae", "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA", "vttDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9/download?format=vtt", "txtDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9/download?format=txt", "status": "available" }, { "id": "074d892d-c7f7-4864-95db-31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e", "startTime": "2020-06-01T20:30:15.042Z", "meetingId": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "meetingTopic": "John's Meeting 02", "siteUrl": "example.webex.com", "scheduledMeetingId": "0ed74a1c0551494fb7a04e2881bf50ae_20210401T232500Z", "meetingSeriesId": "0ed74a1c0551494fb7a04e2881bf50ae", "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY", "vttDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e/download?format=vtt", "txtDownloadLink": "http://site-example.webex.com/v1/meetingTranscripts/31f7ae94206f_M_39f4371ca39c4a98b7f6ecc74247151e/download?format=txt", "status": "deleted" } ] } } } }, "400": { "description": "Bad Request", "headers": {}, "content": {} }, "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 Transcripts For Compliance Officer", "operationId": "List Meeting Transcripts For Compliance Officer", "description": "Lists available or deleted transcripts of an ended [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for a specific site.\n\nThe returned list is sorted in descending order by the date and time that the transcript was created.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.", "tags": [ "Transcripts" ], "parameters": [ { "name": "from", "in": "query", "description": "Starting date and time (inclusive) for transcripts to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.", "example": "2020-07-12T09:30:00+08:00", "schema": { "type": "string", "default": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time." } }, { "name": "to", "in": "query", "description": "Ending date and time (exclusive) for List transcripts to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.", "example": "2020-07-31T09:30:00+08:00", "schema": { "type": "string", "default": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." } }, { "name": "max", "in": "query", "description": "Maximum number of transcripts to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.", "schema": { "type": "number", "default": 10 } }, { "name": "siteUrl", "in": "query", "description": "URL of the Webex site from which the API lists transcripts.", "required": true, "example": "example.webex.com", "schema": { "type": "string" } } ] } }, "/meetingTranscripts/{transcriptId}/download": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "text/vtt": { "example": "WEBVTT\n\n1\n00:00:20.904 --> 00:00:24.564\nThis is an s sample recording.\n\n2\n00:00:31.014 --> 00:00:33.744\nTesting out transcripts.\n" } } }, "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": "Download a Meeting Transcript", "operationId": "Download a Meeting Transcript", "description": "Download a meeting transcript from the meeting transcript specified by `transcriptId`.", "tags": [ "Transcripts" ], "parameters": [ { "name": "transcriptId", "in": "path", "description": "Unique identifier for the meeting transcript.", "required": true, "example": "5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9", "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Format for the downloaded meeting transcript.", "example": "vtt", "schema": { "type": "string", "default": "vtt", "enum": [ "vtt", "txt" ] } }, { "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" } } ] } }, "/meetingTranscripts/{transcriptId}/snippets": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SnippetObject" }, "description": "Transcript snippet array" } } }, "example": { "items": [ { "id": "195d64646ad14be2924ea50f541fd91d_00001", "text": "Hello everyone", "personName": "John Andersen", "personEmail": "john.andersen@example.com", "offset": 1000, "duration": 1500 } ] } } } }, "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 Snippets of a Meeting Transcript", "operationId": "List Snippets of a Meeting Transcript", "description": "Lists snippets of a meeting transcript specified by `transcriptId`.\n\nUse this operation to list snippets of a meeting transcript when they are ready.", "tags": [ "Transcripts" ], "parameters": [ { "name": "transcriptId", "in": "path", "description": "Unique identifier for the meeting transcript to which the snippets belong.", "required": true, "example": "195d64646ad14be2924ea50f541fd91d", "schema": { "type": "string" } }, { "name": "max", "in": "query", "description": "Maximum snippet items to be returned for this query, to support pagination.", "example": "10", "schema": { "type": "string" } } ] } }, "/meetingTranscripts/{transcriptId}/snippets/{snippetId}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/SnippetObject" }, "example": { "id": "195d64646ad14be2924ea50f541fd91d_00001", "text": "Hello everyone", "personName": "John Andersen", "personEmail": "john.andersen@example.com", "offsetMillisecond": 1000, "durationMillisecond": 1500 } } } }, "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 Transcript Snippet", "operationId": "Get a Transcript Snippet", "description": "Retrieves details for a transcript snippet specified by `snippetId` from the meeting transcript specified by `transcriptId`.", "tags": [ "Transcripts" ], "parameters": [ { "name": "transcriptId", "in": "path", "description": "Unique identifier for the meeting transcript to which the requested snippet belongs.", "required": true, "example": "195d64646ad14be2924ea50f541fd91d", "schema": { "type": "string" } }, { "name": "snippetId", "in": "path", "description": "Unique identifier for the snippet being requested.", "required": true, "example": "195d64646ad14be2924ea50f541fd91d_00001", "schema": { "type": "string" } } ] }, "put": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/SnippetObject" }, "example": { "id": "195d64646ad14be2924ea50f541fd91d_00001", "text": "Hello everybody!", "personName": "John Andersen", "personEmail": "john.andersen@example.com", "offsetMillisecond": 1000, "durationMillisecond": 1500 } } } }, "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 Transcript Snippet", "operationId": "Update a Transcript Snippet", "description": "Updates details for a transcript snippet specified by `snippetId` from the meeting transcript specified by `transcriptId`.", "tags": [ "Transcripts" ], "parameters": [ { "name": "transcriptId", "in": "path", "description": "Unique identifier for the meeting transcript to which the snippet to be updated belongs.", "required": true, "example": "195d64646ad14be2924ea50f541fd91d", "schema": { "type": "string" } }, { "name": "snippetId", "in": "path", "description": "Unique identifier for the snippet being updated.", "required": true, "example": "195d64646ad14be2924ea50f541fd91d_00001", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "reason": "audit", "text": "Hello everybody!" }, "schema": { "$ref": "#/components/schemas/UpdateSnippetObject" } } } } } }, "/meetingTranscripts/{transcriptId}": { "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 Transcript", "operationId": "Delete a Transcript", "description": "Removes a transcript with a specified transcript ID. The deleted transcript cannot be recovered. If a Compliance Officer deletes another user's transcript, the transcript will be inaccessible to regular users (host, attendees), but will be still available to the Compliance Officer.", "tags": [ "Transcripts" ], "parameters": [ { "name": "transcriptId", "in": "path", "description": "Unique identifier for the meeting transcript.", "required": true, "example": "195d64646ad14be2924ea50f541fd91d", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "reason": "audit", "comment": "Violates the company policy" }, "schema": { "$ref": "#/components/schemas/DeleteTranscriptObject" } } } } } }, "/meetingReports/usage": { "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/MeetingUsageReportObject" }, "description": "An array of meeting usage report objects." } } }, "example": { "items": [ { "meetingId": "089b137c3cf34b578896941e2d49dfe8_I_146987372776523573", "meetingNumber": "123456789", "meetingTitle": "John's Meeting", "start": "2023-01-18T10:26:30+08:00", "end": "2023-01-18T10:46:30+08:00", "duration": 20, "scheduledType": "meeting", "hostDisplayName": "John Andersen", "hostEmail": "john.andersen@example.com", "totalPeopleMinutes": 60, "totalCallInMinutes": 60, "totalCallOutDomestic": 60, "totalCallInTollFreeMinutes": 60, "totalCallOutInternational": 60, "totalVoipMinutes": 60, "totalParticipants": 30, "totalParticipantsVoip": 10, "totalParticipantsCallIn": 10, "totalParticipantsCallOut": 10, "peakAttendee": 30, "totalRegistered": 30, "totalInvitee": 30, "serviceType": "MeetingCenter", "trackingCodes": [ { "name": "Department", "value": "Engineering" }, { "name": "Division", "value": "Web" } ] } ] } } } }, "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 Usage Reports", "operationId": "List Meeting Usage Reports", "description": "List meeting usage reports of all the users on the specified site by an admin. You can specify a date range and the maximum number of meeting usage reports to return.\n\nThe list returned is sorted in descending order by the date and time the meetings were started.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* `siteUrl` is required, and the meeting usage reports of the specified site are listed. All available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default timezone is `UTC` if not defined.", "tags": [ "Meetings Summary Report" ], "parameters": [ { "name": "siteUrl", "in": "query", "description": "URL of the Webex site which the API lists meeting usage reports from. All available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "required": true, "example": "example.webex.com", "schema": { "type": "string" } }, { "name": "serviceType", "in": "query", "description": "Meeting usage report's service-type. If `serviceType` is specified, the API filters meeting usage reports by service-type. If `serviceType` is not specified, the API returns meeting usage reports by `MeetingCenter` by default. Valid values:\n\n+ `MeetingCenter`\n\n+ `EventCenter`\n\n+ `SupportCenter`\n\n+ `TrainingCenter`", "example": "MeetingCenter", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting date and time for meeting usage reports to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `to` and `from` cannot exceed 30 days and `from` cannot be earlier than 90 days ago.", "example": "2023-01-18T00:00:00+08:00", "schema": { "type": "string", "default": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." } }, { "name": "to", "in": "query", "description": "Ending date and time for meeting usage reports to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `to` and `from` cannot exceed 30 days.", "example": "2023-01-19T00:00:00+08:00", "schema": { "type": "string", "default": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." } }, { "name": "max", "in": "query", "description": "Maximum number of meetings to include in the meetings usage report in a single page. `max` must be greater than 0 and equal to or less than `1000`.", "schema": { "type": "number", "default": 10 } }, { "name": "timezone", "in": "header", "description": "e.g. Asia/Shanghai", "required": false, "schema": { "type": "string" }, "example": "Asia/Shanghai" } ] } }, "/meetingReports/attendees": { "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/MeetingAttendeeReportObject" }, "description": "An array of meeting attendee report objects." } } }, "example": { "items": [ { "meetingId": "089b137c3cf34b578896941e2d49dfe8_I_146987372776523573", "meetingNumber": "123456789", "meetingTitle": "John's Meeting", "displayName": "John Andersen", "email": "john.andersen@example.com", "joinedTime": "2023-01-18T10:26:30+08:00", "leftTime": "2023-01-18T10:46:30+08:00", "duration": 20, "participantType": "ATTENDEE", "ipAddress": "172.16.244.151", "clientAgent": "WINDOWS,IE", "company": "ExampleCompany", "phoneNumber": "85763644", "address1": "Building 1", "address2": "Street 1", "city": "San Jose", "state": "CA", "country": "US", "zipCode": "38755", "registered": false, "invited": 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 Attendee Reports", "operationId": "List Meeting Attendee Reports", "description": "Lists of meeting attendee reports by a date range, the maximum number of meeting attendee reports, a meeting ID, a meeting number or a meeting title.\n\nIf the requesting user is an admin, the API returns meeting attendee reports of the meetings hosted by all the users on the specified site filtered by meeting ID, meeting number or meeting title.\n\nIf it's a normal meeting host, the API returns meeting attendee reports of the meetings hosted by the user himself on the specified site filtered by meeting ID, meeting number or meeting title.\n\nThe list returned is grouped by meeting instances. Both the groups and items of each group are sorted in descending order of `joinedTime`. For example, if `meetingId` is specified and it's a meeting series ID, the returned list is grouped by meeting instances of that series. The groups are sorted in descending order of `joinedTime`, and within each group the items are also sorted in descending order of `joinedTime`. Please refer to [Meetings Overview](/docs/meetings) for details of meeting series, scheduled meeting and meeting instance.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* `siteUrl` is required, and the meeting attendee reports of the specified site are listed. All available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* `meetingId`, `meetingNumber` and `meetingTitle` are optional parameters to query the meeting attendee reports, but at least one of them should be specified. If more than one parameter in the sequence of `meetingId`, `meetingNumber`, and `meetingTitle` are specified, the first one in the sequence is used. Currently, only ended meeting instance IDs and meeting series IDs are supported for `meetingId`. IDs of scheduled meetings or personal room meetings are not supported.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default timezone is `UTC` if not defined.", "tags": [ "Meetings Summary Report" ], "parameters": [ { "name": "siteUrl", "in": "query", "description": "URL of the Webex site which the API lists meeting attendee reports from. All available Webex sites can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.", "required": true, "example": "example.webex.com", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting date and time for the meeting attendee reports to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `to` and `from` cannot exceed 30 days and `from` cannot be earlier than 90 days ago.", "example": "2023-01-18T00:00:00+08:00", "schema": { "type": "string", "default": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time." } }, { "name": "to", "in": "query", "description": "Ending date and time for the meeting attendee reports to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `to` and `from` cannot exceed 30 days.", "example": "2023-01-19T00:00:00+08:00", "schema": { "type": "string", "default": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time." } }, { "name": "max", "in": "query", "description": "Maximum number of meeting attendees to include in the meeting attendee report in a single page. `max` must be greater than 0 and equal to or less than `1000`.", "schema": { "type": "number", "default": 10 } }, { "name": "meetingId", "in": "query", "description": "Meeting ID for the meeting attendee reports to return. If specified, return meeting attendee reports of the specified meeting; otherwise, return meeting attendee reports of all meetings. Currently, only ended meeting instance IDs are supported. IDs of meeting series, scheduled meetings or personal room meetings are not supported.", "example": "089b137c3cf34b578896941e2d49dfe8_I_146987372776523573", "schema": { "type": "string" } }, { "name": "meetingNumber", "in": "query", "description": "Meeting number for the meeting attendee reports to return. If specified, return meeting attendee reports of the specified meeting; otherwise, return meeting attendee reports of all meetings.", "example": "123456789", "schema": { "type": "string" } }, { "name": "meetingTitle", "in": "query", "description": "Meeting title for the meeting attendee reports to return. If specified, return meeting attendee reports of the specified meeting; otherwise, return meeting attendee reports of all meetings.", "example": "John's Meeting", "schema": { "type": "string" } }, { "name": "timezone", "in": "header", "description": "e.g. Asia/Shanghai", "required": false, "schema": { "type": "string" }, "example": "Asia/Shanghai" } ] } }, "/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`.\n\n* If the `meetingId` value specified is for a meeting series and `current` is `true`, the operation returns details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series.\n\n* If the `meetingId` value specified is for a meeting series and `current` is `false` or `current` is not specified, the operation returns details for the entire meeting series.\n\n* If the `meetingId` value specified is for a scheduled meeting from a meeting series, the operation returns details for that scheduled meeting.\n\n* If the `meetingId` value specified is for a meeting instance which is happening or has happened, the operation returns details for that meeting instance.\n\n* `trackingCodes` is not supported for ended meeting instances.\n\n* 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).\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", "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`.\n\n* 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.\n\n* 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.\n\n* 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.\n\n* 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).\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.", "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.\n\n* The `spark:all` scope is required when `roomId` is specified.\n\n* If the parameter `adhoc` is `true` and `roomId` is specified, an ad-hoc meeting is created for the target room. An ad-hoc meeting is a non-recurring instant meeting for the target room which is supposed to be started 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).\n\n* If the parameter `adhoc` is `true`, `roomId` is required and the others are optional or ignored.\n\n* 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.\n\n* The following parameters are not supported and will be ignored for an ad-hoc meeting: `templateId`, `recurrence`, `excludePassword`, `reminderTime`, `registration`, `integrationTags`, `enabledWebcastView`, and `panelistPassword`.\n\n* If the value of the parameter `recurrence` is null, a non-recurring meeting is created.\n\n* 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.\n\n* 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).\n\n* 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.\n\n* 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).\n\n* 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.\n\n* 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.\n\n* 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.\n\n* 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`.\n\n* 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.\n\n* 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).\n\n* You can't create a meeting that starts 10 years or more in the future.\n\n* 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": "Summary of the meeting in HTML format
", "description": "Summary of the meeting in HTML format" } }, "description": "Meeting summaries in HTML format" }, "actionItems": { "type": "array", "items": { "type": "object", "required": [ "content" ], "properties": { "content": { "type": "string", "example": "Action item in plaintext", "description": "Action item in plaintext" } }, "description": "One ation item in plaintext" }, "description": "A list of action items" } }, "example": { "id": "75ddf169-eef0-45b4-9faa-0112a16ec9d0", "meetingId": "d32a7aee5d864adcb8aab61b03e2a64d_I_688397330631637738", "status": "available", "notes": { "content": "Summary of the meeting in HTML format
" }, "actionItems": [ { "content": "Action item No.1 in plaintext" }, { "content": "Action item No.2 in plaintext" }, { "content": "Action item No.3 in plaintext" } ] } }, "TranscriptObject": { "type": "object", "required": [ "id", "siteUrl", "startTime", "meetingTopic", "meetingId", "scheduledMeetingId", "hostUserId", "vttDownloadLink", "txtDownloadLink", "status" ], "properties": { "id": { "type": "string", "example": "195d64646ad14be2924ea50f541fd91d", "description": "A unique identifier for the transcript." }, "siteUrl": { "type": "string", "example": "example.webex.com", "description": "URL of the Webex site from which the API lists meeting transcripts." }, "startTime": { "type": "string", "example": "2020-06-01T20:30:15.042Z", "description": "Start time for the meeting transcript in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format." }, "meetingTopic": { "type": "string", "example": "John's Meeting", "description": "The meeting's topic." }, "meetingId": { "type": "string", "example": "0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044", "description": "Unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the transcripts belong." }, "scheduledMeetingId": { "type": "string", "example": "0ed74a1c0551494fb7a04e2881bf50ae_20210401T232500Z", "description": "Unique identifier for scheduled meeting with which the current meeting is associated. Only apples to a meeting instance which is happening or has happened. This is the `id` of the scheduled meeting with which the instance is associated." }, "meetingSeriesId": { "type": "string", "example": "0ed74a1c0551494fb7a04e2881bf50ae", "description": "Unique identifier for the parent meeting series to which the recording belongs." }, "hostUserId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA", "description": "Unique identifier for the meeting host." }, "vttDownloadLink": { "type": "string", "example": "http://site-example.webex.com/v1/meetingTranscripts/195d64646ad14be2924ea50f541fd91d/download?format=vtt", "description": "The download link for the transcript vtt file." }, "txtDownloadLink": { "type": "string", "example": "http://site-example.webex.com/v1/meetingTranscripts/195d64646ad14be2924ea50f541fd91d/download?format=txt", "description": "The download link for the transcript txt file." }, "status": { "type": "string", "enum": [ "available", "deleted" ], "description": " * `available` - Transcript is available.\n * `deleted` - Transcript has been deleted.\n" } } }, "UpdateSnippetObject": { "type": "object", "required": [ "text" ], "properties": { "reason": { "type": "string", "example": "audit", "description": "Reason for snippet update; only required for Compliance Officers." }, "text": { "type": "string", "example": "Hello everybody", "description": "Text for the snippet." } } }, "DeleteTranscriptObject": { "type": "object", "properties": { "reason": { "type": "string", "example": "audit", "description": "Reason for deleting a transcript. Only required when a Compliance Officer is operating on another user's transcript." }, "comment": { "type": "string", "example": "Maintain data privacy", "description": "Explanation for deleting a transcript. The comment can be a maximum of 255 characters long." } } }, "MeetingUsageReportObject": { "type": "object", "properties": { "meetingId": { "type": "string", "example": "089b137c3cf34b578896941e2d49dfe8_I_146987372776523573", "description": "Unique identifier for the meeting." }, "meetingNumber": { "type": "string", "example": "123456789", "description": "Meeting number." }, "meetingTitle": { "type": "string", "example": "John's Meeting", "description": "Meeting title." }, "start": { "type": "string", "example": "2023-01-18T10:26:30+08:00", "description": "The date and time when the meeting was started. It's in the timezone specified in the request header or in the `UTC` timezone if timezone is not specified." }, "end": { "type": "string", "example": "2023-01-18T10:46:30+08:00", "description": "The date and time when the meeting was ended. It's in the timezone specified in the request header or in the `UTC` timezone if timezone is not specified." }, "duration": { "type": "number", "example": 20, "description": "Duration of the meeting in minutes." }, "scheduledType": { "type": "string", "enum": [ "meeting", "webinar" ], "description": "Scheduled type for the meeting.\n * `meeting` - Regular meeting.\n * `webinar` - Webinar meeting.\n" }, "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." }, "totalPeopleMinutes": { "type": "number", "example": 60, "description": "Aggregated attendee minutes." }, "totalCallInMinutes": { "type": "number", "example": 60, "description": "Aggregated attendee PSTN call-in minutes." }, "totalCallOutDomestic": { "type": "number", "example": 60, "description": "Aggregated attendee domestic PSTN call-out minutes." }, "totalCallInTollFreeMinutes": { "type": "number", "example": 60, "description": "Aggregated attendee toll-free PSTN call-in minutes." }, "totalCallOutInternational": { "type": "number", "example": 60, "description": "Aggregated attendee international PSTN call-out minutes." }, "totalVoipMinutes": { "type": "number", "example": 60, "description": "Aggregated attendee VoIP minutes." }, "totalParticipants": { "type": "number", "example": 30, "description": "Total number of participants of the meeting." }, "totalParticipantsVoip": { "type": "number", "example": 10, "description": "Total number of VoIP participants of the meeting." }, "totalParticipantsCallIn": { "type": "number", "example": 10, "description": "Total number of PSTN call-in participants of the meeting." }, "totalParticipantsCallOut": { "type": "number", "example": 10, "description": "Total number of PSTN call-out participants of the meeting." }, "peakAttendee": { "type": "number", "example": 30, "description": "Peak number of attendees throughout the meeting." }, "totalRegistered": { "type": "number", "example": 30, "description": "Total number of registrants of the meeting." }, "totalInvitee": { "type": "number", "example": 30, "description": "Total number of invitees of the meeting." }, "serviceType": { "type": "string", "enum": [ "MeetingCenter", "EventCenter", "TrainingCenter", "SupportCenter" ], "description": "The service type for the meeting usage report.\n * `MeetingCenter` - The service type for the usage report is meeting.\n * `EventCenter` - The service type for the usage report is the event.\n * `TrainingCenter` - The service type for the usage report is the training session.\n * `SupportCenter` - The service type for the usage report is the support meeting.\n" }, "trackingCodes": { "type": "array", "items": { "$ref": "#/components/schemas/MeetingUsageReportTrackingCodeObject" }, "description": "Tracking codes of the meeting." } } }, "MeetingUsageReportTrackingCodeObject": { "type": "object", "properties": { "name": { "type": "string", "example": "Department", "description": "Name of the tracking code." }, "value": { "type": "string", "example": "Engineering", "description": "Value of the tracking code." } } }, "MeetingAttendeeReportObject": { "type": "object", "properties": { "meetingId": { "type": "string", "example": "089b137c3cf34b578896941e2d49dfe8_I_146987372776523573", "description": "Unique identifier for the meeting." }, "meetingNumber": { "type": "number", "example": 123456789, "description": "Meeting number." }, "meetingTitle": { "type": "string", "example": "John's Meeting", "description": "Meeting title." }, "displayName": { "type": "string", "example": "John Andersen", "description": "Attendee's display name." }, "email": { "type": "string", "example": "John Andersen", "description": "Attendee's email." }, "joinedTime": { "type": "string", "example": "2023-01-18T10:26:30+08:00", "description": "The date and time when the attendee joined the meeting. It's in the timezone specified in the request header or in the `UTC` timezone if timezone is not specified." }, "leftTime": { "type": "string", "example": "2023-01-18T10:46:30+08:00", "description": "The date and time when the attendee left the meeting. It's in the timezone specified in the request header or in the `UTC` timezone if timezone is not specified." }, "duration": { "type": "number", "example": 20, "description": "Duration of the attendee in the meeting in minutes." }, "participantType": { "type": "string", "enum": [ "host", "attendee" ], "description": "The attendee's role in the meeting.\n * `host` - Meeting host.\n * `attendee` - Meeting attendee.\n" }, "ipAddress": { "type": "string", "example": "172.16.244.151", "description": "IP address of the attendee when he attended the meeting." }, "clientAgent": { "type": "string", "example": "WINDOWS,IE", "description": "Information of the attendee's operating system and application when he attended the meeting." }, "company": { "type": "string", "example": "ExampleCompany", "description": "Attendee's company." }, "phoneNumber": { "type": "string", "example": "85763644", "description": "Attendee's phone number." }, "address1": { "type": "string", "example": "85763644", "description": "Attendee's address, part one." }, "address2": { "type": "string", "example": "85763644", "description": "Attendee's address, part two." }, "city": { "type": "string", "example": "85763644", "description": "Attendee's city." }, "state": { "type": "string", "example": "85763644", "description": "Attendee's state." }, "country": { "type": "string", "example": "85763644", "description": "Attendee's country." }, "zipCode": { "type": "string", "example": "85763644", "description": "Attendee's zip code." }, "registered": { "type": "boolean", "description": "Whether or not the attendee has registered the meeting." }, "invited": { "type": "boolean", "description": "Whether or not the attendee has been invited to the meeting." } } }, "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." } } }, "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." } } }, "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." } } }, "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`." } } }, "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))." } } }, "MeetingSeriesObjectWithAdhoc": { "type": "object", "required": [ "id", "title", "password", "meetingType", "state", "timezone", "start", "end", "hostUserId", "hostDisplayName", "hostEmail", "hostKey", "siteUrl", "webLink", "telephony" ], "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." }, "adhoc": { "type": "boolean", "description": "If `true`, the meeting is ad-hoc." }, "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 this meeting is `meetingSeries`, and `current` is not specified or is `false`, `start` is the scheduled start time of the first occurrence of this series. If the meetingType of this meeting is `meetingSeries`, and `current` is not specified or is `false`, `start` is the scheduled start time of the first occurrence of this series. If the meetingType of this meeting is `meetingSeries`, and `current` is `true`, `start` is the scheduled start time of the ongoing or upcoming occurrence in this series. If the meetingType of this meeting is `scheduledMeeting`, `start` is the scheduled start time of this occurrence. If the meetingType of this meeting is `meeting`, `start` is the actual start time of this 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 meeting is a meeting series, `end` is the date and time the first meeting of the series ends. If the meetingType of this meeting is `meetingSeries`, and `current` is not specified or is `false`, `end` is the scheduled end time of the first occurrence of this series. If the meetingType of this meeting is `meetingSeries`, and `current` is `true`, `end` is the scheduled end time of the ongoing or upcoming occurrence in this series. If the meetingType of this meeting is `scheduledMeeting`, `end` is the scheduled end time of this occurrence. If the meetingType of this meeting is `meeting`, `end` is the actual end time of this 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." }, "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": "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))." } }, "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 required for meeting registration." }, "requireCompanyName": { "type": "boolean", "description": "Whether or not a registrant's company name is required for meeting registration." }, "requireAddress1": { "type": "boolean", "description": "Whether or not a registrant's first address field is required for meeting registration." }, "requireAddress2": { "type": "boolean", "description": "Whether or not a registrant's second address field is required for meeting registration." }, "requireCity": { "type": "boolean", "description": "Whether or not a registrant's city is required for meeting registration." }, "requireState": { "type": "boolean", "description": "Whether or not a registrant's state is required for meeting registration." }, "requireZipCode": { "type": "boolean", "description": "Whether or not a registrant's postal code is required for meeting registration." }, "requireCountryRegion": { "type": "boolean", "description": "Whether or not a registrant's country or region is required for meeting registration." }, "requireWorkPhone": { "type": "boolean", "description": "Whether or not a registrant's work phone number is required for meeting registration." }, "requireFax": { "type": "boolean", "description": "Whether or not a registrant's fax number is 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 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 the 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`." } } }, "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`." } } }, "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`." } } }, "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`." } } }, "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`." } } }, "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`." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "Registrants": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "example": "123456", "description": "Registrant ID." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "PreMeetingBreakoutSessionsObject": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PreMeetingBreakoutSessionObject" }, "description": "Breakout sessions information for meeting." } } }, "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." } } }, "PrePostMeetingBreakoutSessionsObject": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PrePostMeetingBreakoutSessionObject" }, "description": "Breakout sessions information for meeting." } } }, "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." } } }, "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))." } } }, "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." } } }, "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." } } }, "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." } } }, "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`." } } }, "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." } } }, "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." } } }, "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." } } }, "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" } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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" } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "GetTrackingCodesObject": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GetTrackingCodeObject" }, "description": "Tracking codes information." } } }, "GetTrackingCodeObject": { "type": "object", "required": [ "id", "name", "siteUrl", "options", "inputMode", "hostProfileCode", "scheduleStartCodes" ], "properties": { "id": { "type": "string", "example": "1", "description": "Unique identifier for tracking code." }, "name": { "type": "string", "example": "Department", "description": "Name for 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." }, "inputMode": { "type": "string", "enum": [ "text", "select", "editableSelect", "hostProfileSelect" ], "description": "An option for how an admin user can provide a code value.\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 is only available for the host profile and sign-up pages.\n" }, "hostProfileCode": { "type": "string", "enum": [ "optional", "required", "adminSet", "notUsed" ], "description": "Type for the host profile.\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" }, "scheduleStartCodes": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleStartCodeObject" }, "description": "Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages." } } }, "ScheduleStartCodeObject": { "type": "object", "required": [ "service", "type" ], "properties": { "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. This value only applies when `hostProfileCode` is `adminSet`.\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" } } }, "CreateOrUpdateTrackingCodeObject": { "type": "object", "required": [ "name", "siteUrl", "options", "inputMode", "hostProfileCode", "scheduleStartCodes" ], "properties": { "name": { "type": "string", "example": "Department", "description": "Name for tracking code. The name cannot be empty and the maximum size is 120 characters." }, "siteUrl": { "type": "string", "example": "example.webex.com", "description": "Site URL for the tracking code." }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/OptionsForCreateOrUpdateTrackingCodeObject" }, "description": "Tracking code option list. The maximum size of `options` is 500." }, "inputMode": { "type": "string", "enum": [ "text", "select", "editableSelect", "hostProfileSelect" ], "description": "Select an option for how users can provide a code value. Please note that if users set `inputMode` as `hostProfileSelect`, `scheduleStartCode` should be `null`, which means `hostProfileSelect` only applies to \"Host Profile\".\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 is only available for the host profile and sign-up pages.\n" }, "hostProfileCode": { "type": "string", "enum": [ "optional", "required", "adminSet", "notUsed" ], "description": "Type for the host profile.\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" }, "scheduleStartCodes": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleStartCodeObject" }, "description": "Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages. The maximum size of `scheduleStartCodes` is 5." } } }, "OptionsForCreateOrUpdateTrackingCodeObject": { "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." } } }, "GetTrackingCodeForUserObject": { "type": "object", "required": [ "siteUrl" ], "properties": { "siteUrl": { "type": "string", "example": "example.webex.com", "description": "Site URL for the tracking code." }, "personId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOGJiOWNjMC0zMWM2LTQ3MzYtYmE4OC0wMDk5ZmQzNDNmODE", "description": "Unique identifier for the user." }, "email": { "type": "string", "example": "john.andersen@example.com", "description": "Email address for the user." }, "trackingCodes": { "type": "array", "items": { "$ref": "#/components/schemas/GetTrackingCodeItemForUserObject" }, "description": "Tracking code information." } } }, "UpdateTrackingCodeForUserObject": { "type": "object", "required": [ "siteUrl" ], "properties": { "siteUrl": { "type": "string", "example": "example.webex.com", "description": "Site URL for the tracking code." }, "personId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOGJiOWNjMC0zMWM2LTQ3MzYtYmE4OC0wMDk5ZmQzNDNmODE", "description": "Unique identifier for the user. At least one parameter of `personId` or `email` is required. `personId` must precede `email` if both are specified." }, "email": { "type": "string", "example": "john.andersen@example.com", "description": "Email address for the user. At least one parameter of `personId` or `email` is required. `personId` must precede `email` if both are specified." }, "trackingCodes": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateTrackingCodeItemForUserObject" }, "description": "Tracking code information for updates." } } }, "GetTrackingCodeItemForUserObject": { "type": "object", "required": [ "id", "name", "value" ], "properties": { "id": { "type": "string", "example": "1", "description": "Unique identifier for tracking code." }, "name": { "type": "string", "example": "Department", "description": "Name for tracking code." }, "value": { "type": "string", "description": "Value for tracking code." } } }, "UpdateTrackingCodeItemForUserObject": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "example": "Department", "description": "Name for tracking code. The name cannot be empty and the maximum size is 120 characters." }, "value": { "type": "string", "description": "Value for tracking code. `value` cannot be empty and the maximum size is 120 characters." } } }, "PatchGroupMeetingObject": { "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. 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." }, "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." }, "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. 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": "When `true`, live streaming is enabled." }, "liveStream": { "$ref": "#/components/schemas/LiveStreamObject", "description": "Live streaming settings. Applies when `enabledLiveStream` is `true`." } } }, "GetMeetingConfigurationCommonSettingObject": { "type": "object", "properties": { "siteOptions": { "type": "object", "properties": { "allowCustomPersonalRoomURL": { "type": "boolean", "description": "Allow hosts to change their Personal Room URLs." } }, "description": "Site Options on Webex Administration." }, "telephonyConfig": { "type": "object", "properties": { "allowCallIn": { "type": "boolean", "description": "Whether call-in teleconferencing for sessions was enabled." }, "allowCallBack": { "type": "boolean", "description": "Whether call-back teleconferencing for sessions was enabled." }, "allowOtherTeleconf": { "type": "boolean", "description": "Whether other teleconferencing for sessions was enabled." }, "allowTollFreeCallin": { "type": "boolean", "description": "Whether toll-free call-in teleconferencing was enabled." }, "allowInternationalCallin": { "type": "boolean", "description": "Whether international call-in teleconferencing was enabled." }, "allowInternationalCallback": { "type": "boolean", "description": "Whether international call-back teleconferencing was enabled." }, "VoIP": { "type": "boolean", "description": "Whether Voice Over IP functionality using the attendee computer's speakers and microphones was enabled." } }, "description": "Telephony Configuration on WebEx Super Admin (These options are read-only, unable to update by Update Common Settings API)." }, "defaultSchedulerOptions": { "type": "object", "required": [ "entryAndExitTone", "telephonySupport" ], "properties": { "entryAndExitTone": { "type": "string", "enum": [ "NoTone", "Beep", "AnnounceName" ], "description": "Determines if a sound is made when someone enters or exits.\n * `NoTone` - No tone.\n * `Beep` - Beep.\n * `AnnounceName` - Announce name.\n" }, "joinTeleconfNotPress1": { "type": "boolean", "description": "Specifies whether or not joining teleconference without pressing 1 is checked by default." }, "telephonySupport": { "type": "string", "enum": [ "None", "WebexTeleconferencing", "Other" ], "description": "Specifies the type of teleconference support for meetings.\n * `None` - None.\n * `WebexTeleconferencing` - Webex teleconferencing.\n * `Other` - Other Teleconferencing.\n" }, "tollFree": { "type": "boolean", "description": "Specifies whether toll-free call-in is available." }, "VoIP": { "type": "boolean", "description": "Denotes if VoIP protocols are being used." } }, "description": "Default Scheduler Options on Webex Administration (These options are applied to the site as defaults, but individual users can change them)." }, "scheduleMeetingOptions": { "type": "object", "properties": { "emailReminders": { "type": "boolean", "description": "Determines if email reminders are to be sent out." } }, "description": "Schedule Meeting Options on Webex Administration." }, "securityOptions": { "type": "object", "properties": { "joinBeforeHost": { "type": "boolean", "description": "Allow attendees or panelists to join before the host." }, "audioBeforeHost": { "type": "boolean", "description": "Allows attendees or panelists to join the teleconference before the host." }, "firstAttendeeAsPresenter": { "type": "boolean", "description": "Allows first attendee or panelist as the presenter." }, "unlistAllMeetings": { "type": "boolean", "description": "Specifies that all meetings must be unlisted." }, "requireLoginBeforeAccess": { "type": "boolean", "description": "Determines if a user must login before getting site access." }, "allowMobileScreenCapture": { "type": "boolean", "description": "Allow screen capture (Android devices only)." }, "requireStrongPassword": { "type": "boolean", "description": "Determines if strict passwords are required for meetings." }, "passwordCriteria": { "type": "object", "properties": { "mixedCase": { "type": "boolean", "description": "Determines if a password requires mixed case." }, "minLength": { "type": "number", "example": 8, "description": "Sets the minimum password length." }, "minNumeric": { "type": "number", "example": 2, "description": "Sets the minimum number of numeric characters in the password." }, "minAlpha": { "type": "number", "example": 4, "description": "Sets the minimum number of alphabetical characters in the password." }, "minSpecial": { "type": "number", "example": 1, "description": "Sets the minimum number of special characters in the password." }, "disallowDynamicWebText": { "type": "boolean", "description": "Do not allow dynamic web page text for meeting passwords (like site name, host's name, username, meeting topic)." }, "disallowList": { "type": "boolean", "description": "Specifies if passwords from the `disallowValues` list are to be allowed." }, "disallowValues": { "type": "array", "items": { "type": "string" }, "description": "Sets password values that are not allowed." } }, "description": "Criteria of a strong password." } }, "description": "Security Options on Webex Administration." } } }, "UpdateMeetingConfigurationCommonSettingObject": { "type": "object", "properties": { "siteOptions": { "type": "object", "properties": { "allowCustomPersonalRoomURL": { "type": "boolean", "description": "Allow hosts to change their Personal Room URLs." } }, "description": "Site Options on Webex Administration." }, "defaultSchedulerOptions": { "type": "object", "required": [ "entryAndExitTone", "telephonySupport" ], "properties": { "entryAndExitTone": { "type": "string", "enum": [ "NoTone", "Beep", "AnnounceName" ], "description": "Determines if a sound is made when someone enters or exits.\n * `NoTone` - No tone.\n * `Beep` - Beep.\n * `AnnounceName` - Announce name.\n" }, "joinTeleconfNotPress1": { "type": "boolean", "description": "Specifies whether or not joining teleconference without pressing 1 is checked by default." }, "telephonySupport": { "type": "string", "enum": [ "None", "WebexTeleconferencing", "Other" ], "description": "Specifies the type of teleconference support for meetings.\n * `None` - None.\n * `WebexTeleconferencing` - Webex teleconferencing (Unabled when Webex Super Admin hasn't turned on call-in teleconferencing and call-back teleconferencing).\n * `Other` - Other Teleconferencing (Unabled when Webex Super Admin hasn't turned on other teleconferencing).\n" }, "tollFree": { "type": "boolean", "description": "Specifies whether toll-free call-in is available, it can't be specified when `telephonySupport` was not `WebexTeleconferencing`, and it can't be specified as `true` when Webex Super Admin hasn't turned on toll-free call-in teleconferencing." }, "VoIP": { "type": "boolean", "description": "Denotes if VoIP protocols are being used, it can't be specified as `true` when Webex Super Admin hasn't turned on Voice Over IP functionality." } }, "description": "Default Scheduler Options on Webex Administration (These options are applied to the site as defaults, but individual users can change them)." }, "scheduleMeetingOptions": { "type": "object", "properties": { "emailReminders": { "type": "boolean", "description": "Determines if email reminders are to be sent out." } }, "description": "Schedule Meeting Options on Webex Administration." }, "securityOptions": { "type": "object", "properties": { "joinBeforeHost": { "type": "boolean", "description": "Allow attendees or panelists to join before the host." }, "audioBeforeHost": { "type": "boolean", "description": "Allows attendees or panelists to join the teleconference before the host, it can't be turned on when `joinBeforeHost` was `false`." }, "firstAttendeeAsPresenter": { "type": "boolean", "description": "Allows first attendee or panelist as the presenter, it can't be turned on when `firstAttendeeAsPresenter` was `false`." }, "unlistAllMeetings": { "type": "boolean", "description": "Specifies that all meetings must be unlisted." }, "requireLoginBeforeAccess": { "type": "boolean", "description": "Determines if a user must login before getting site access." }, "allowMobileScreenCapture": { "type": "boolean", "description": "Allow screen capture (Android devices only)." }, "requireStrongPassword": { "type": "boolean", "description": "Determines if strict passwords are required for meetings." }, "passwordCriteria": { "type": "object", "properties": { "mixedCase": { "type": "boolean", "description": "Determines if a password requires mixed case." }, "minLength": { "type": "number", "example": 8, "description": "Sets the minimum password length, maximum value limit of 12." }, "minNumeric": { "type": "number", "example": 2, "description": "Sets the minimum number of numeric characters in the password, maximum value limit of 12." }, "minAlpha": { "type": "number", "example": 4, "description": "Sets the minimum number of alphabetical characters in the password, maximum value limit of 12." }, "minSpecial": { "type": "number", "example": 1, "description": "Sets the minimum number of special characters in the password, maximum value limit of 12." }, "disallowDynamicWebText": { "type": "boolean", "description": "Do not allow dynamic web page text for meeting passwords (like site name, host's name, username, meeting topic)." }, "disallowList": { "type": "boolean", "description": "Specifies if passwords from the `disallowValues` list are to be allowed." }, "disallowValues": { "type": "array", "items": { "type": "string" }, "description": "Sets password values that are not allowed, and cannot type repeated items in it." } }, "description": "Criteria of a strong password, which cannot be specified when `requireStrongPassword` was `false`." } }, "description": "Security Options on Webex Administration." } } }, "ClustersAvailability": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterAvailabilityCollection" } } } }, "ClusterAvailabilityCollection": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=", "description": "The unique ID for the organization." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterAvailability" }, "description": "Availability details of the Video Mesh cluster." }, "from": { "type": "string", "example": "2021-09-15T15:53:00Z", "description": "Start date and time (inclusive) of the availability data." }, "to": { "type": "string", "example": "2021-09-15T17:53:00Z", "description": "End date and time (inclusive) of the availability data." } } }, "NodesAvailability": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NodeAvailabilityCollection" } } } }, "SingleNodeAvailability": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SingleNodeAvailabilityCollection" } } } }, "NodeAvailabilityCollection": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=", "description": "Unique ID for a Video Mesh organization." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NodeAvailability" }, "description": "Availability details of the Video Mesh cluster." }, "from": { "type": "string", "example": "2021-09-15T15:53:00Z", "description": "Start date and time (inclusive) of the availability data." }, "to": { "type": "string", "example": "2021-09-15T17:53:00Z", "description": "End date and time (inclusive) of the availability data." } } }, "SingleNodeAvailabilityCollection": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=", "description": "Unique ID for a Video Mesh organization." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SingleNodeAvailabilityObject" }, "description": "Availability details of the Video Mesh cluster." }, "from": { "type": "string", "example": "2021-09-15T15:53:00Z", "description": "Start date and time (inclusive) of the availability data." }, "to": { "type": "string", "example": "2021-09-15T17:53:00Z", "description": "End date and time (inclusive) of the availability data." } } }, "ClusterAvailability": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "San Jose", "description": "Name of the Video Mesh cluster." }, "availabilitySegments": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterAvailableTimeline" }, { "$ref": "#/components/schemas/ClusterUnAvailableTimeline" } ] } } } }, "ClusterAvailableTimeline": { "type": "object", "properties": { "segmentStartTime": { "type": "string", "example": "2021-09-15T15:53:00Z", "description": "Start date and time of the segment of availability data." }, "segmentEndTime": { "type": "string", "example": "2021-09-15T16:53:00Z", "description": "End date and time of the segment of availability data." }, "availability": { "type": "string", "example": "Available", "description": "Availability information of the Video Mesh cluster." }, "noOfOnlineNodes": { "type": "number", "example": 1, "description": "Number of nodes that are online." }, "noOfOfflineNodes": { "type": "number", "example": 1, "description": "Number of nodes that are offline." }, "totalNodes": { "type": "number", "example": 2, "description": "Total number of nodes in the Video Mesh cluster." } } }, "ClusterUnAvailableTimeline": { "type": "object", "properties": { "segmentStartTime": { "type": "string", "example": "2021-09-15T16:53:00Z", "description": "Start date and time of the segment of availability data." }, "segmentEndTime": { "type": "string", "example": "2021-09-15T17:53:00Z", "description": "End date and time of the segment of availability data." }, "availability": { "type": "string", "example": "Unavailable", "description": "Availability information of the Video Mesh cluster." }, "noOfOnlineNodes": { "type": "number", "description": "Number of nodes that are online." }, "noOfOfflineNodes": { "type": "number", "example": 2, "description": "Number of nodes that are offline." }, "totalNodes": { "type": "number", "example": 2, "description": "Total number of nodes in the Video Mesh cluster." } } }, "NodeAvailability": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "San Jose", "description": "Name of the Video Mesh cluster." }, "hostNameOrIp": { "type": "string", "example": "xyz.abc.com", "description": "Host Name or the IP of the Video Mesh node." }, "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmOmMyNTk0YmY2NDFmZTRkNTFiZDg3YThiMjYxYzg3NWY1", "description": "ID of the Video Mesh node." }, "availabilitySegments": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/NodeAvailableTimeline" }, { "$ref": "#/components/schemas/NodeUnAvailableTimeline" } ] } } } }, "SingleNodeAvailabilityObject": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "San Jose", "description": "Name of the Video Mesh cluster." }, "hostNameOrIp": { "type": "string", "example": "xyz.abc.com", "description": "Host Name or the IP of the Video Mesh node." }, "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmOmMyNTk0YmY2NDFmZTRkNTFiZDg3YThiMjYxYzg3NWY1", "description": "ID of the Video Mesh node." }, "availabilitySegments": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SingleNodeAvailableTimeline" }, { "$ref": "#/components/schemas/SingleNodeUnAvailableTimeline" } ] } } } }, "NodeAvailableTimeline": { "type": "object", "properties": { "noOfOnlineNodes": { "type": "number", "example": 1, "description": "Number of nodes that are online." }, "noOfOfflineNodes": { "type": "number", "description": "Number of nodes that are offline." }, "segmentStartTime": { "type": "string", "example": "2021-09-15T15:53:00Z", "description": "Start date and time of the segment of availability data." }, "segmentEndTime": { "type": "string", "example": "2021-09-15T16:53:00Z", "description": "End date and time of the segment of availability data." }, "availability": { "type": "string", "example": "Available", "description": "Availability information of the Video Mesh node." }, "unAvailabilityReason": { "type": "string", "example": "NA", "description": "Reason for the Video Mesh node being unavailable (if any)." }, "totalNodes": { "type": "number", "example": 1, "description": "Total number of nodes in the Video Mesh cluster." } } }, "SingleNodeAvailableTimeline": { "type": "object", "properties": { "segmentStartTime": { "type": "string", "example": "2021-09-15T15:53:00Z", "description": "Start date and time of the segment of availability data." }, "segmentEndTime": { "type": "string", "example": "2021-09-15T16:53:00Z", "description": "End date and time of the segment of availability data." }, "availability": { "type": "string", "example": "Available", "description": "Availability information of the Video Mesh node." }, "unAvailabilityReason": { "type": "string", "example": "NA", "description": "Reason for the Video Mesh node being unavailable (if any)." } } }, "NodeUnAvailableTimeline": { "type": "object", "properties": { "noOfOnlineNodes": { "type": "number", "description": "Number of nodes that are online." }, "noOfOfflineNodes": { "type": "number", "example": 1, "description": "Number of nodes that are offline." }, "segmentStartTime": { "type": "string", "example": "2021-09-15T16:53:00Z", "description": "Start date and time of the segment of availability data." }, "segmentEndTime": { "type": "string", "example": "2021-09-15T17:53:00Z", "description": "End date and time of the segment of availability data." }, "availability": { "type": "string", "example": "Unavailable", "description": "Availability information of the Video Mesh node" }, "unAvailabilityReason": { "type": "string", "example": "Connectivity Issues to the Node", "description": "Reason for the Video Mesh node being unavailable (if any)." }, "totalNodes": { "type": "number", "example": 1, "description": "Total number of nodes in the Video Mesh cluster." } } }, "SingleNodeUnAvailableTimeline": { "type": "object", "properties": { "segmentStartTime": { "type": "string", "example": "2021-09-15T16:53:00Z", "description": "Start date and time of the segment of availability data." }, "segmentEndTime": { "type": "string", "example": "2021-09-15T17:53:00Z", "description": "End date and time of the segment of availability data." }, "availability": { "type": "string", "example": "Unavailable", "description": "Availability information of the Video Mesh node." }, "unAvailabilityReason": { "type": "string", "example": "Connectivity Issues to the Node", "description": "Reason for the Video Mesh node being unavailable (if any)." } } }, "MediaHealthMonitoringResultsforOrganization": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MediaHealthMonitoringResultsCollectionfororganization" } } } }, "MediaHealthMonitoringResultsCollectionfororganization": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Media Health Monitoring Tool data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Media Health Monitoring Tool data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MediaHealthMonitoringclusters" }, "description": "Media Health Monitoring Tool test results." } } }, "MediaHealthMonitoringResultsforcluster": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MediaHealthMonitoringResultsCollectionforcluster" } } } }, "MediaHealthMonitoringclusters": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MediaHealthMonitoringforfirstcluster" }, { "$ref": "#/components/schemas/MediaHealthMonitoringforsecondcluster" } ] }, "description": "The list of Video Mesh clusters." } } }, "MediaHealthMonitoringforfirstcluster": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "banglore", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MediaHealthMonitoringsecondnode" }, { "$ref": "#/components/schemas/MediaHealthMonitoringfirstnode" } ] }, "description": "The Video Mesh nodes in the cluster." } } }, "MediaHealthMonitoringforsecondcluster": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MediaHealthMonitoringsecondnode" }, { "$ref": "#/components/schemas/MediaHealthMonitoringfirstnode" } ] }, "description": "The Video Mesh nodes in the cluster." } } }, "MediaHealthMonitoringResultsCollectionforcluster": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Media Health Monitoring Tool data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Media Health Monitoring Tool data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PerclusterMediaHealthMonitoringclusters" }, "description": "Media Health Monitoring Tool test results." } } }, "PerclusterMediaHealthMonitoringclusters": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/PerclusterMediaHealthMonitoringresult" }, "description": "List of Video Mesh clusters." } } }, "PerclusterMediaHealthMonitoringresult": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MediaHealthMonitoringsecondnode" }, { "$ref": "#/components/schemas/MediaHealthMonitoringfirstnode" } ] }, "description": "The Video Mesh nodes in the cluster." } } }, "MediaHealthMonitoringfirstnode": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": "Unique ID of the Video Mesh node." }, "hostNameOrIP": { "type": "string", "example": "xyz.company.com", "description": "Host name or IP Address of the Video Mesh node." }, "mhmTestResults": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MediaHealthMonitoringTestResultsFailure" }, { "$ref": "#/components/schemas/MediaHealthMonitoringTestResultsSuccess" } ] }, "description": " The Media Health Monitoring Tool test results for a single Video Mesh node." } } }, "MediaHealthMonitoringsecondnode": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": "Unique ID of the Video Mesh node." }, "hostNameOrIP": { "type": "string", "example": "abc.company.com", "description": "Host name or the IP of the Video Mesh node." }, "mhmTestResults": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MediaHealthMonitoringTestResultsFailure" }, { "$ref": "#/components/schemas/MediaHealthMonitoringTestResultsSuccess" } ] }, "description": "The Media Health Monitoring Tool test results for a single Video Mesh node." } } }, "MediaHealthMonitoringResultsfornode": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MediaHealthMonitoringResultsCollectionfornode" } } } }, "MediaHealthMonitoringResultsCollectionfornode": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Media Health Monitoring Tool data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Media Health Monitoring Tool data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PernodeMediaHealthMonitoringclusters" }, "description": "Media Health Monitoring Tool test results." } } }, "PernodeMediaHealthMonitoringclusters": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/PernodeMediaHealthMonitoringresult" }, "description": "The list of Video Mesh clusters." } } }, "PernodeMediaHealthMonitoringresult": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/MediaHealthMonitoringfirstnode" }, "description": "The Video Mesh nodes in the cluster." } } }, "MediaHealthMonitoringTestResultsFailure": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-15T15:53:00Z", "description": "The timestamp of the test run." }, "id": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU", "description": "Unique ID of the test." }, "testResults": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MediaSignallingtestResultFailure" }, { "$ref": "#/components/schemas/MediaCascadetestResultFailure" }, { "$ref": "#/components/schemas/SIPSignallingtestResultFailure" } ] }, "description": "Test results of Media Signalling, SIP Signalling, Media Cascade runs." } } }, "MediaHealthMonitoringTestResultsSuccess": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-15T15:53:00Z", "description": "The timestamp of the test run." }, "id": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU", "description": "Unique ID of the test." }, "testResults": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MediaSignallingtestResultSuccess" }, { "$ref": "#/components/schemas/MediaCascadetestResultSuccess" }, { "$ref": "#/components/schemas/SIPSignallingtestResultSuccess" } ] }, "description": "Test results of Media Signalling, SIP Signalling, Media Cascade runs." } } }, "MediaSignallingtestResultSuccess": { "type": "object", "properties": { "testName": { "type": "string", "example": "Media Signalling", "description": "The name of the test." }, "testResult": { "type": "string", "example": "Success", "description": "The result, either `Success` or `Failed`." } } }, "MediaCascadetestResultSuccess": { "type": "object", "properties": { "testName": { "type": "string", "example": "Media Cascade", "description": "The name of the test." }, "testResult": { "type": "string", "example": "Success", "description": "The result, either `Success` or `Failed`." } } }, "SIPSignallingtestResultSuccess": { "type": "object", "properties": { "testName": { "type": "string", "example": "SIP Signalling", "description": "The name of the test." }, "testResult": { "type": "string", "example": "Success", "description": "The result, either `Success` or `Failed`." } } }, "MediaSignallingtestResultFailure": { "type": "object", "properties": { "testName": { "type": "string", "example": "Media Signalling", "description": "The name of the test." }, "testResult": { "type": "string", "example": "Failed", "description": "Test results(Success/Failed)." }, "failureReason": { "type": "string", "example": "An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support.", "description": "Reason for test failure." } } }, "MediaCascadetestResultFailure": { "type": "object", "properties": { "testName": { "type": "string", "example": "Media Cascade", "description": "The name of the test." }, "testResult": { "type": "string", "example": "Failed", "description": "Test results(Success/Failed)." }, "failureReason": { "type": "string", "example": "An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support.", "description": "Reason for test failure." } } }, "SIPSignallingtestResultFailure": { "type": "object", "properties": { "testName": { "type": "string", "example": "SIP Signalling", "description": "The name of the test." }, "testResult": { "type": "string", "example": "Failed", "description": "Test results(Success/Failed)." }, "failureReason": { "type": "string", "example": "An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support.", "description": "Reason for test failure." } } }, "OverflowtoCloud": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OverflowtoCloudCollection" } } } }, "OverflowtoCloudCollection": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ", "description": "The unique ID for the organization." }, "from": { "type": "string", "example": "2022-03-23T10:22:03Z", "description": "Start date and time (inclusive) for the Overflow to Cloud data." }, "to": { "type": "string", "example": "2022-03-24T04:22:03Z", "description": "End date and time (inclusive) for the Overflow to Cloud data." }, "aggregationInterval": { "type": "string", "example": "10m", "description": "The aggregation period of the trend data." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CloudOverflowTrend1" }, { "$ref": "#/components/schemas/CloudOverflowTrend2" } ] }, "description": "Overflow data for the organization." } } }, "CloudOverflowTrend1": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:30:00Z", "description": "Timestamp." }, "overflowDetails": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/OverflowDetails1" }, { "$ref": "#/components/schemas/OverflowDetails2" } ] }, "description": "Overflow Details." } } }, "CloudOverflowTrend2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:40:00Z", "description": "Timestamp." }, "overflowDetails": { "type": "array", "items": { "$ref": "#/components/schemas/OverflowDetails3" }, "description": "Overflow Details." } } }, "OverflowDetails1": { "type": "object", "properties": { "overflowReason": { "type": "string", "example": "Capacity exceeded", "description": "The reason for this overflow." }, "overflowCount": { "type": "number", "example": 25, "description": "Number of overflows." }, "possibleRemediation": { "type": "string", "example": "Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters.", "description": "Any possible remediations for this overflow." } } }, "OverflowDetails2": { "type": "object", "properties": { "overflowReason": { "type": "string", "example": "Connectivity issues", "description": "The reason for this overflow." }, "overflowCount": { "type": "number", "example": 1, "description": "Number of overflows." }, "possibleRemediation": { "type": "string", "example": "Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration.", "description": "Any possible remediations for this overflow." } } }, "OverflowDetails3": { "type": "object", "properties": { "overflowReason": { "type": "string", "example": "Capacity exceeded", "description": "The reason for this overflow." }, "overflowCount": { "type": "number", "example": 38, "description": "Number of overflows." }, "possibleRemediation": { "type": "string", "example": "Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters.", "description": "Any possible remediations for this overflow." } } }, "RedirectforOrg": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RedirectCollectionForOrg" } } } }, "RedirectCollectionForOrg": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ", "description": "The unique ID for the organization." }, "from": { "type": "string", "example": "2022-03-23T10:22:03Z", "description": "Start date and time (inclusive) for the Call Redirect details." }, "to": { "type": "string", "example": "2022-03-24T10:22:03Z", "description": "End date and time (inclusive) of the Call Redirect details." }, "aggregationInterval": { "type": "string", "example": "10m", "description": "The aggregation period of the trend data." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RedirectTrend1" }, { "$ref": "#/components/schemas/RedirectTrend2" } ] }, "description": "Redirect details for the organization." } } }, "RedirectTrend1": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:30:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterRedirectBlr1" }, { "$ref": "#/components/schemas/ClusterRedirectSJ1" } ] } } } }, "RedirectTrend2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:40:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterRedirectBlr2" }, { "$ref": "#/components/schemas/ClusterRedirectSJ2" } ] } } } }, "ClusterRedirectBlr1": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "bangalore", "description": "Name of the Video Mesh cluster." }, "redirectDetails": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterRedirectDetailsBlr1a" }, { "$ref": "#/components/schemas/ClusterRedirectDetailsBlr1b" } ] }, "description": "Call Redirect Details." } } }, "ClusterRedirectBlr2": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "bangalore", "description": "Name of the Video Mesh cluster." }, "redirectDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterRedirectDetailsBlr2" }, "description": "Call Redirect Details." } } }, "ClusterRedirectSJ1": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "redirectDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterRedirectDetailsSJ1" }, "description": "Call Redirect Details." } } }, "ClusterRedirectSJ2": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "redirectDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterRedirectDetailsSJ2" }, "description": "Call Redirect Details." } } }, "ClusterRedirectDetailsBlr1a": { "type": "object", "properties": { "redirectReason": { "type": "string", "example": "Capacity exceeded", "description": "The reason for the redirect." }, "redirectCount": { "type": "number", "example": 10, "description": "Number of Call Redirects." }, "possibleRemediation": { "type": "string", "example": "Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters.", "description": " Any possible remediations for this overflow." } } }, "ClusterRedirectDetailsBlr1b": { "type": "object", "properties": { "redirectReason": { "type": "string", "example": "Connectivity issues", "description": "The reason for the redirect." }, "redirectCount": { "type": "number", "example": 78, "description": "Number of Call Redirects." }, "possibleRemediation": { "type": "string", "example": "Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration.", "description": " Any possible remediations for this overflow." } } }, "ClusterRedirectDetailsBlr2": { "type": "object", "properties": { "redirectReason": { "type": "string", "example": "Node upgrading", "description": "The reason for the redirect." }, "redirectCount": { "type": "number", "example": 4, "description": "Number of Call Redirects." }, "possibleRemediation": { "type": "string", "example": "Video Mesh Node is being upgraded. Please wait for upgrades to finish.", "description": "Any possible remediations for this overflow." } } }, "ClusterRedirectDetailsSJ1": { "type": "object", "properties": { "redirectReason": { "type": "string", "example": "Capacity exceeded", "description": "The reason for the redirect." }, "redirectCount": { "type": "number", "example": 26, "description": "Number of Call Redirects." }, "possibleRemediation": { "type": "string", "example": "Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters.", "description": "Any possible remediations for this overflow." } } }, "ClusterRedirectDetailsSJ2": { "type": "object", "properties": { "redirectReason": { "type": "string", "example": "Connectivity issues", "description": "The reason for the redirect." }, "redirectCount": { "type": "number", "example": 47, "description": "Number of Call Redirects." }, "possibleRemediation": { "type": "string", "example": "Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration.", "description": "Any possible remediations for this overflow." } } }, "RedirectForCluster": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RedirectCollectionForCluster" } } } }, "RedirectCollectionForCluster": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ", "description": "The unique ID for the organization." }, "from": { "type": "string", "example": "2022-03-23T10:22:03Z", "description": "Start date and time (inclusive) for the Call Redirect details." }, "to": { "type": "string", "example": "2022-03-24T10:22:03Z", "description": "End date and time (inclusive) of the Call Redirect details." }, "aggregationInterval": { "type": "string", "example": "10m", "description": "The aggregation period of the trend data." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RedirectTrendForCluster1" }, { "$ref": "#/components/schemas/RedirectTrendForCluster2" } ] }, "description": "Redirect details for the organization." } } }, "RedirectTrendForCluster1": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:30:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterRedirectBlr1" } } } }, "RedirectTrendForCluster2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:40:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterRedirectBlr2" } } } }, "ClustersUtilization": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterUtilizationCollection" } } } }, "ClusterUtilizationCollection": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=", "description": "The unique ID for the organization." }, "aggregationInterval": { "type": "string", "example": "10m", "description": "The aggregation period of the trend data." }, "from": { "type": "string", "example": "2022-03-23T10:22:03Z", "description": "Start date and time (inclusive) of the utilization data." }, "to": { "type": "string", "example": "2022-03-24T10:22:03Z", "description": "End date and time (inclusive) of the utilization data." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterUtilizationTrend1" }, { "$ref": "#/components/schemas/ClusterUtilizationTrend2" } ] }, "description": "Utilization details of the Video Mesh cluster" } } }, "ClusterUtilizationTrend1": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:30:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterUtilizationT1SJ" }, { "$ref": "#/components/schemas/ClusterUtilizationT1Blr" } ] } } } }, "ClusterUtilizationT1SJ": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "utilizationMetrics": { "$ref": "#/components/schemas/UtilizationMetricsT1SJ", "description": "Utilization details for the cluster in the time interval." } } }, "ClusterUtilizationT1Blr": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "bangalore", "description": "Name of the Video Mesh cluster." }, "utilizationMetrics": { "$ref": "#/components/schemas/UtilizationMetricsT1Blr", "description": "Utilization details for the cluster in the time interval." } } }, "UtilizationMetricsT1SJ": { "type": "object", "properties": { "peakCpu": { "type": "number", "example": 54.54, "description": "Peak CPU usage during the time interval." }, "avgCpu": { "type": "number", "example": 4.27, "description": "Average CPU usage during the time interval." }, "activeCalls": { "type": "number", "example": 5, "description": "Maximum active calls at a point in the time interval." }, "activePrivateCalls": { "type": "number", "example": 1, "description": "Maximum active private calls at a point in the time interval." } } }, "UtilizationMetricsT1Blr": { "type": "object", "properties": { "peakCpu": { "type": "number", "example": 62, "description": "Peak CPU usage during the time interval." }, "avgCpu": { "type": "number", "example": 3.64, "description": "Average CPU usage during the time interval." }, "activeCalls": { "type": "number", "description": "Maximum active calls at a point in the time interval." }, "activePrivateCalls": { "type": "number", "description": "Maximum active private calls at a point in the time interval." } } }, "ClusterUtilizationTrend2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:40:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterUtilizationT2SJ" }, { "$ref": "#/components/schemas/ClusterUtilizationT2Blr" } ] } } } }, "ClusterUtilizationT2SJ": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "utilizationMetrics": { "$ref": "#/components/schemas/UtilizationMetricsT2SJ", "description": "Utilization details for the cluster in the time interval." } } }, "ClusterUtilizationT2Blr": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "bangalore", "description": "Name of the Video Mesh cluster." }, "utilizationMetrics": { "$ref": "#/components/schemas/UtilizationMetricsT2Blr", "description": "Utilization Metric details for the cluster in the time interval." } } }, "UtilizationMetricsT2SJ": { "type": "object", "properties": { "peakCpu": { "type": "number", "example": 73.26, "description": "Peak CPU usage during the time interval." }, "avgCpu": { "type": "number", "example": 13.16, "description": "Average CPU usage during the time interval." }, "activeCalls": { "type": "number", "example": 7, "description": "Maximum active calls at a point in the time interval." }, "activePrivateCalls": { "type": "number", "example": 2, "description": "Maximum active private calls at a point in the time interval." } } }, "UtilizationMetricsT2Blr": { "type": "object", "properties": { "peakCpu": { "type": "number", "example": 69.75, "description": "Peak CPU usage during the time interval." }, "avgCpu": { "type": "number", "example": 57.89, "description": "Average CPU usage during the time interval." }, "activeCalls": { "type": "number", "example": 142, "description": "Maximum active calls at a point in the time interval." }, "activePrivateCalls": { "type": "number", "example": 15, "description": "Maximum active private calls at a point in the time interval." } } }, "UtilizationForCluster": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UtilizationForClusterCollection" } } } }, "UtilizationForClusterCollection": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=", "description": "The unique ID for the organization." }, "aggregationInterval": { "type": "string", "example": "10m", "description": "The aggregation period of the trend data." }, "from": { "type": "string", "example": "2022-03-23T10:22:03Z", "description": "Start date and time (inclusive) of the utilization data." }, "to": { "type": "string", "example": "2022-03-24T10:22:03Z", "description": "End date and time (inclusive) of the utilization data." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/UtilizationForClusterTrend1" }, { "$ref": "#/components/schemas/UtilizationForClusterTrend2" } ] }, "description": "Utilization details of the Video Mesh cluster." } } }, "UtilizationForClusterTrend1": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:30:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterUtilizationT1Blr" } } } }, "UtilizationForClusterTrend2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:40:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterUtilizationT2Blr" } } } }, "ReachabilityTestResults": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestresultsfororganization" } } } }, "ReachabilityTestResultsCluster": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestresultsforcluster" } } } }, "ReachabilityTestResultsNode": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestresultsfornode" } } } }, "ReachabilityTestresultsfororganization": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Reachability test results data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Reachability test results data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestResultsforcluster" }, "description": "Reachability test results data." } } }, "ReachabilityTestresultsforcluster": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Reachability test results data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Reachability test results data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestResultsforsinglecluster" }, "description": "Reachability test results data." } } }, "ReachabilityTestresultsfornode": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Reachability test results data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Reachability test results data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestResultsforoneclusteronenode" }, "description": "Reachability test results data." } } }, "ReachabilityTestResultsforcluster": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ReachabilityTestResultsforfirstcluster" }, { "$ref": "#/components/schemas/ReachabilityTestResultsforsecondcluster" } ] }, "description": "List of Video Mesh clusters." } } }, "ReachabilityTestResultsforsinglecluster": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestResultsforfirstcluster" }, "description": "List of Video Mesh clusters." } } }, "ReachabilityTestResultsforoneclusteronenode": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestResultsforonecluster" }, "description": "List of Video Mesh clusters." } } }, "ReachabilityTestResultsforonecluster": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "banglore", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestresultsfirstnode" }, "description": "The Video Mesh nodes in the cluster." } } }, "ReachabilityTestResultsforfirstcluster": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "banglore", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ReachabilityTestresultsfirstnode" }, { "$ref": "#/components/schemas/ReachabilityTestresultssecondnode" } ] }, "description": "The Video Mesh nodes in the cluster." } } }, "ReachabilityTestResultsforsecondcluster": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ReachabilityTestresultsfirstnode" }, { "$ref": "#/components/schemas/ReachabilityTestresultssecondnode" } ] }, "description": "The Video Mesh nodes in the cluster." } } }, "ReachabilityTestresultsfirstnode": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": "Unique ID of the Video Mesh node." }, "hostNameOrIP": { "type": "string", "example": "xyz.company.com", "description": "Host name or the IP of the Video Mesh node." }, "testResults": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestresultsdestinationcluster" }, "description": " Reachability test results for a single Video Mesh node." } } }, "ReachabilityTestresultssecondnode": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": "Unique ID of the Video Mesh node." }, "hostNameOrIP": { "type": "string", "example": "abc.company.com", "description": "Host name or the IP of the Video Mesh node." }, "testResults": { "type": "array", "items": { "$ref": "#/components/schemas/ReachabilityTestresultsdestinationcluster" }, "description": " Reachability test results for a single Video Mesh node." } } }, "ReachabilityTestresultsdestinationcluster": { "type": "object", "properties": { "destinationCluster": { "type": "string", "example": "Amsterdam Cluster", "description": "Cloud Webex cluster against which Reachability test is being executed." }, "stunResults": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ReachabilityTestResultsStunresults1" }, { "$ref": "#/components/schemas/ReachabilityTestResultsStunresults2" } ] }, "description": "STUN test results for a Video Mesh cluster." } } }, "ReachabilityTestResultsStunresults1": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-15T15:53:00Z", "description": "The timestamp of the test run." }, "triggerType": { "type": "string", "example": "OnDemand", "description": "The type of the test being executed. Can be either `OnDemand` or `Periodic`." }, "id": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU", "description": "Unique ID of the test." }, "udp": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ReachabilityTestresultsFailure" }, { "$ref": "#/components/schemas/ReachabilityTestresultsSuccess" } ] }, "description": "List of UDP ports being checked in Reachability test." }, "tcp": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ReachabilityTestresultsFailure" }, { "$ref": "#/components/schemas/ReachabilityTestresultsSuccess" } ] }, "description": "List of TCP ports being checked in Reachability test." } } }, "ReachabilityTestResultsStunresults2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-15T16:53:00Z", "description": "The timestamp of the test run." }, "triggerType": { "type": "string", "example": "OnDemand", "description": "The type of the test being executed. Can be either `OnDemand` or `Periodic`." }, "id": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU", "description": "Unique ID of the test." }, "udp": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ReachabilityTestresultsFailure" }, { "$ref": "#/components/schemas/ReachabilityTestresultsSuccess" } ] }, "description": "List of UDP ports being checked in Reachability test." }, "tcp": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ReachabilityTestresultsFailure" }, { "$ref": "#/components/schemas/ReachabilityTestresultsSuccess" } ] }, "description": "List of TCP ports being checked in Reachability test." } } }, "ReachabilityTestresultsSuccess": { "type": "object", "properties": { "ipAddress": { "type": "string", "example": "1.1.1.1", "description": "Destination IP address." }, "port": { "type": "number", "example": 5004, "description": "Port number." }, "reachable": { "type": "boolean", "example": true, "description": "Port reachability information." } } }, "ReachabilityTestresultsFailure": { "type": "object", "properties": { "ipAddress": { "type": "string", "example": "1.1.1.1", "description": "Destination IP address." }, "port": { "type": "number", "example": 51004, "description": "Port number." }, "reachable": { "type": "boolean", "description": "Port reachability information." } } }, "ClusterDetails": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterDetailsCollection" } } } }, "ClusterDetailsCollection": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ", "description": "The unique ID for the organization." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BlrClusterDetails" }, { "$ref": "#/components/schemas/SJClusterDetails" } ] }, "description": " Details of all the clusters of the organization." } } }, "BlrClusterDetails": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "Bangalore", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BlrNode1" }, { "$ref": "#/components/schemas/BlrNode2" } ] }, "description": "The Video Mesh nodes in the cluster." }, "releaseChannel": { "type": "string", "example": "alpha", "description": "Release Channel of the Video Mesh cluster." }, "upgradeSchedule": { "$ref": "#/components/schemas/ClusterUpgradeScheduleBlr", "description": "Upgrade Schedule details of the Video Mesh cluster." } } }, "BlrNode1": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI", "description": "ID of the Video Mesh node." }, "hostNameOrIp": { "type": "string", "example": "xyz.abc.com", "description": "Host Name or the IP of the Video Mesh node." }, "deploymentType": { "type": "string", "example": "Video Mesh Node Lite", "description": "Deployment Type of the Video Mesh node." }, "location": { "$ref": "#/components/schemas/BlrNodeLocation", "description": "Location details of the Video Mesh node." } } }, "BlrNodeLocation": { "type": "object", "properties": { "countryCode": { "type": "string", "example": "IN", "description": "Country code of the Location where the Video Mesh node is deployed." }, "city": { "type": "string", "example": "Bangalore", "description": "City where Video Mesh node is deployed." }, "timeZone": { "type": "string", "example": "Asia/Kolkata", "description": "Time zone in which the Video Mesh node is deployed." } } }, "BlrNode2": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg", "description": "ID of the Video Mesh node." }, "hostNameOrIp": { "type": "string", "example": "201.21.201.21", "description": "Host Name or the IP of the Video Mesh node." }, "deploymentType": { "type": "string", "example": "Video Mesh Node Lite", "description": "Deployment Type of the Video Mesh node." }, "location": { "$ref": "#/components/schemas/BlrNodeLocation", "description": "Location details of the Video Mesh node." } } }, "SJClusterDetails": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "San Jose", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SJNode1" }, { "$ref": "#/components/schemas/SJNode2" } ] }, "description": "The Video Mesh nodes in the cluster." }, "releaseChannel": { "type": "string", "example": "alpha", "description": "Release Channel of the Video Mesh cluster." }, "upgradeSchedule": { "$ref": "#/components/schemas/ClusterUpgradeScheduleSJ", "description": "Upgrade Schedule details of the Video Mesh cluster." } } }, "SJNode1": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI", "description": "ID of the Video Mesh node." }, "hostNameOrIp": { "type": "string", "example": "abc.company.com", "description": "Host Name or the IP of the Video Mesh node." }, "deploymentType": { "type": "string", "example": "Video Mesh Node Lite", "description": "Deployment Type of the Video Mesh node." }, "location": { "$ref": "#/components/schemas/SJNodeLocation", "description": "Location details of the Video Mesh node." } } }, "SJNode2": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg", "description": "ID of the Video Mesh node." }, "hostNameOrIp": { "type": "string", "example": "xyz.abc.com", "description": "Host Name or the IP of the Video Mesh node." }, "deploymentType": { "type": "string", "example": "Video Mesh Node Lite", "description": "Deployment Type of the Video Mesh node." }, "location": { "$ref": "#/components/schemas/SJNodeLocation", "description": "Location details of the Video Mesh node." } } }, "SJNodeLocation": { "type": "object", "properties": { "countryCode": { "type": "string", "example": "US", "description": "Country Code of the Location where the Video Mesh node is deployed." }, "city": { "type": "string", "example": "San Jose", "description": "City where Video Mesh node is deployed." }, "timeZone": { "type": "string", "example": "America/Los_Angeles", "description": "Time zone in which the Video Mesh node is deployed." } } }, "ScheduleDays": { "type": "string", "enum": [ "sunday", "saturday", "tuesday", "friday", "wednesday", "thursday", "monday" ] }, "ClusterUpgradeScheduleBlr": { "type": "object", "properties": { "scheduleDays": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDays" }, "description": "Days of the week when scheduled upgrades will occur for the Video Mesh cluster." }, "scheduleTime": { "type": "string", "example": "02:00", "description": "Time when scheduled upgrade will occur for the Video Mesh cluster." }, "scheduleTimeZone": { "type": "string", "example": "Asia/Kolkata", "description": "Timezone of the scheduled upgrade of Video Mesh cluster." }, "upgradePending": { "type": "boolean", "example": true, "description": "Upgrade Pending information." }, "nextUpgradeTime": { "type": "string", "example": "2020-03-25T20:30:00Z", "description": "Time when the next upgrade is scheduled for the Video Mesh cluster." } } }, "ClusterUpgradeScheduleSJ": { "type": "object", "properties": { "scheduleDays": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDays" }, "description": "Days of the week when scheduled upgrades will occur for the Video Mesh cluster." }, "scheduleTime": { "type": "string", "example": "02:00", "description": "Time when scheduled upgrade will occur for the Video Mesh cluster." }, "scheduleTimeZone": { "type": "string", "example": "America/Los_Angeles", "description": "Timezone of the scheduled upgrade of Video Mesh cluster." }, "upgradePending": { "type": "boolean", "example": true, "description": "Upgrade Pending information." }, "nextUpgradeTime": { "type": "string", "example": "2020-03-26T09:00:00Z", "description": "Time when the next upgrade is scheduled for the Video Mesh cluster." } } }, "SpecificClusterDetails": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SpecificClusterDetailsCollection" } } } }, "SpecificClusterDetailsCollection": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ", "description": "The unique ID for the organization." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BlrClusterDetails" }, "description": " Details of the cluster." } } }, "TriggeredTestResult": { "type": "object", "properties": { "type": { "type": "string", "example": "MediaHealthMonitorTest", "description": "Test type of the command ID." }, "commandId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU", "description": "The unique ID for the test being executed." }, "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TestClustersResult" } } } }, "TestClustersResult": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/Results" } } } }, "Results": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "test_manual", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/NodesResult" } } } }, "NodesResult": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": " Unique ID of the Video Mesh node." }, "hostNameOrIP": { "type": "string", "example": "abc.company.com", "description": "Host name or IP Address of the Video Mesh node." }, "mhmTestResults": { "type": "array", "items": { "$ref": "#/components/schemas/MHMTestResults" } } } }, "MHMTestResults": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-15T15:53:00Z", "description": "The timestamp of the test run." }, "id": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU" }, "testResults": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/MHMTestResult1" }, { "$ref": "#/components/schemas/MHMTestResult2" }, { "$ref": "#/components/schemas/MHMTestResult3" } ] } } } }, "MHMTestResult1": { "type": "object", "properties": { "testName": { "type": "string", "example": "Media Signalling" }, "testResult": { "type": "string", "example": "Failed" }, "failureReason": { "type": "string", "example": "An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support." } } }, "MHMTestResult2": { "type": "object", "properties": { "testName": { "type": "string", "example": "Media Cascade" }, "testResult": { "type": "string", "example": "Failed" }, "failureReason": { "type": "string", "example": "An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support." } } }, "MHMTestResult3": { "type": "object", "properties": { "testName": { "type": "string", "example": "SIP Signalling" }, "testResult": { "type": "string", "example": "Success" } } }, "TriggeredTestStatus1": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "commandId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU", "description": "The unique ID of the test being executed." }, "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": " Unique ID of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/NodeStatusList1" }, { "$ref": "#/components/schemas/NodeStatusList2" } ] } } } }, "TriggeredTestStatus2": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "commandId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU", "description": "The unique ID of the test being executed." }, "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk=", "description": "Unique ID of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/NodeStatusList1" } } } }, "NodeStatusList1": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": "Unique ID of the Video Mesh node." }, "status": { "type": "string", "enum": [ "Dispatched", "Completed", "Errored" ], "description": "Status of the test triggered." } } }, "NodeStatusList2": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGU5OTc4Zjk5MDJl", "description": "Unique ID of the Video Mesh node." }, "status": { "type": "string", "enum": [ "Dispatched", "Completed", "Errored" ], "description": "Status of the test triggered." } } }, "TriggerOnDemandBody": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ReachabilityTest", "NetworkTest", "MediaHealthMonitorTest" ], "description": "Test type to trigger on node.\n * `ReachabilityTest` - Used to test whether the media ports within the Video Mesh node are open, and whether the Video Mesh node is able to reach the cloud clusters pertaining to the media containers via those ports.\n * `NetworkTest` - Used to test the network environment of the Video Mesh node by running various connectivity, bandwidth, and DNS resolution tests against Webex Cloud and ThirdParty Cloud (Docker) services.\n * `MediaHealthMonitorTest` - Used to test the meetings and call health of Video Mesh nodes using signalling and cascading methods.\n" } } }, "TriggerOn-DemandBodyCluster": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ReachabilityTest", "NetworkTest", "MediaHealthMonitorTest" ], "description": "Test type to trigger on node.\n * `ReachabilityTest` - Used to test whether the media ports within the Video Mesh node are open, and whether the Video Mesh node is able to reach the cloud clusters pertaining to the media containers via those ports.\n * `NetworkTest` - Used to test the network environment of the Video Mesh node by running various connectivity, bandwidth, and DNS resolution tests against Webex Cloud and ThirdParty Cloud (Docker) services.\n * `MediaHealthMonitorTest` - Used to test the meetings and call health of Video Mesh nodes using signaling and cascading methods.\n" }, "nodes": { "type": "array", "items": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGU5OTc4Zjk5MDJk,Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOWUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFjOjE1NmRmNzg5Yzg1NTRhYmNhZGVmZ2U5OTc4Zjk5MDJk" }, "description": "List of nodes to test." } } }, "ConnectivityTestResultsObject": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Network Test data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Network Test data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectivityTestResultsClustersObject1" }, "description": "Network test results." } } }, "ConnectivityTestResultsClustersObject1": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PerClusterConnectivityResult1" }, { "$ref": "#/components/schemas/PerClusterConnectivityResult2" } ] }, "description": "List of Video Mesh clusters." } } }, "ConnectivityTestResultsClustersObject2": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/PerClusterConnectivityResult2" }, "description": "List of Video Mesh clusters." } } }, "ConnectivityTestResultsClustersObject3": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/PerClusterConnectivityResult3" }, "description": "List of Video Mesh clusters." } } }, "ConnectivityTestResultsClustersObject": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Network Test data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Network Test data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectivityTestResultsClustersObject2" }, "description": "Network test results." } } }, "ConnectivityTestResultsNodesObject": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=", "description": "Unique ID of the organization." }, "from": { "type": "string", "example": "2023-01-15T15:53:00Z", "description": "Start date and time (inclusive) of the Network Test data." }, "to": { "type": "string", "example": "2023-01-20T15:53:00Z", "description": "End date and time (inclusive) of the Network Test data." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectivityTestResultsClustersObject3" }, "description": "Network test results." } } }, "PerClusterConnectivityResult1": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "sanjose", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PerNodeConnectivityResult1" }, { "$ref": "#/components/schemas/PerNodeConnectivityResult3" } ] } } } }, "PerClusterConnectivityResult2": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "shangai", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/PerNodeConnectivityResult2" } } } }, "PerClusterConnectivityResult3": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=", "description": "Unique ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "shangai", "description": "Name of the Video Mesh cluster." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/PerNodeConnectivityResult1" } } } }, "PerNodeConnectivityResult1": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": "Unique ID of the Video Mesh node." }, "hostNameOrIP": { "type": "string", "example": "abc.company.com", "description": "Host name or IP Address of the Video Mesh node." }, "testResults": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectivityTestResultsForNode" } } } }, "PerNodeConnectivityResult2": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": "Unique ID of the Video Mesh node." }, "hostNameOrIP": { "type": "string", "example": "def.company.com", "description": "Host name or IP Address of the Video Mesh node." }, "testResults": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectivityTestResultsForNode" } } } }, "PerNodeConnectivityResult3": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "description": "Unique ID of the Video Mesh node." }, "hostNameOrIP": { "type": "string", "example": "xyz.company.com", "description": "Host name or IP Address of the Video Mesh node." }, "testResults": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectivityTestResultsForNode" } } } }, "ConnectivityTestResultsForNode": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-15T15:53:00Z", "description": "The timestamp of the test run." }, "triggerType": { "type": "string", "example": "OnDemand", "description": "The type of the test being executed. Can be either `OnDemand` or `Periodic`." }, "id": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0NPTU1BTkRJRC8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY6YWRlODhhNjAtMzk5Mi0xMWVkLTlhYmQtYzUyMjRiZjNjMzQ4", "description": "Unique ID of the test." }, "result": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/DNSResolutionTest" }, { "$ref": "#/components/schemas/WebSocketConnectivityTest" }, { "$ref": "#/components/schemas/HTTPConnectivityTest" }, { "$ref": "#/components/schemas/BandwidthTest" } ] } } } }, "BandwidthTest": { "type": "object", "properties": { "type": { "type": "string", "example": "BandwidthTest", "description": "The type of test result." }, "results": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ServiceTypeResult4" }, { "$ref": "#/components/schemas/ServiceTypeResult2" } ] }, "description": "Test Results from different services." } } }, "WebSocketConnectivityTest": { "type": "object", "properties": { "type": { "type": "string", "example": "WebSocketConnectivityTest", "description": "The type of test result." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTypeResult5" }, "description": "Test Results from different services." } } }, "DNSResolutionTest": { "type": "object", "properties": { "type": { "type": "string", "example": "DNSResolutionTest", "description": "The type of test result." }, "results": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ServiceTypeResult1" }, { "$ref": "#/components/schemas/ServiceTypeResult2" } ] }, "description": "Test Results from different services." } } }, "HTTPConnectivityTest": { "type": "object", "properties": { "type": { "type": "string", "example": "HTTPConnectivityTest", "description": "The type of test result." }, "results": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ServiceTypeResult3" }, { "$ref": "#/components/schemas/ServiceTypeResult2" } ] }, "description": "Test Results from different services." } } }, "FailureDetails1": { "type": "object", "properties": { "possibleFailureReason": { "type": "array", "items": { "type": "string", "example": "DNS Resolution issue detected in the Video Mesh Node [Error Code: 1302]." }, "description": "Possible reasons for failure for the test." }, "possibleRemediation": { "type": "array", "items": { "type": "string", "example": "Please ensure that the configured DNS Servers are correct and healthy, and verify the network settings are adhering to the Video Mesh Deployment Guide. If the issue persists, please contact Cisco Support." }, "description": "Possible fixes for the failures mentioned above." } } }, "FailureDetails2": { "type": "object", "properties": { "possibleFailureReason": { "type": "array", "items": { "type": "string", "example": "Connectivity issue detected between the Video Mesh Node and the Webex Cloud [Error Code: 1106]." }, "description": "Possible reasons for failure for the test." }, "possibleRemediation": { "type": "array", "items": { "type": "string", "example": "One or more Webex cloud services may not be responding. Retry the test after some time. If the issue persists, please contact Cisco Support." }, "description": "Possible fixes for the failures mentioned above." } } }, "FailureDetails3": { "type": "object", "properties": { "possibleFailureReason": { "type": "array", "items": { "type": "string", "example": "Degraded Network Bandwidth speed detected in the Video Mesh Node connectivity to the Webex Cloud [Error Code: 1402,1405]." }, "description": "Possible reasons for failure for the test." }, "possibleRemediation": { "type": "array", "items": { "type": "string", "example": "Please refer to Video Mesh deployment guide to ensure the network settings are configured correctly, and the minimum internet speed requirements are met. If the issue persists, please contact Cisco Support." }, "description": "Possible fixes for the failures mentioned above." } } }, "ServiceTypeResult1": { "type": "object", "properties": { "serviceType": { "type": "string", "example": "WebexCloud", "description": "Service for which the test was executed." }, "testResult": { "type": "string", "example": "Failed", "description": "Result of the test executed." }, "failureDetails": { "$ref": "#/components/schemas/FailureDetails1" } } }, "ServiceTypeResult2": { "type": "object", "properties": { "serviceType": { "type": "string", "example": "ThirdPartyCloud", "description": "Service for which the test was executed." }, "testResult": { "type": "string", "example": "Success", "description": "Result of the test executed." } } }, "ServiceTypeResult3": { "type": "object", "properties": { "serviceType": { "type": "string", "example": "WebexCloud", "description": "Service for which test was executed." }, "testResult": { "type": "string", "example": "Failed", "description": "Result of the test executed." }, "failureDetails": { "$ref": "#/components/schemas/FailureDetails2" } } }, "ServiceTypeResult4": { "type": "object", "properties": { "serviceType": { "type": "string", "example": "WebexCloud", "description": "Service for which the test was executed." }, "testResult": { "type": "string", "example": "Failed", "description": "Result of the test executed." }, "failureDetails": { "$ref": "#/components/schemas/FailureDetails3" } } }, "ServiceTypeResult5": { "type": "object", "properties": { "serviceType": { "type": "string", "example": "WebexCloud", "description": "Service for which the test was executed." }, "testResult": { "type": "string", "example": "Success", "description": "Result of the test executed." } } }, "ClienttypedistributionforOrg": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClienttypedistributionCollectionforOrg" } } } }, "ClienttypedistributionCollectionforOrg": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ", "description": "The unique ID for the organization." }, "from": { "type": "string", "example": "2022-03-23T10:22:03Z", "description": "Start date and time (inclusive) for the Client Type Distribution details." }, "to": { "type": "string", "example": "2022-03-24T10:22:03Z", "description": "End date and time (inclusive) of the Client Type Distribution details." }, "aggregationInterval": { "type": "string", "example": "10m", "description": "The aggregation period of the trend data." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClientTypeDistributionTrend1" }, { "$ref": "#/components/schemas/ClientTypeDistributionTrend2" } ] }, "description": "Client Type Distribution details for the organization." } } }, "ClientTypeDistributionTrend1": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:30:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterClientTypeDistributionBlr1" }, { "$ref": "#/components/schemas/ClusterClientTypeDistributionSJ1" } ] } } } }, "ClientTypeDistributionTrend2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:40:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterClientTypeDistributionBlr2" }, { "$ref": "#/components/schemas/ClusterClientTypeDistributionSJ2" } ] } } } }, "ClusterClientTypeDistributionBlr1": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "Bangalore", "description": "Name of the Video Mesh cluster." }, "clientTypeDistributionDetails": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClusterClientTypeDistributionDetailsBlr1a" }, { "$ref": "#/components/schemas/ClusterClientTypeDistributionDetailsBlr1b" } ] }, "description": "Client Type Distribution Details." } } }, "ClusterClientTypeDistributionBlr2": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "Bangalore", "description": "Name of the Video Mesh cluster." }, "clientTypeDistributionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterClientTypeDistributionDetailsBlr2" }, "description": "Client Type Distribution Details." } } }, "ClusterClientTypeDistributionSJ1": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "San Jose", "description": "Name of the Video Mesh cluster." }, "clientTypeDistributionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterClientTypeDistributionDetailsSJ1" }, "description": "Client Type Distribution Details." } } }, "ClusterClientTypeDistributionSJ2": { "type": "object", "properties": { "clusterId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOTEyMzQ=", "description": "ID of the Video Mesh cluster." }, "clusterName": { "type": "string", "example": "San Jose", "description": "Name of the Video Mesh cluster." }, "clientTypeDistributionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterClientTypeDistributionDetailsSJ2" }, "description": "Client Type Distribution Details." } } }, "ClusterClientTypeDistributionDetailsBlr1a": { "type": "object", "properties": { "deviceType": { "type": "string", "example": "sipEndpoint", "description": "The type of device." }, "description": { "type": "string", "example": "SIP Devices", "description": "The description of the device type." }, "count": { "type": "number", "example": 10, "description": " The count of the device type." } } }, "ClusterClientTypeDistributionDetailsBlr1b": { "type": "object", "properties": { "deviceType": { "type": "string", "example": "webexAppVdi", "description": "The type of device." }, "description": { "type": "string", "example": "Webex App VDI", "description": "The description of the device type." }, "count": { "type": "number", "example": 78, "description": " The count of the device type." } } }, "ClusterClientTypeDistributionDetailsBlr2": { "type": "object", "properties": { "deviceType": { "type": "string", "example": "webexForMobile", "description": "The type of device." }, "description": { "type": "string", "example": "Webex App Mobile", "description": "The description of the device type." }, "count": { "type": "number", "example": 4, "description": "The count of the device type." } } }, "ClusterClientTypeDistributionDetailsSJ1": { "type": "object", "properties": { "deviceType": { "type": "string", "example": "webexForDesktop", "description": "The type of device." }, "description": { "type": "string", "example": "Webex App Desktop", "description": "The description of the device type." }, "count": { "type": "number", "example": 26, "description": "The count of the device type." } } }, "ClusterClientTypeDistributionDetailsSJ2": { "type": "object", "properties": { "deviceType": { "type": "string", "example": "webexDevices", "description": "The type of device." }, "description": { "type": "string", "example": "Webex Devices", "description": "The description of the device type." }, "count": { "type": "number", "example": 47, "description": "The count of the device type." } } }, "ClientTypeDistributionForCluster": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClientTypeDistributionCollectionForCluster" } } } }, "ClientTypeDistributionCollectionForCluster": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ", "description": "The unique ID for the organization." }, "from": { "type": "string", "example": "2022-03-23T10:22:03Z", "description": "Start date and time (inclusive) for the Client Type Distribution details." }, "to": { "type": "string", "example": "2022-03-24T10:22:03Z", "description": "End date and time (inclusive) of the Client Type Distribution details." }, "aggregationInterval": { "type": "string", "example": "10m", "description": "The aggregation period of the trend data." }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ClientTypeDistributionTrendForCluster1" }, { "$ref": "#/components/schemas/ClientTypeDistributionTrendForCluster2" } ] }, "description": "Client Type Distribution details for the organization." } } }, "ClientTypeDistributionTrendForCluster1": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:30:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterClientTypeDistributionBlr1" } } } }, "ClientTypeDistributionTrendForCluster2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2022-03-23T10:40:00Z", "description": "Timestamp." }, "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterClientTypeDistributionBlr2" } } } }, "UpdateEventThresholdConfig1": { "type": "object", "properties": { "minThreshold": { "type": "number", "example": 40, "description": "Threshold value (in percentage) to trigger an event." }, "defaultMinThreshold": { "type": "number", "example": 10, "description": "Deafault Threshold value (in percentage) to trigger an event." } } }, "UpdateEventThresholdConfig2": { "type": "object", "properties": { "minThreshold": { "type": "number", "example": 60, "description": "Threshold value (in percentage) to trigger an event." }, "defaultMinThreshold": { "type": "number", "example": 10, "description": "Deafault Threshold value (in percentage) to trigger an event." } } }, "GetEventThresholdResponse": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ", "description": "Unique ID of the organization." }, "eventThresholds": { "type": "array", "items": { "$ref": "#/components/schemas/GetEntityThresholdConfig1" } } } }, "ListEventThresholdResponse": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ", "description": "Unique ID of the organization." }, "eventThresholds": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/GetEntityThresholdConfig1" }, { "$ref": "#/components/schemas/GetEntityThresholdConfig2" } ] } } } }, "GetEntityThresholdConfig1": { "type": "object", "properties": { "eventName": { "type": "string", "example": "clusterCallsRedirected", "description": "Name of the event." }, "eventThresholdId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ", "description": "Unique ID of the event threshold configuration." }, "eventScope": { "type": "string", "example": "CLUSTER", "description": "The `eventScope` is scope of event." }, "entityId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzRiNTk5NzkwLWVlMzctMTFlZC1hMDViLTAyNDJhYzEyMDAwMzo2NjMxOTMyNC1lZTM3LTExZWQtYTA1Yi0wMjQyYWMxMjAwMDM", "description": "The `entityId` is the unique ID of the Organization or the unique ID of the Video Mesh Cluster." }, "thresholdConfig": { "$ref": "#/components/schemas/EventThresholdConfig1", "description": "Threshold configuration of an `entityId`." } } }, "EventThresholdConfig1": { "type": "object", "properties": { "minThreshold": { "type": "number", "example": 10, "description": "Threshold value (in percentage) to trigger an event." }, "defaultMinThreshold": { "type": "number", "example": 10, "description": "Deafault Threshold value (in percentage) to trigger an event." } } }, "GetEntityThresholdConfig2": { "type": "object", "properties": { "eventName": { "type": "string", "example": "orgCallsOverflowed", "description": "Name of the event." }, "eventThresholdId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg", "description": "Unique ID of the event threshold configuration." }, "eventScope": { "type": "string", "example": "ORG", "description": "The `eventScope` is scope of event." }, "entityId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ", "description": "The `entityId` is the unique ID of the Organization or the unique ID of the Video Mesh Cluster." }, "thresholdConfig": { "$ref": "#/components/schemas/EventThresholdConfig2", "description": "Threshold configuration of an `entityId`." } } }, "EventThresholdConfig2": { "type": "object", "properties": { "minThreshold": { "type": "number", "example": 10, "description": "Threshold value (in percentage) to trigger an event." }, "defaultMinThreshold": { "type": "number", "example": 10, "description": "Deafault Threshold value (in percentage) to trigger an event. " } } }, "BulkUpdateEventThresholdResponse": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ", "description": "Unique ID of the organization." }, "eventThresholds": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateEventThresholdResponse1" }, "description": "List of successful updated response" }, "failedEventThresholdIds": { "type": "array", "items": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg" }, "description": "List of failed or invalid event threshold IDs." } } }, "UpdateEventThresholdResponse1": { "type": "object", "properties": { "eventName": { "type": "string", "example": "clusterCallsRedirected", "description": "Name of the event." }, "eventThresholdId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3Zjo2YzJhZGRmMS0wYjAzLTRiZWEtYjIxYy0xYzFjYzdiY2UwOWQ", "description": "Unique ID of the event threshold configuration." }, "eventScope": { "type": "string", "example": "CLUSTER", "description": "The `eventScope` is scope of event." }, "entityId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzRiNTk5NzkwLWVlMzctMTFlZC1hMDViLTAyNDJhYzEyMDAwMzo2NjMxOTMyNC1lZTM3LTExZWQtYTA1Yi0wMjQyYWMxMjAwMDM", "description": "The `entityId` is the unique ID of the Organization or the unique ID of the Video Mesh Cluster." }, "thresholdConfig": { "$ref": "#/components/schemas/UpdateEventThresholdConfig1", "description": "Threshold configuration of an `entityId`." } } }, "UpdateEventThresholdResponse2": { "type": "object", "properties": { "eventName": { "type": "string", "example": "orgCallsOverflowed", "description": "Name of the event." }, "eventThresholdId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg", "description": "Unique ID of the event threshold configuration." }, "eventScope": { "type": "string", "example": "ORG", "description": "The `eventScope` is scope of event." }, "entityId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg", "description": "The `entityId` is the unique ID of the Organization or the unique ID of the Video Mesh Cluster." }, "thresholdConfig": { "$ref": "#/components/schemas/UpdateEventThresholdConfig2", "description": "Threshold configuration of an `entityId`." } } }, "EventThresholdBody": { "type": "object", "properties": { "eventName": { "type": "string", "enum": [ "clusterCallsRedirected", "orgCallsOverflowed" ], "description": "The name of the event corresponding to the `entitiyId`.\n * `clusterCallsRedirected` - Event name for cluster call redirects.\n * `orgCallsOverflowed` - Event name for organization call overflows.\n" } } }, "ResetEventThresholdResponse": { "type": "object", "properties": { "orgId": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ", "description": "Unique ID of the organization." }, "eventThresholds": { "type": "array", "items": { "$ref": "#/components/schemas/GetEntityThresholdConfig1" }, "description": "List of successful updated responses." }, "failedEventThresholdIds": { "type": "array", "items": { "type": "string", "example": "Y2lzY29zcGFyazovL3VzL0VWRU5ULzQyN2U5ZTk2LTczYTctNDYwYS04MGZhLTcyNWU4MWE2MDg3ZjowM2ZkYjkzZC1jNTllLTQzMjQtODIwNS1lNDIyYzA3NGQ5Mzg" }, "description": "List of failed or invalid event threshold IDs." } } } }, "securitySchemes": { "oauth2": { "flows": { "authorizationCode": { "authorizationUrl": "/", "scopes": {}, "tokenUrl": "/" } }, "type": "oauth2" }, "bearer-key": { "type": "http", "description": "e.g. Bearer YOUR_AUTHORIZATION_TOKEN", "scheme": "bearer", "bearerFormat": "JWT" } }, "parameters": {}, "responses": {}, "requestBodies": {} } }