DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationAccess the APIREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsUsing Webex Service Apps
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo Mesh
GETList Clusters Availability
GETGet Cluster Availability
GETList Node Availability
GETGet Node Availability
GETList Media Health Monitoring Tool results
GETList Media Health Monitoring Tool Test results V2
GETGet Media Health Monitoring Tool Cluster results
GETGet Media Health Monitoring Tool Test results for clusters V2
GETGet Media Health Monitoring Tool Node results
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
GETList Reachability Test results V2
GETGet Reachability Test results for Cluster
GETGet Reachability Test results for cluster V2
GETGet Reachability Test results for Node
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
Webex Calling Detailed Call HistoryWebex Calling Device SettingsWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWebex Calling Device SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksUsing Webex Service AppsWebinar 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 results
GETList Media Health Monitoring Tool Test results V2
GETGet Media Health Monitoring Tool Cluster results
GETGet Media Health Monitoring Tool Test results for clusters V2
GETGet Media Health Monitoring Tool Node results
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
GETList Reachability Test results V2
GETGet Reachability Test results for Cluster
GETGet Reachability Test results for cluster V2
GETGet Reachability Test results for Node
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
Webhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and CardsUsing Webex Service Apps
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo Mesh
GETList Clusters Availability
GETGet Cluster Availability
GETList Node Availability
GETGet Node Availability
GETList Media Health Monitoring Tool results
GETList Media Health Monitoring Tool Test results V2
GETGet Media Health Monitoring Tool Cluster results
GETGet Media Health Monitoring Tool Test results for clusters V2
GETGet Media Health Monitoring Tool Node results
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
GETList Reachability Test results V2
GETGet Reachability Test results for Cluster
GETGet Reachability Test results for cluster V2
GETGet Reachability Test results for Node
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
Webex Calling Detailed Call HistoryWebex Calling Device SettingsWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
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) from the Developer Portal or their own monitoring application, which can help in quickly isolating and identifying root cause of issues which affect 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/mediaHealthMonitor
List Media Health Monitoring Tool results
https://webexapis.com/v1/videoMesh/mediaHealthMonitor
GETList Media Health Monitoring Tool results
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/mediaHealthMonitor/clusters
Get Media Health Monitoring Tool Cluster results
https://webexapis.com/v1/videoMesh/mediaHealthMonitor/clusters
GETGet Media Health Monitoring Tool Cluster results
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/mediaHealthMonitor/nodes
Get Media Health Monitoring Tool Node results
https://webexapis.com/v1/videoMesh/mediaHealthMonitor/nodes
GETGet Media Health Monitoring Tool Node results
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/reachabilityTest
List Reachability Test results
https://webexapis.com/v1/videoMesh/reachabilityTest
GETList Reachability Test results
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/reachabilityTest/clusters
Get Reachability Test results for Cluster
https://webexapis.com/v1/videoMesh/reachabilityTest/clusters
GETGet Reachability Test results for Cluster
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/reachabilityTest/nodes
Get Reachability Test results for Node
https://webexapis.com/v1/videoMesh/reachabilityTest/nodes
GETGet Reachability Test results for Node
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

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

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