DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
What's NewOverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsService App GuestsService Apps G2GGuest IssuerWidgetsWebex ConnectLogin with WebexInstant ConnectInstant Connect Meeting LinksDeveloper SandboxBeta ProgramSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsCompliance
Webex APIs
Reference
Data Sources
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksBYODSService Apps G2GReal-time File DLP BasicsProvisioning APIsBackground ImagesAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSettingsSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and AuthorizationMetadata and Samples
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsMetadata and SamplesBackground Images
Reference
Call ControlsCall RoutingCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsDevice Call SettingsDevicesEmergency Services SettingsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPSTNPeopleRecording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for Wholesale
Overview
Guides
Developer's Guide
Reference
Wholesale Billing ReportsWholesale Provisioning
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Reference
Data Sources
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Directory Services
Reference
Identity Organization
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksBYODSService Apps G2GWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo Mesh
GETList Clusters Availability
GETGet Cluster Availability
GETList Node Availability
GETGet Node Availability
GETList Media Health Monitoring Tool Test results V2
GETGet Media Health Monitoring Tool Test results for clusters V2
GETGet Media Health Monitoring Tool Test results for node V2
GETList Overflow to Cloud details
GETList Cluster Redirect details
GETGet Cluster Redirect details
GETList Clusters Utilization
GETGet Cluster Utilization details
GETList Reachability Test results V2
GETGet Reachability Test results for cluster V2
GETGet Reachability Test results for node V2
GETList Cluster Details
GETGet Cluster Details
POSTTrigger on-demand test for cluster
POSTTrigger on-demand test for node
GETGet Triggered test status
GETGet Triggered test results
GETList Network Test results
GETGet Network Test results for cluster
GETGet Network Test results for node
GETList Cluster Client Type Distribution details
GETGet Cluster Client Type Distribution details
GETList Event Threshold Configuration
GETGet Event Threshold Configuration
PATCHUpdate Event Threshold Configuration
POSTReset Event Threshold Configuration
Webhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksBYODSService Apps G2GButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
SCIM 2
Overview
Reference
SCIM 2 BulkSCIM 2 GroupsSCIM 2 Users
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsClient Call SettingsConference ControlsConverged RecordingsDECT Devices SettingsData SourcesDevice Call SettingsDevice ConfigurationsDevicesEmergency Services SettingsEventsFeatures: Announcement PlaylistFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Customer Experience EssentialsFeatures: Hunt GroupFeatures: Paging GroupFeatures: Single Number ReachGroupsGuests ManagementHistorical AnalyticsHybrid ClustersHybrid ConnectorsIdentity OrganizationLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPSTNPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSCIM 2 BulkSCIM 2 GroupsSCIM 2 UsersSecurity Audit EventsSession TypesSettingsSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo Mesh
GETList Clusters Availability
GETGet Cluster Availability
GETList Node Availability
GETGet Node Availability
GETList Media Health Monitoring Tool Test results V2
GETGet Media Health Monitoring Tool Test results for clusters V2
GETGet Media Health Monitoring Tool Test results for node V2
GETList Overflow to Cloud details
GETList Cluster Redirect details
GETGet Cluster Redirect details
GETList Clusters Utilization
GETGet Cluster Utilization details
GETList Reachability Test results V2
GETGet Reachability Test results for cluster V2
GETGet Reachability Test results for node V2
GETList Cluster Details
GETGet Cluster Details
POSTTrigger on-demand test for cluster
POSTTrigger on-demand test for node
GETGet Triggered test status
GETGet Triggered test results
GETList Network Test results
GETGet Network Test results for cluster
GETGet Network Test results for node
GETList Cluster Client Type Distribution details
GETGet Cluster Client Type Distribution details
GETList Event Threshold Configuration
GETGet Event Threshold Configuration
PATCHUpdate Event Threshold Configuration
POSTReset Event Threshold Configuration
Virtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
Space Meetings Migration
Calling
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationCore ConceptsCalls
Advanced Features
Call SettingsContactsSupplementary ServicesVoicemailBackground Noise Reduction
Kitchen Sink
Meetings
Introduction
Platform
Web
IntroductionQuickstart
Basics
AuthorizationJoin a MeetingMigration To Improved MeetingsPasswords & CaptchasUnified Space Meetings
Advanced Features
Advanced ControlsDialing In and OutStreams & EffectsVideo Resolution
Multistream
Multistream Comprehensive GuideMultistream Quickstart
Migrating SDK V2 to V3
iOSAndroidBrowser
Developer CommunityCertifications

Video Mesh

The Video Mesh Developer APIs provide the ability for organization admins to retrieve analytics and monitoring data, trigger on-demand troubleshooting tests (Media Health Monitoring Tool, Network, and Reachability), and getting and setting thresholds for Webhook events from the Developer Portal or their own monitoring applications, which can help in quickly isolating and identifying root cause of issues affecting the normal functioning of a customer's Video Mesh Deployment.


NOTE: The Media Health Monitor Test and Reachability Test can be triggered only on clusters that are not reserved for private meetings.


To obtain the Organization ID needed for these APIs, use the Organizations API

Method
Description
GEThttps://webexapis.com/v1/videoMesh/clusters/availability
List Clusters Availability
https://webexapis.com/v1/videoMesh/clusters/availability
GETList Clusters Availability
GEThttps://webexapis.com/v1/videoMesh/clusters/availability/{clusterId}
Get Cluster Availability
https://webexapis.com/v1/videoMesh/clusters/availability/{clusterId}
GETGet Cluster Availability
GEThttps://webexapis.com/v1/videoMesh/nodes/availability
List Node Availability
https://webexapis.com/v1/videoMesh/nodes/availability
GETList Node Availability
GEThttps://webexapis.com/v1/videoMesh/nodes/availability/{nodeId}
Get Node Availability
https://webexapis.com/v1/videoMesh/nodes/availability/{nodeId}
GETGet Node Availability
GEThttps://webexapis.com/v1/videoMesh/testResults/mediaHealthMonitorTest
List Media Health Monitoring Tool Test results V2
https://webexapis.com/v1/videoMesh/testResults/mediaHealthMonitorTest
GETList Media Health Monitoring Tool Test results V2
GEThttps://webexapis.com/v1/videoMesh/testResults/mediaHealthMonitorTest/clusters
Get Media Health Monitoring Tool Test results for clusters V2
https://webexapis.com/v1/videoMesh/testResults/mediaHealthMonitorTest/clusters
GETGet Media Health Monitoring Tool Test results for clusters V2
GEThttps://webexapis.com/v1/videoMesh/testResults/mediaHealthMonitorTest/nodes
Get Media Health Monitoring Tool Test results for node V2
https://webexapis.com/v1/videoMesh/testResults/mediaHealthMonitorTest/nodes
GETGet Media Health Monitoring Tool Test results for node V2
GEThttps://webexapis.com/v1/videoMesh/cloudOverflow
List Overflow to Cloud details
https://webexapis.com/v1/videoMesh/cloudOverflow
GETList Overflow to Cloud details
GEThttps://webexapis.com/v1/videoMesh/callRedirects
List Cluster Redirect details
https://webexapis.com/v1/videoMesh/callRedirects
GETList Cluster Redirect details
GEThttps://webexapis.com/v1/videoMesh/clusters/callRedirects
Get Cluster Redirect details
https://webexapis.com/v1/videoMesh/clusters/callRedirects
GETGet Cluster Redirect details
GEThttps://webexapis.com/v1/videoMesh/utilization
List Clusters Utilization
https://webexapis.com/v1/videoMesh/utilization
GETList Clusters Utilization
GEThttps://webexapis.com/v1/videoMesh/clusters/utilization
Get Cluster Utilization details
https://webexapis.com/v1/videoMesh/clusters/utilization
GETGet Cluster Utilization details
GEThttps://webexapis.com/v1/videoMesh/testResults/reachabilityTest
List Reachability Test results V2
https://webexapis.com/v1/videoMesh/testResults/reachabilityTest
GETList Reachability Test results V2
GEThttps://webexapis.com/v1/videoMesh/testResults/reachabilityTest/clusters
Get Reachability Test results for cluster V2
https://webexapis.com/v1/videoMesh/testResults/reachabilityTest/clusters
GETGet Reachability Test results for cluster V2
GEThttps://webexapis.com/v1/videoMesh/testResults/reachabilityTest/nodes
Get Reachability Test results for node V2
https://webexapis.com/v1/videoMesh/testResults/reachabilityTest/nodes
GETGet Reachability Test results for node V2
GEThttps://webexapis.com/v1/videoMesh/clusters
List Cluster Details
https://webexapis.com/v1/videoMesh/clusters
GETList Cluster Details
GEThttps://webexapis.com/v1/videoMesh/clusters/{clusterId}
Get Cluster Details
https://webexapis.com/v1/videoMesh/clusters/{clusterId}
GETGet Cluster Details
POSThttps://webexapis.com/v1/videoMesh/triggerTest/clusters/{clusterId}
Trigger on-demand test for cluster
https://webexapis.com/v1/videoMesh/triggerTest/clusters/{clusterId}
POSTTrigger on-demand test for cluster
POSThttps://webexapis.com/v1/videoMesh/triggerTest/nodes/{nodeId}
Trigger on-demand test for node
https://webexapis.com/v1/videoMesh/triggerTest/nodes/{nodeId}
POSTTrigger on-demand test for node
GEThttps://webexapis.com/v1/videoMesh/testStatus
Get Triggered test status
https://webexapis.com/v1/videoMesh/testStatus
GETGet Triggered test status
GEThttps://webexapis.com/v1/videoMesh/testResults
Get Triggered test results
https://webexapis.com/v1/videoMesh/testResults
GETGet Triggered test results
GEThttps://webexapis.com/v1/videoMesh/testResults/networkTest
List Network Test results
https://webexapis.com/v1/videoMesh/testResults/networkTest
GETList Network Test results
GEThttps://webexapis.com/v1/videoMesh/testResults/networkTest/clusters
Get Network Test results for cluster
https://webexapis.com/v1/videoMesh/testResults/networkTest/clusters
GETGet Network Test results for cluster
GEThttps://webexapis.com/v1/videoMesh/testResults/networkTest/nodes
Get Network Test results for node
https://webexapis.com/v1/videoMesh/testResults/networkTest/nodes
GETGet Network Test results for node
GEThttps://webexapis.com/v1/videoMesh/clientTypeDistribution
List Cluster Client Type Distribution details
https://webexapis.com/v1/videoMesh/clientTypeDistribution
GETList Cluster Client Type Distribution details
GEThttps://webexapis.com/v1/videoMesh/clientTypeDistribution/clusters
Get Cluster Client Type Distribution details
https://webexapis.com/v1/videoMesh/clientTypeDistribution/clusters
GETGet Cluster Client Type Distribution details
GEThttps://webexapis.com/v1/videoMesh/eventThresholds
List Event Threshold Configuration
https://webexapis.com/v1/videoMesh/eventThresholds
GETList Event Threshold Configuration
GEThttps://webexapis.com/v1/videoMesh/eventThresholds/{eventThresholdId}
Get Event Threshold Configuration
https://webexapis.com/v1/videoMesh/eventThresholds/{eventThresholdId}
GETGet Event Threshold Configuration
PATCHhttps://webexapis.com/v1/videoMesh/eventThresholds
Update Event Threshold Configuration
https://webexapis.com/v1/videoMesh/eventThresholds
PATCHUpdate Event Threshold Configuration
POSThttps://webexapis.com/v1/videoMesh/eventThresholds/reset
Reset Event Threshold Configuration
https://webexapis.com/v1/videoMesh/eventThresholds/reset
POSTReset Event Threshold Configuration

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2024 Cisco and/or its affiliates. All rights reserved.