Webex · Schema

GatewayTimeoutError

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
code integer HTTP status code for Gateway Timeout.
message string A detailed error message explaining the timeout.
trackingId string A unique identifier for this error that can be used for debugging purposes.
details object Additional details about the timeout.
View JSON Schema on GitHub

JSON Schema

webex-gatewaytimeouterror-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GatewayTimeoutError",
  "title": "GatewayTimeoutError",
  "type": "object",
  "required": [
    "code",
    "message"
  ],
  "properties": {
    "code": {
      "type": "integer",
      "enum": [
        504
      ],
      "description": "HTTP status code for Gateway Timeout.",
      "example": 504
    },
    "message": {
      "type": "string",
      "description": "A detailed error message explaining the timeout.",
      "example": "The server did not receive a timely response from an upstream server."
    },
    "trackingId": {
      "type": "string",
      "description": "A unique identifier for this error that can be used for debugging purposes.",
      "example": "WXC-12345-67899"
    },
    "details": {
      "type": "object",
      "description": "Additional details about the timeout.",
      "properties": {
        "timeoutDuration": {
          "type": "integer",
          "description": "The timeout duration in seconds",
          "example": 30
        },
        "upstreamService": {
          "type": "string",
          "description": "The upstream service that timed out",
          "example": "dnc-database"
        },
        "retryRecommended": {
          "type": "boolean",
          "description": "Whether retrying the request is recommended",
          "example": true
        }
      }
    }
  },
  "example": {
    "code": 504,
    "message": "The server did not receive a timely response from an upstream server.",
    "trackingId": "WXC-12345-67899",
    "details": {
      "timeoutDuration": 30,
      "upstreamService": "dnc-database",
      "retryRecommended": true
    }
  }
}