Webex
MESSAGING · MESSAGING
Spaces, messages, teams, people, and meetings in the Webex account they connected.
Acts as the person, not as itself
Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.
Credentials never touch the agent
Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.
Every call on the record
Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.
What an agent can do
Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.
webex_delete_admin_meeting_config_trackingcodes_by_trackingcodeidWRITEDeletes a tracking code by an admin user. * The `siteUrl` is required. The operation deletes a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the Get Site List (/docs/api/v1/meeting-preferences/get-site-list) API. * Admins can switch any Control Hu. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_delete_admin_recordings_by_recordingidWRITERemoves a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host, attendees and shared) or an admin, but it will be still available to the Compliance Officer. Any recording on a site which is managed by the admi. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_delete_meeting_messages_by_meetingmessageidWRITEDeletes a Meeting Message from the In Meeting Chat, using its ID. This ID can be retrieved by a Compliance Officer using the events API (/docs/api/v1/events/list-events) filtering on the `meetingMessages` resource type. NOTE: When viewing the response from the events API, there are 2 `id` fields. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_delete_meetinginvitees_by_meetinginviteeidWRITERemoves a meeting invitee identified by a `meetingInviteeId` specified in the URI. The deleted meeting invitee cannot be recovered. If the meeting invitee is associated with a meeting series, the invitee will be removed from the entire meeting series. If the invitee is associated with a scheduled m.
webex_delete_meetings_by_meetingidWRITE<div> <Callout type="warning">If only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains `inProgress` for 5 minutes after the last guest leaves. The meeting cannot be deleted during this time. If the meeting is started by the host or cohost.
webex_delete_meetings_by_meetingid_breakoutsessionsWRITEDeletes breakout sessions with a specified meeting ID. The deleted breakout sessions cannot be recovered. The value of `enabledBreakoutSessions` attribute is set to `false` automatically. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meetin.
webex_delete_meetings_by_meetingid_interpreters_by_interpreteridWRITERemoves a meeting interpreter identified by `meetingId` and `interpreterId` in the URI. The deleted meeting interpreter cannot be recovered.
webex_delete_meetings_by_meetingid_registrants_by_registrantidWRITEMeeting's host or cohost can delete a registrant with a specified registrant ID.
webex_delete_meetings_by_meetingid_registrationWRITEDisable the registration form for a meeting.
webex_delete_meetings_postmeetingchatsWRITEDeletes the meeting chats of a finished meeting instance (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) specified by `meetingId`. Use this operation to delete the chats of a finished [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_delete_meetingsummaries_by_summaryidWRITERemoves 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.
webex_delete_meetingtranscripts_by_transcriptidWRITERemoves 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. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_delete_memberships_by_membershipidWRITEDeletes a membership by ID. Specify the membership ID in the `membershipId` URI parameter. The membership for the last moderator of a Team (/docs/api/v1/teams)'s General space may not be deleted; promote another user (/docs/api/v1/team-memberships/update-a-team-membership) to team moderator firs.
webex_delete_messages_by_messageidWRITEDelete a message, by message ID. Specify the message ID in the `messageId` parameter in the URI.
webex_delete_people_by_personidWRITERemove a person from the system. Required Administrator Roles: The following administrators have permission to use this API: Customer Organization: - Full administrator - User administrator Partner/External Access: - External full administrator Note: External read-only administr. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_delete_recordings_by_recordingidWRITERemoves a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), but will be still available to the Compliance Officer. Only recor.
webex_delete_room_linkedfolders_by_idWRITEUnlinks the room-linked folder with the specified ID from the space.
webex_delete_room_tabs_by_idWRITEDeletes a Room Tab with the specified ID.
webex_delete_rooms_by_roomidWRITEDeletes a room, by ID. Deleted rooms cannot be recovered. As a security measure to prevent accidental deletion, when a non moderator deletes the room they are removed from the room instead. Deleting a room that is part of a team will archive the room instead. A Compliance Officer has no special pr.
webex_delete_team_memberships_by_membershipidWRITEDeletes a team membership, by ID. Specify the team membership ID in the `membershipId` URI parameter. The team membership for the last moderator of a team may not be deleted; promote another user (/docs/api/v1/team-memberships/update-a-team-membership) to team moderator first.
webex_delete_teams_by_teamidWRITEDeletes a team, by ID. Specify the team ID in the `teamId` parameter in the URI.
webex_delete_webhooks_by_webhookidWRITEDeletes a webhook, by ID. Specify the webhook ID in the `webhookId` parameter in the URI.
webex_get_admin_meeting_config_commonsettingsREADSite administrators can use this API to get a list of functions, options, and privileges that are configured for their Webex service sites. * If `siteUrl` is specified, common settings of the meeting's configuration of the specified site will be queried; otherwise, the API will query from the site. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meeting_config_sessiontypesREADList session types for a specific site. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meeting_config_trackingcodesREADLists tracking codes on a site by an admin user. * If `siteUrl` is specified, tracking codes of the specified site will be listed; otherwise, tracking codes of the user's preferred site will be listed. All available Webex sites and the preferred sites of a user can be retrieved by the... ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meeting_config_trackingcodes_by_trackingcodeidREADRetrieves details for a tracking code by an admin user. * If `siteUrl` is specified, the tracking code is retrieved from the specified site; otherwise, the tracking code is retrieved from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meeting_userconfig_sessiontypesREADList session types for a specific user. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meeting_userconfig_trackingcodesREADLists user's tracking codes by an admin user. * At least one parameter, either `personId`, or `email` is required. `personId` must come before `email` if both are specified. Please note that `email` is specified in the request header. * If `siteUrl` is specified, the tracking codes of the specifie. At least one of `personId` or `email` is required, and `personId` must come before `email` if both are given. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meetingsREADRetrieves 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 b. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meetings_by_meetingidREADRetrieves 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`, `dialInIpAddre. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meetingsummariesREADLists 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 hi. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_meetingtranscriptsREADLists available or deleted transcripts of an ended meeting instance (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) for a specific site. The returned list is sorted in descending order by the date and time that the transcript was created. Request Header: * `timezone`. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_admin_recordingsREAD<div><Callout type="warning">This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings For an Admin or Compliance Officer](/d. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_attachment_actions_by_idREADShows details for a attachment action, by ID. Specify the attachment action ID in the `id` URI parameter.
webex_get_eventsREADList events in your organization. Several query parameters are available to filter the events returned in the response. Long result sets will be split into pages (/docs/basics#pagination). COMPLIANCE OFFICER ONLY: the Events API needs spark-compliance:events_read, an organization-wide scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_events_by_eventidREADShows details for an event, by event ID. Specify the event ID in the `eventId` parameter in the URI. COMPLIANCE OFFICER ONLY: the Events API needs spark-compliance:events_read, an organization-wide scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_group_meetingsREADList group meetings with a specified meeting number or web link by a service app which has group meeting access. You can specify the `personId` parameter or `hostEmail` header of whom the meetings will be retrieved. Please note that there are various products in the [Webex Suite](https://www.webex.c. `personId` is required here: Webex accepts either `personId` or a `hostEmail` request header, and this integration sends no headers. GROUP ADMINISTRATOR ONLY: Webex documents this operation for meeting:group_meeting_read/write, which this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_group_recordingsREADList group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and `personId` or `hostEmail` of whom the recordings will be retrieved. * The list returned is sorted in descending order by the date and time that the. `personId` is required here: Webex accepts either `personId` or a `hostEmail` request header, and this integration sends no headers. GROUP ADMINISTRATOR ONLY: Webex documents this operation for meeting:group_meeting_read/write, which this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_group_recordings_by_recordingidREADRetrieves details for a group recording for a service app which has group recording access. * Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed. * One of the `personId` parameter. `personId` is required here: Webex accepts either `personId` or a `hostEmail` request header, and this integration sends no headers. GROUP ADMINISTRATOR ONLY: Webex documents this operation for meeting:group_meeting_read/write, which this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_clusters_by_clusteridREADRetrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster. To obtain the Cluster ID needed for this API, use the Get organization details API (</docs/api/v1/hds/get-organization-details>). ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_clusters_by_clusterid_availabilityREADGet the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment. To obtain the Cluster ID needed for this API, use the [Get organization details API](</docs/api/v1/hd. ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_clusters_by_clusterid_nodesREADRetrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. To obtain the Cluster ID needed for this API, use the [List clusters for an Hybrid Data Security organization API](</docs/api/v1/hds/list-hds-organiz. ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_nodes_by_nodeidREADRetrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details, etc. To obtain the Node ID needed for this API, use the Get cluster details API (</docs/api/v1/hds/get-cluster-details>). ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_nodes_by_nodeid_alarmsREADReturns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). To obtain the Node ID needed for this API, use the List nodes for an Hybrid Data Security cluster API (</docs/api/v1/hds/list-hds-cluster-nodes>). ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_nodes_by_nodeid_resourceusageREADRetrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. To obtain the Node ID needed for this API, use the List nodes for an Hybrid Data Security cluster API (</docs/api/v1/hds/list-hds-cluster-nodes>). ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_organizations_by_organizationidREADRetrieve details for an Hybrid Data Security organization, such as the organization name, type of organization. To obtain the Organization ID needed for this API, use the Organizations API (</docs/api/v1/organizations/list-organizations>). ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_organizations_by_organizationid_clustersREADRetrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. To obtain the Organization ID needed for this API, use the Organizations API (</docs/api/v1/organizations/list-organizations>). ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_organizations_by_organizationid_databaseREADRetrieve details of database information for an Hybrid Data Security organization, such as database type and version used. To obtain the Organization ID needed for this API, use the Organizations API (</docs/api/v1/organizations/list-organizations>). ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_organizations_by_organizationid_tenantsREADRetrieve details of Multi-Tenant Hybrid Data Security organization such as Organization Name and ID, CMK state and state of Tenants Organizations. To obtain the Organization ID needed for this API, use the Organizations API (</docs/api/v1/organizations/list-organizations>). ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_hds_testresults_nodes_by_nodeid_networktestREADGet the latest results of the network tests triggered for a single Hybrid Data Security node. The test results are generated as part of the Network Test execution on the node. The network tests include the Bandwidth Test, DNS Resolution Test, and HTTPS Connectivity Test. The results from the latest. ORGANIZATION ADMINISTRATOR ONLY: Hybrid Data Security is an org-level deployment surface and needs a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetingclosedcaptionsREADLists closed captions of a finished meeting instance (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) specified by `meetingId`. * Closed captions are ready 15 minutes after the meeting is finished. * Only meeting instances in state `ended` are supported for `meetingId`. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetingclosedcaptions_by_closedcaptionid_downloadREADDownload meeting closed caption snippets from the meeting closed caption specified by `closedCaptionId` formatted either as a Video Text Track (.vtt) file or plain text (.txt) file. Request Header: * `timezone`: *Time zone (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) fo. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetingclosedcaptions_by_closedcaptionid_snippetsREADLists snippets of a meeting closed caption specified by `closedCaptionId`. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetinginviteesREADLists meeting invitees for a meeting with a specified `meetingId`. You can set a maximum number of invitees to return. This operation can be used for meeting series, scheduled meetings, and ended or ongoing meeting instance objects. If the specified `meetingId` is for a meeting series, the invitees.
webex_get_meetinginvitees_by_meetinginviteeidREADRetrieve details for a meeting invitee identified by a `meetingInviteeId` in the URI.
webex_get_meetingparticipantsREADList all participants in an in-progress meeting or an ended meeting. The `meetingId` parameter is required, which is the unique identifier for the meeting. The authenticated user calling this API must either have an Administrator role with the `meeting:admin_participants_read` scope, or be the meet.
webex_get_meetingparticipants_by_participantidREADGet a meeting participant details of a live or post meeting. The `participantId` is required to identify the meeting and the participant. The authenticated user calling this API must either have an Administrator role with the `meeting:admin_participants_read` scope, or be the meeting host.
webex_get_meetingpreferencesREADRetrieves meeting preferences for the authenticated user.
webex_get_meetingpreferences_audioREADRetrieves audio options for the authenticated user.
webex_get_meetingpreferences_personalmeetingroomREADRetrieves the Personal Meeting Room options for the authenticated user.
webex_get_meetingpreferences_schedulingoptionsREADRetrieves scheduling options for the authenticated user.
webex_get_meetingpreferences_sitesREADRetrieves the list of Webex sites that the authenticated user is set up to use. When the admin tries to get the site list via `userEmail`, if `siteUrl` is not specified, the API searches the user ID from the admin's default site. If `siteUrl` is specified, the API searches the user ID from the speci.
webex_get_meetingpreferences_videoREADRetrieves video options for the authenticated user.
webex_get_meetingreports_attendeesREADLists 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. If 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 b.
webex_get_meetingreports_usageREADList 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. The list returned is sorted in descending order by the date and time the meetings were started. Long result sets are split into... ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetingsREAD<div><Callout type="info">The previous `List Meetings of a Meeting Series` API is merged into the List Meetings (/docs/api/v1/meetings/list-meetings) API.</Callout></div> Retrieves details for meetings with a specified meeting number, web link, meeting type, etc. Please note that there are various.
webex_get_meetings_by_meetingidREADRetrieves details for a meeting with a specified meeting ID. * If the `meetingId` value specified is for a meeting series and `current` is `true`, the operation returns details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming schedul.
webex_get_meetings_by_meetingid_breakoutsessionsREADLists meeting breakout sessions for a meeting with a specified `meetingId`. This operation can be used for meeting series, scheduled meeting and ended or ongoing meeting instance objects. See the Webex Meetings (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) guide for more.
webex_get_meetings_by_meetingid_interpretersREADLists meeting interpreters for a meeting with a specified `meetingId`. This operation can be used for meeting series, scheduled meeting and ended or ongoing meeting instance objects. If the specified `meetingId` is for a meeting series, the interpreters for the series will be listed; if the `meetin.
webex_get_meetings_by_meetingid_interpreters_by_interpreteridREADRetrieves details for a meeting interpreter identified by `meetingId` and `interpreterId` in the URI.
webex_get_meetings_by_meetingid_invitationsourcesREADLists invitation sources for a meeting. Request Header: * `hostEmail`: Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the A.
webex_get_meetings_by_meetingid_registrantsREADMeeting's host and cohost can retrieve the list of registrants for a meeting with a specified meeting Id.
webex_get_meetings_by_meetingid_registrants_by_registrantidREADRetrieves details for a meeting registrant with a specified registrant Id.
webex_get_meetings_by_meetingid_registrationREADGet a meeting's registration form to understand which fields are required.
webex_get_meetings_by_meetingid_surveyREADRetrieves details for a meeting survey identified by `meetingId`. Request Header: * `hostEmail`: Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a.
webex_get_meetings_by_meetingid_surveyresultsREADRetrieves results for a meeting survey identified by `meetingId`. Request Header: * `timezone`: Time zone for time stamps in response body, defined in conformance with the IANA time zone database (https://www.iana.org/time-zones). The default value is `UTC` if not specified. * `hostEmail`: E.
webex_get_meetings_controlsREADGet the meeting control of a live meeting, which is consisted of meeting control status on "locked" and "recording" to reflect whether the meeting is currently locked and there is recording in progress.
webex_get_meetings_pollresultsREADList the meeting polls, the poll's questions, and answers from the meeting when ready. * Only meeting instances (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) in state `ended` or `inProgress` are supported for `meetingId`. * Long result sets will be split into [pages](/d. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetings_pollsREADLists all the polls and the poll questions in a meeting when ready. * Only meeting instances (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) in state `ended` or `inProgress` are supported for `meetingId`. * No pagination for this API because we don't expect a large number. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetings_polls_by_pollid_questions_by_questionid_respondentsREADLists the respondents to a specific questions in a poll. * Only meeting instances (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) in state `ended` or `inProgress` are supported for `meetingId`. * Long result sets are split into pages (/docs/basics#pagination). <div><Cal. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetings_postmeetingchatsREADLists the meeting chats of a finished meeting instance (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) specified by `meetingId`. You can set a maximum number of chats to return. Use this operation to list the chats of a finished [meeting instance](/docs/meetings#meeting-se. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetings_q_and_aREADLists questions and answers from a meeting, when ready. Notes: * Only meeting instances (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) in state `ended` or `inProgress` are supported for `meetingId`. * Long result sets will be split into pages (/docs/basics#pagination). ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetings_q_and_a_by_questionid_answersREADLists the answers to a specific question asked in a meeting. * Only meeting instance (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) in state `ended` or `inProgress` are supported for `meetingId`. * Long result sets will be split into pages (/docs/basics#pagination). ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_meetings_sessiontypesREADList all the meeting session types enabled for a given user.
webex_get_meetings_sessiontypes_by_sessiontypeidREADRetrieves details for a meeting session type with a specified session type ID.
webex_get_meetings_templatesREADRetrieves the list of meeting templates that is available for the authenticated user. There are separate lists of meeting templates for different `templateType`, `locale` and `siteUrl`. * If `templateType` is specified, the operation returns an array of meeting template objects specified by the `t.
webex_get_meetings_templates_by_templateidREADRetrieves details for a meeting template with a specified meeting template ID. Request Header: * `timezone`: Time zone (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.ia.
webex_get_meetings_trackingcodesREADLists tracking codes on a site by a meeting host. The result indicates which tracking codes and what options can be used to create or update a meeting on the specified site. * The `options` here differ from those in the site-level tracking codes (/docs/api/v1/tracking-codes/get-a-tracking-code) an.
webex_get_meetingsummariesREADGet the summary of an ended meeting instance (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) by the meeting ID. Please 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.
webex_get_meetingtranscriptsREADLists available transcripts of an ended meeting instance (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances). Use this operation to list transcripts of an ended meeting instance (/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) when they are ready. Plea.
webex_get_meetingtranscripts_by_transcriptid_downloadREADDownload a meeting transcript from the meeting transcript specified by `transcriptId`.
webex_get_meetingtranscripts_by_transcriptid_snippetsREADLists snippets of a meeting transcript specified by `transcriptId`. Use this operation to list snippets of a meeting transcript when they are ready.
webex_get_meetingtranscripts_by_transcriptid_snippets_by_snippetidREADRetrieves details for a transcript snippet specified by `snippetId` from the meeting transcript specified by `transcriptId`.
webex_get_membershipsREADLists all room memberships. By default, lists memberships for rooms to which the authenticated user belongs. Use query parameters to filter the response. Use `roomId` to list memberships for a room, by ID. NOTE: For moderated team spaces, the list of memberships will include only the space mo. `roomId` is REQUIRED when filtering by `personId` or `personEmail`.
webex_get_memberships_by_membershipidREADGet details for a membership by ID. Specify the membership ID in the `membershipId` URI parameter.
webex_get_messagesREADLists all messages in a room. Each message will include content attachments if present. The list sorts the messages in descending order by creation date. Long result sets will be split into pages (/docs/basics#pagination).
webex_get_messages_by_messageidREADShow details for a message, by message ID. Specify the message ID in the `messageId` parameter in the URI.
webex_get_messages_directREADList all messages in a 1:1 (direct) room. Use the `personId` or `personEmail` query parameter to specify the room. Each message will include content attachments if present. The list sorts the messages in descending order by creation date.
webex_get_peopleREADList people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization. Response properties associated with a user's presence status, such as `status` or `lastActivity`, will only be ret. For most users either `email` or `displayName` is required; only an organization administrator may omit both and list everyone.
webex_get_people_by_personidREADShows details for a person, by ID. Response properties associated with a user's presence status, such as `status` or `lastActivity`, will only be displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has...
webex_get_people_meREADGet profile details for the authenticated user. This is the same as GET `/people/{personId}` using the Person ID associated with your Auth token. Admin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.
webex_get_recordingreport_accessdetailREADRetrieves details for a recording audit report with a specified recording ID. Only recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved. Request Header: * `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zone.
webex_get_recordingreport_accesssummaryREADLists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return. Only recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed. The list returned is sorted in descending.
webex_get_recordingreport_meetingarchives_by_archiveidREADRetrieves details for a meeting archive report with a specified archive ID, which contains recording metadata. Meeting archive details are only available to full administrators, not even the meeting host. Request Header: * `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_datab. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_recordingreport_meetingarchivesummariesREADLists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return. Meeting archive summaries are only available to full administrators, not even the meeting host. The list returned is sorted in descending order by the date and time that. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_recordingsREAD<div><Callout type="warning">This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by `topic`, it is recommended to use the new [Query Recordings](/docs/api/v1/recordings/query-recordi.
webex_get_recordings_by_recordingidREADRetrieves details for a recording with a specified recording ID. Only recordings of meetings hosted by or shared with the authenticated user may be retrieved. Request Header: * `timezone`: *Time zone (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the.
webex_get_room_linkedfoldersREADLists the ECM folder of a room specified by the `roomId` query parameter.
webex_get_room_linkedfolders_by_idREADGet details for a room ECM folder with the specified folder id.
webex_get_room_tabsREADLists all Room Tabs of a room specified by the `roomId` query parameter.
webex_get_room_tabs_by_idREADGet details for a Room Tab with the specified room tab ID.
webex_get_roomsREADList rooms to which the authenticated user belongs to. The `title` of the room for 1:1 rooms will be the display name of the other person. Please use the memberships API (https://developer.webex.com/docs/api/v1/memberships) to list the people in the space. Long result sets will be split into...
webex_get_rooms_by_roomidREADShows details for a room, by ID. The `title` of the room for 1:1 rooms will be the display name of the other person. When a Compliance Officer lists 1:1 rooms, the "other" person cannot be determined. This means that the room's title may not be filled in and instead shows "Empty Title". Please use.
webex_get_rooms_by_roomid_meetinginfoREAD<div> <callout type="warning"> The meetingInfo API is deprecated and will be EOL on Jan 31, 2025. Meetings in the WSMP must be scheduled and licensed via the meetings backend. The Create a Meeting (/docs/api/v1/meetings/create-a-meeting) endpoint will provide the SIP address for the meeting to call.
webex_get_slido_compliance_eventsREADLists events representing actions that occurred during a Slido Secure Premium session (creating a poll, modifying a poll, activating a poll, posting an answer, etc.) Events capture who performed the action and on what resource. The events are paginated by the server into pages of max 256 items per. COMPLIANCE OFFICER ONLY: Slido compliance events need a spark-compliance scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_team_membershipsREADLists all team memberships for a given team, specified by the `teamId` query parameter. Use query parameters to filter the response.
webex_get_team_memberships_by_membershipidREADShows details for a team membership, by ID. Specify the team membership ID in the `membershipId` URI parameter.
webex_get_teamsREADLists teams to which the authenticated user belongs.
webex_get_teams_by_teamidREADShows details for a team, by ID. Specify the team ID in the `teamId` parameter in the URI.
webex_get_videomesh_callredirectsREADReturns the redirect details of all Video Mesh clusters in an organization. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_clienttypedistributionREADReturns the client type distribution details for all Video Mesh clusters in an organization. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_clienttypedistribution_clustersREADReturns the client type distribution details for a single Video Mesh cluster. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_cloudoverflowREADReturns details of overflows to the cloud in an organization. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_clustersREADReturns the cluster details of all Video Mesh clusters in an organization. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_clusters_availabilityREADReturns the availability details for all Video Mesh clusters in an organization. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_clusters_availability_by_clusteridREADReturns the availability details of a single Video Mesh cluster in an organization. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_clusters_by_clusteridREADReturns the cluster details for a single Video Mesh cluster. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_clusters_callredirectsREADReturns details of cluster redirects for a single Video Mesh cluster. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_clusters_utilizationREADReturns the utilization details for a single Video Mesh cluster. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_eventthresholdsREADReturns the event threshold configurations for `orgId` or `clusterId`, with optional filters `eventName` and `eventScope`. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_eventthresholds_by_eventthresholdidREADReturns the event threshold configurations for `eventThresholdId`. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_nodes_availabilityREADReturns the availability details of all nodes in a Video Mesh cluster. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_nodes_availability_by_nodeidREADReturns the availability details of a single node in a Video Mesh cluster. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresultsREADReturns the results of the test triggered using the command ID.<br/> <b>NOTE:</b> The response format depends on the type of test triggered and it is the same as that of NetworkTest API (/docs/api/v1/video-mesh/list-network-test-results), [MediaHealthMonitorTest API](/docs/api/v1/video-mesh/list-me. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_mediahealthmonitortestREADReturns the test results of the Media Health Monitoring Tool tests for an organization. <br/> Changes in V2: <br/> On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_mediahealthmonitortest_clustersREADReturns the test results of the Media Health Monitoring Tool tests for a single Video Mesh cluster. <br/> Changes in V2: <br/> On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_mediahealthmonitortest_nodesREADReturns the test results of the Media Health Monitoring Tool tests for a single Video Mesh node. <br/> Changes in V2: <br/> On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_networktestREADReturns the test results of the Network tests triggered for an organization. The tests listed below are run as a part of the Network Test execution on the node. <b>Bandwidth Test</b> - Tests the bandwidth parameters of the Video Mesh node's network. The test is run between the Video Mesh node and c. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_networktest_clustersREADReturns the test results of the Network tests triggered for a single Video Mesh cluster. The tests listed below are run as a part of the Network Test execution on the node. <b>Bandwidth Test</b> - Tests the bandwidth parameters of the Video Mesh node's network. The test is run between the Video Mes. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_networktest_nodesREADReturns the test results of the Network tests triggered for a single Video Mesh node. The tests listed below are run as a part of the Network Test execution on the node. <b>Bandwidth Test</b> - Tests the bandwidth parameters of the Video Mesh node's network. The test is run between the Video Mesh n. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_reachabilitytestREADReturns the test results of the Reachability tests for an organization. <br/> Changes in V2: <br/> 1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. <br/> 2. You can now view the destination IP address of the destination cluster in t. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_reachabilitytest_clustersREADReturns the test results of the Reachability tests for a single Video Mesh cluster. <br/> Changes in V2: <br/> 1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. <br/> 2. You can now view the destination IP address of the destination. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_testresults_reachabilitytest_nodesREADReturns the test results of the Reachability tests for a single Video Mesh node. <br/> Changes in V2: <br/> 1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. <br/> 2. You can now view the destination IP address of the destination clu. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_teststatusREADReturns the status of the test triggered using the Trigger on-demand test API. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_videomesh_utilizationREADReturns the utilization details of all Video Mesh clusters in an organization. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_get_webhooksREADList all of your webhooks.
webex_get_webhooks_by_webhookidREADShows details for a webhook, by ID. Specify the webhook ID in the `webhookId` parameter in the URI.
webex_patch_admin_meeting_config_commonsettingsWRITESite administrators can use this API to update the option of features, options and privileges that are configured for their WebEx service sites. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_patch_group_meetings_by_meetingidWRITEPatches details for a group meeting with a specified meeting ID by a service app which has group meeting access. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/mee. `personId` is required here: Webex accepts either `personId` or a `hostEmail` request header, and this integration sends no headers. GROUP ADMINISTRATOR ONLY: Webex documents this operation for meeting:group_meeting_read/write, which this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_patch_meetings_by_meetingidWRITE<div> <Callout type="warning">If only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains `inProgress` for 5 minutes after the last guest leaves. The meeting cannot be patched during this time. If the meeting is started by the host or cohost.
webex_patch_videomesh_eventthresholdsWRITEUpdates an existing event threshold configuration for given Event Threshold IDs. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_admin_meeting_config_trackingcodesWRITECreate a new tracking code by an admin user. * The `siteUrl` is required. The operation creates a tracking code for the specified site. All or a user's available Webex sites can be retrieved by the Get Site List (/docs/api/v1/meeting-preferences/get-site-list) API. * The `inputMode` of `hostProfi. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_admin_meetingpreferences_personalmeetingroom_refreshidWRITERefreshes personal room IDs automatically according to the current personal room ID rule of the target site or by the values specified by the admin user. The new personal room IDs are generated by the site's settings automatically if `systemGenerated` is true; otherwise, replace the existing person. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_admin_recordings_queryWRITEQueries recordings for an admin or compliance officer with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, topic, format, serviceType, and status. The list returned is. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_attachment_actionsWRITECreate a new attachment action.
webex_post_group_meetings_controlsWRITEUpdate meeting recording control status by a service app which has group meeting access. The service app can use this API to start, stop, pause, or resume meeting recording by providing an `action` value. The `personId` parameter or `hostEmail` header of the person to whom the meeting belongs must b. GROUP ADMINISTRATOR ONLY: Webex documents this operation for meeting:group_meeting_read/write, which this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_meetinginviteesWRITE* Invite a person to attend a meeting. * Identify the invitee in the request body, by email address. * The `sendEmail` parameter is `true` by default and the meeting emails will be sent to the invitee's `email`. Please set `sendEmail` to `false` to prevent the invitee from receiving emails.
webex_post_meetinginvitees_bulkinsertWRITE* Invite people to attend a meeting in bulk. * Identify each invitee by the email address of each item in the `items` of the request body. * Each invitee should have a unique `email`. * This API limits the maximum size of `items` in the request body to 100. * The `sendEmail` parameter for each i.
webex_post_meetingparticipants_admitWRITEAdmit multiple participants to a meeting in progress. This API limits the maximum size of `items` in the request body to 100. Each `participantId` of `items` in the request body should have the same prefix of `meetingId`.
webex_post_meetingparticipants_calloutWRITEInitiate a call to a SIP participant to join a meeting. If a user invoking the API is not a Service App (/docs/service-apps), the user must join the meeting before invoking the API. If a user is a Service App (/docs/service-apps), the service app can invoke the API without joining the meeting. In.
webex_post_meetingparticipants_cancelcalloutWRITECancel the call to a SIP participant before the ringing on the invited SIP device stops. The ringing on the invited SIP device stops in 30 seconds if there is no response. If a user invoking the API is not a Service App (/docs/service-apps), the user must join the meeting before invoking the API.
webex_post_meetingparticipants_queryWRITEQuery participants in a live meeting, or after the meeting, using participant's email. The `meetingId` parameter is the unique identifier for the meeting and is required. The authenticated user calling this API must either have an Administrator role with the `meeting:admin_participants_read` scope,. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_meetingpreferences_schedulingoptions_delegateemails_deleteWRITEDelete delegate emails for the authenticated user. Deletes the authenticated user's delegate emails.
webex_post_meetingpreferences_schedulingoptions_delegateemails_insertWRITEInsert delegate emails for the authenticated user.
webex_post_meetingsWRITECreates a new meeting. Regular users can schedule up to 100 meetings in 24 hours and admin users up to 3000 overall or 800 for a single user. Please note that the failed requests are also counted toward the limits. * The `spark:all` scope is required when `roomId` is specified. * If the parameter.
webex_post_meetings_by_meetingid_endWRITEEnds a meeting with a specified meeting ID. This operation applies to meeting series, scheduled meetings, and in-progress meetings. Only the meeting host, cohost, or compliance officer can end a meeting with this API. * If the `meetingId` value specified is for a scheduled meeting, the operation en.
webex_post_meetings_by_meetingid_interpretersWRITEAssign an interpreter to a bi-directional simultaneous interpretation language channel for a meeting.
webex_post_meetings_by_meetingid_invitationsourcesWRITECreates one or more invitation sources for a meeting.
webex_post_meetings_by_meetingid_registrantsWRITERegister a new registrant for a meeting. When a meeting or webinar is created, this API can only be used if Registration is checked on the page or the registration attribute is specified through the Create a Meeting (/docs/api/v1/meetings/create-a-meeting) API.
webex_post_meetings_by_meetingid_registrants_approveWRITEBatch approve a set of registrants for a meeting by the meeting host or cohost.
webex_post_meetings_by_meetingid_registrants_bulkdeleteWRITEBatch delete a set of registrants for a meeting by the meeting host or cohost. Batch DELETES meeting registrants; the registrations are gone, not cancelled (webex_post_meetings_by_meetingid_registrants_cancel is the reversible one).
webex_post_meetings_by_meetingid_registrants_bulkinsertWRITEBulk register new registrants for a meeting. When a meeting or webinar is created, this API can only be used if Registration is checked on the page or the registration attribute is specified through the Create a Meeting (/docs/api/v1/meetings/create-a-meeting) API.
webex_post_meetings_by_meetingid_registrants_cancelWRITEBatch cancel a set of registrants for a meeting by the meeting host or cohost.
webex_post_meetings_by_meetingid_registrants_queryWRITEMeeting's host and cohost can query the list of registrants for a meeting with a specified meeting ID and registrants email.
webex_post_meetings_by_meetingid_registrants_rejectWRITEBatch reject a set of registrants for a meeting by the meeting host or cohost.
webex_post_meetings_by_meetingid_surveylinksWRITEGet survey links of a meeting for different users. Request Header: * `timezone`: Time zone for the `meetingStartTimeFrom` and `meetingStartTimeTo` parameters and defined in conformance with the IANA time zone database (https://www.iana.org/time-zones). The default value is `UTC` if not specif.
webex_post_meetings_joinWRITERetrieves links for a meeting with a specified `meetingId`, `meetingNumber`, or `webLink` that allow users to start or join the meeting directly without logging in and entering a password. * Please note that `meetingId`, `meetingNumber` and `webLink` are mutually exclusive and they cannot be specif.
webex_post_meetings_reassignhostWRITEReassigns a list of meetings to a new host by an admin user. All the meetings of `meetingIds` should belong to the same site, which is the `siteUrl` in the request header, if specified, or the admin user's preferred site, if not specified. All available Webex sites and the preferred sites of a user. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_membershipsWRITEAdd someone to a room by Person ID or email address, optionally making them a moderator. Compliance Officers cannot add people to empty (team) spaces.
webex_post_messagesWRITEPost a plain text or rich text (/docs/basics#formatting-messages) message, and optionally, a file attachment (/docs/basics#message-attachments) attachment, to a room. The `files` parameter is an array, which accepts multiple values to allow for future expansion, but currently only one file may be.
webex_post_peopleWRITECreate a new user account for a given organization. Only an admin can create a new user account. At least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`. Currently, users may have only one email address associated with their account. T. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_recordings_accesslistWRITEShare or unshare a recording with other users by recording link and email addresses.
webex_post_recordings_by_recordingid_accesslistWRITEShare or unshare a recording with other users by recording ID and email addresses.
webex_post_recordings_purgeWRITEPurge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin. Only recordings of meetings hosted by the authenticated user can be purged from recycle bin. * If `purgeAll` is `true`, `recordingIds` should be empty. * If `purgeAll` is `false`, `record. PERMANENT AND IRREVERSIBLE: purges recordings from the recycle bin, and with `purgeAll` true it empties the whole bin.
webex_post_recordings_queryWRITEQueries recordings with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, hostEmail, topic, format, serviceType, and status. Only recordings of meetings hosted by or sha.
webex_post_recordings_restoreWRITERestore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin. * If `restoreAll` is `true`, `recordingIds` should be empty. * If `restoreAll` is `false`, `recordingIds` should not be empty and its maximum size is.
webex_post_recordings_softdeleteWRITEMove recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by Restore Recordings from Recycle Bin (/docs/api/v1/recordings/restore-recordings-from-recycle-bin) API. If you'd like to empty recordings from the recycle bin, you can use... Removes recordings the same way DELETE /recordings/{recordingId} does; they go to the recycle bin and are recoverable only until it is purged.
webex_post_room_linkedfoldersWRITEAdds an existing ECM folder to a room as (default or reference) file storage. There is no data validation happening for the request. Please ensure the correct `driveId` and `itemId.` These can be collected from the MS Graph API. The `contentUrl` and `displayName` are used only for user convenience.
webex_post_room_tabsWRITEAdd a tab with a specified URL to a room.
webex_post_roomsWRITECreates a room. The authenticated user is automatically added as a member of the room. See the Memberships API (/docs/api/v1/memberships) to learn how to add more people to the room. To create a 1:1 room, use the Create Messages (/docs/api/v1/messages/create-a-message) endpoint to send a message.
webex_post_team_membershipsWRITEAdd someone to a team by Person ID or email address, optionally making them a moderator.
webex_post_teamsWRITECreates a team. The authenticated user is automatically added as a member of the team. See the Team Memberships API (/docs/api/v1/team-memberships) to learn how to add more people to the team.
webex_post_videomesh_eventthresholds_resetWRITEResets the existing event threshold configuration for given Event Threshold IDs to default value. To stop receiving webhook events, use the Webhooks API (docs/api/v1/webhooks) to delete the webhook in question. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_videomesh_triggertest_clusters_by_clusteridWRITETriggers an on-demand test for a cluster. The test is run on a maximum of 10 nodes present in the cluster, chosen at random, or based on input from the user. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_videomesh_triggertest_nodes_by_nodeidWRITETriggers an on-demand test for a node. ORGANIZATION ADMINISTRATOR ONLY: the Video Mesh Developer APIs are, in Cisco's words, for organization admins, and need a spark-admin scope this integration does not request. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_post_webhooksWRITECreates a webhook. To learn more about how to create and use webhooks, see The Webhooks Guide (/docs/api/guides/webhooks).
webex_put_admin_meeting_config_trackingcodes_by_trackingcodeidWRITEUpdates details for a tracking code by an admin user. * The `siteUrl` is required. The operation updates a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the Get Site List (/docs/api/v1/meeting-preferences/get-site-list) API. * The `inputMode` of `. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_put_admin_meeting_userconfig_sessiontypesWRITEAssign session types to specific users. * At least one of the following body parameters is required to update a specific user session type: `personId`, `email`. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_put_admin_meeting_userconfig_trackingcodesWRITEUpdates tracking codes for a specified user by an admin user. * The `siteUrl` is required. The operation updates a user's tracking code on the specified site. All a user's available Webex sites can be retrieved by the Get Site List (/docs/api/v1/meeting-preferences/get-site-list) API. Please note. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation for a meeting:admin_* or spark-compliance scope, neither of which this integration requests. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_put_meetinginvitees_by_meetinginviteeidWRITEUpdate details for a meeting invitee identified by a `meetingInviteeId` in the URI.
webex_put_meetingparticipants_by_participantidWRITEMute, un-mute, expel, or admit a participant in a live meeting. The `participantId` is required to identify the meeting and the participant. Notes: * The owner of the OAuth token calling this API needs to be the meeting host or co-host. * The `expel` attribute always takes precedence over `admit`.
webex_put_meetingpreferences_audioWRITEUpdates audio options for the authenticated user.
webex_put_meetingpreferences_personalmeetingroomWRITEUpdates Personal Meeting Room options for the authenticated user.
webex_put_meetingpreferences_schedulingoptionsWRITEUpdates scheduling options for the authenticated user. * If `delegateEmails` is null or not specified, the user's delegate emails are not changed. If `delegateEmails` is specified and not empty, the user's delegate emails are updated with the specified emails. If `delegateEmails` is specified as an.
webex_put_meetingpreferences_sitesWRITEUpdates the default site for the authenticated user.
webex_put_meetingpreferences_videoWRITEUpdates video options for the authenticated user.
webex_put_meetings_by_meetingidWRITE<div> <Callout type="warning">The PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.</Callout> </div> <div> <Callout type="warning">If only guests are waiting in the lobby and the host or cohost has not started the meeting,.
webex_put_meetings_by_meetingid_breakoutsessionsWRITEUpdates breakout sessions of a meeting with a specified meeting ID in the pre-meeting state. This operation applies to meeting series and scheduled meetings.
webex_put_meetings_by_meetingid_interpreters_by_interpreteridWRITEUpdates details for a meeting interpreter identified by `meetingId` and `interpreterId` in the URI.
webex_put_meetings_by_meetingid_registrationWRITEEnable or update a registration form for a meeting.
webex_put_meetings_by_meetingid_simultaneousinterpretationWRITEUpdates simultaneous interpretation options of a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances.
webex_put_meetings_controlsWRITETo start, pause, resume, or stop a meeting recording; To lock or unlock an on-going meeting.
webex_put_meetingtranscripts_by_transcriptid_snippets_by_snippetidWRITEUpdates details for a transcript snippet specified by `snippetId` from the meeting transcript specified by `transcriptId`. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_put_memberships_by_membershipidWRITEUpdates properties for a membership by ID. Specify the membership ID in the `membershipId` URI parameter.
webex_put_messages_by_messageidWRITEUpdate a message you have posted not more than 10 times. Specify the `messageId` of the message you want to edit. Edits of messages containing files or attachments are not currently supported. If a user attempts to edit a message containing files or attachments a `400 Bad Request` will be returned.
webex_put_people_by_personidWRITEUpdate details for a person, by ID. Specify the person ID in the `personId` parameter in the URI. Only an admin can update a person details. Include all details for the person. This action expects all user details to be present in the request. A common approach is to first... `showAllTypes` must be `true` when removing a meeting-site attendee privilege. ORGANIZATION ADMINISTRATOR OR COMPLIANCE OFFICER ONLY: Webex documents this operation only for scopes this integration does not request (spark-admin:*, spark-compliance:* or meeting:admin_*), which are org-wide and need an organization administrator or compliance officer to consent. An organization that registers its own Webex integration can enable those scopes on it and then use this tool.
webex_put_room_linkedfolders_by_idWRITEUpdates the configuration of the specified Room folder. There is no data validation happening for the request. Please ensure the correct `driveId` and `itemId.` These can be collected from the MS Graph API. The `contentUrl` and `displayName` are used only for user convenience. The folder will be con.
webex_put_room_tabs_by_idWRITEUpdates the content URL of the specified Room Tab ID.
webex_put_rooms_by_roomidWRITEUpdates details for a room, by ID. Specify the room ID in the `roomId` parameter in the URI. A space can only be put into announcement mode when it is locked. Any space participant or compliance officer can convert a space from public to private. Only a compliance officer can convert a space from p.
webex_put_team_memberships_by_membershipidWRITEUpdates a team membership, by ID. Specify the team membership ID in the `membershipId` URI parameter.
webex_put_teams_by_teamidWRITEUpdates details for a team, by ID. Specify the team ID in the `teamId` parameter in the URI.
webex_put_webhooks_by_webhookidWRITEUpdates a webhook, by ID. You cannot use this call to deactivate a webhook, only to activate a webhook that was auto deactivated. The fields that can be updated are `name`, `targetURL`, `secret` and `status`. All other fields, if supplied, are ignored. Specify the webhook ID in the `webhookId` para.
Often connected alongside
Put Webex behind one governed endpoint.
Same permissions, same audit trail, whatever else you connect next.