DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording 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 Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar 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 Cards
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
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 ReportMembershipsMessagesOrganizationsPeopleRecording 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 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

Get Network Test results for node

Returns 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.

Bandwidth Test - Tests the bandwidth parameters of the Video Mesh node's network. The test is run between the Video Mesh node and cloud services.
DNS Resolution Test - Tests the resolution of IP addresses related to cloud services, against the DNS servers configured on the Video Mesh node's network.
HTTPS Connectivity Test - Tests whether the Video Mesh node is able to connect to cloud services via HTTPS protocol.
Websocket Connectivity Test - Tests whether the Video Mesh node is able to connect to Webex cloud services via Websocket.

GET/v1/videoMesh/testResults/networkTest/nodes
Query Parameters
nodeId
stringrequired

Unique ID of the Video Mesh node.

from
stringrequired

The start date and time of the requested data in any ISO 8601 compliant format. The from parameter cannot have date and time values that exceed to.

to
stringrequired

The end date and time of the requested data in any ISO 8601 compliant format.

triggerType
stringrequired

Trigger type.

Possible values: OnDemand, Periodic, All
Response Properties
orgId
string

Unique ID of the organization.

from
string

Start date and time (inclusive) of the Network Test data.

to
string

End date and time (inclusive) of the Network Test data.

items
array[Connectivity Test Results Clusters Object 3]

Network test results.

clusters
array[Per Cluster Connectivity Result3]

List of Video Mesh clusters.

clusterId
string

Unique ID of the Video Mesh cluster.

clusterName
string

Name of the Video Mesh cluster.

nodes
array[Per Node Connectivity Result1]
nodeId
string

Unique ID of the Video Mesh node.

hostNameOrIP
string

Host name or IP Address of the Video Mesh node.

testResults
array[Connectivity Test Results For Node]
timestamp
string

The timestamp of the test run.

triggerType
string

The type of the test being executed. Can be either OnDemand or Periodic.

id
string

Unique ID of the test.

result
array[DNS Resolution Test]
type
string

The type of test result.

results
array[Service Type Result1]

Test Results from different services.

serviceType
string

Service for which the test was executed.

testResult
string

Result of the test executed.

failureDetails
FailureDetails1
possibleFailureReason
array[string]

Possible reasons for failure for the test.

possibleRemediation
array[string]

Possible fixes for the failures mentioned above.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
GET
/v1/videoMesh/testResults/networkTest/nodes{?nodeId,triggerType,from,to}
Log in to try the API.
Header
Query Parameters
  • Unique ID of the Video Mesh node.
  • The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The `from` parameter cannot have date and time values that exceed `to`.
  • The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
  • Trigger type.
  • Request
  • Response
https://webexapis.com/v1/videoMesh/testResults/networkTest/nodes?nodeId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk&from=2023-01-15T15:53:00Z&to=2023-01-20T15:53:00Z&triggerType=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D
200 / OK
{
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=",
  "from": "2023-01-15T15:53:00Z",
  "to": "2023-01-20T15:53:00Z",
  "items": [
    {
      "clusters": [
        {
          "clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=",
          "clusterName": "shangai",
          "nodes": [
            {
              "nodeId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk",
              "hostNameOrIP": "abc.company.com",
              "testResults": [
                {
                  "timestamp": "2022-03-15T15:53:00Z",
                  "triggerType": "OnDemand",
                  "id": "Y2lzY29zcGFyazovL3VzL0NPTU1BTkRJRC8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY6YWRlODhhNjAtMzk5Mi0xMWVkLTlhYmQtYzUyMjRiZjNjMzQ4",
                  "result": [
                    {
                      "type": "DNSResolutionTest",
                      "results": [
                        {
                          "serviceType": "WebexCloud",
                          "testResult": "Failed",
                          "failureDetails": {
                            "possibleFailureReason": [
                              "DNS Resolution issue detected in the Video Mesh Node [Error Code: 1302]."
                            ],
                            "possibleRemediation": [
                              "Please ensure that the configured DNS Servers are correct and healthy, and verify the network settings are adhering to the Video Mesh Deployment Guide. If the issue persists, please contact Cisco Support."
                            ]
                          }
                        },
                        {
                          "serviceType": "ThirdPartyCloud",
                          "testResult": "Success"
                        }
                      ]
                    },
                    {
                      "type": "WebSocketConnectivityTest",
                      "results": [
                        {
                          "serviceType": "WebexCloud",
                          "testResult": "Success"
                        }
                      ]
                    },
                    {
                      "type": "HTTPConnectivityTest",
                      "results": [
                        {
                          "serviceType": "WebexCloud",
                          "testResult": "Failed",
                          "failureDetails": {
                            "possibleFailureReason": [
                              "Connectivity issue detected between the Video Mesh Node and the Webex Cloud [Error Code: 1106]."
                            ],
                            "possibleRemediation": [
                              "One or more Webex cloud services may not be responding. Retry the test after some time. If the issue persists, please contact Cisco Support."
                            ]
                          }
                        },
                        {
                          "serviceType": "ThirdPartyCloud",
                          "testResult": "Success"
                        }
                      ]
                    },
                    {
                      "type": "BandwidthTest",
                      "results": [
                        {
                          "serviceType": "WebexCloud",
                          "testResult": "Failed",
                          "failureDetails": {
                            "possibleFailureReason": [
                              "Degraded Network Bandwidth speed detected in the Video Mesh Node connectivity to the Webex Cloud [Error Code: 1402,1405]."
                            ],
                            "possibleRemediation": [
                              "Please refer to Video Mesh deployment guide to ensure the network settings are configured correctly, and the minimum internet speed requirements are met. If the issue persists, please contact Cisco Support."
                            ]
                          }
                        },
                        {
                          "serviceType": "ThirdPartyCloud",
                          "testResult": "Success"
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Connect

Support

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.