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
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsLogin with WebexGuest IssuerWidgetsWebex ConnectInstant ConnectDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsUsing Webex Service AppsProvisioning APIsAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and Authorization
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsWebex for Wholesale
Reference
Call ControlsCall RoutingCalling Service SettingsDECT Devices SettingsDevice Call SettingsDevicesFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPeopleRecording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationWholesale and Broadworks Common GuideDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace 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
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 AuthorizationWebhooksUsing Webex Service AppsButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
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 EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsDECT Devices SettingsDevice Call SettingsDevice ConfigurationsDevicesEventsFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocation 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 ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo 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
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
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Get Cluster Redirect details

Returns details of cluster redirects for a single Video Mesh cluster.

GET/v1/videoMesh/clusters/callRedirects
Query Parameters
from
stringrequired

The starting date and time of the requested data in any ISO 8601 compliant format. from cannot be after to.

to
stringrequired

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

clusterId
stringrequired

The unique Video Mesh Cluster ID.

Response Properties
items
array[Redirect Collection For Cluster]
orgId
string

The unique ID for the organization.

from
string

Start date and time (inclusive) for the Call Redirect details.

to
string

End date and time (inclusive) of the Call Redirect details.

aggregationInterval
string

The aggregation period of the trend data.

items
array[RedirectTrendForCluster1]

Redirect details for the organization.

timestamp
string

Timestamp.

clusters
array[ClusterRedirectBlr1]
clusterId
string

ID of the Video Mesh cluster.

clusterName
string

Name of the Video Mesh cluster.

redirectDetails
array[ClusterRedirectDetailsBlr1a]

Call Redirect Details.

redirectReason
string

The reason for the redirect.

redirectCount
number

Number of Call Redirects.

possibleRemediation
string

Any possible remediations for this overflow.

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/clusters/callRedirects{?from,to,clusterId}
Log in to try the API.
Header
Query Parameters
  • The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.
  • The ending date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
  • The unique Video Mesh Cluster ID.
  • Request
  • Response
https://webexapis.com/v1/videoMesh/clusters/callRedirects?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00Z&clusterId=Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI
200 / OK
{
  "items": [
    {
      "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ",
      "from": "2022-03-23T10:22:03Z",
      "to": "2022-03-24T10:22:03Z",
      "aggregationInterval": "10m",
      "items": [
        {
          "timestamp": "2022-03-23T10:30:00Z",
          "clusters": [
            {
              "clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg",
              "clusterName": "bangalore",
              "redirectDetails": [
                {
                  "redirectReason": "Capacity exceeded",
                  "redirectCount": 10,
                  "possibleRemediation": "Video Mesh exceeded its capacity. If this happens frequently, consider adding more nodes to your clusters."
                },
                {
                  "redirectReason": "Connectivity issues",
                  "redirectCount": 78,
                  "possibleRemediation": "Connectivity Issues between Video Mesh Node and Cloud. Check your network configuration."
                }
              ]
            }
          ]
        },
        {
          "timestamp": "2022-03-23T10:40:00Z",
          "clusters": [
            {
              "clusterId": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg",
              "clusterName": "bangalore",
              "redirectDetails": [
                {
                  "redirectReason": "Node upgrading",
                  "redirectCount": 4,
                  "possibleRemediation": "Video Mesh Node is being upgraded. Please wait for upgrades to finish."
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

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.