Webex · Schema

Error

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
message string Human-readable error message
trackingId string Unique identifier for tracking this error
errors array Detailed list of validation errors
View JSON Schema on GitHub

JSON Schema

webex-error-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Error",
  "title": "Error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Human-readable error message",
      "example": "Invalid client credentials"
    },
    "trackingId": {
      "type": "string",
      "description": "Unique identifier for tracking this error",
      "example": "ROUTER_1234567890ABCDEF"
    },
    "errors": {
      "type": "array",
      "description": "Detailed list of validation errors",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "Description of the specific error",
            "example": "clientSecret is required"
          }
        }
      },
      "example": [
        {
          "description": "clientSecret is required"
        }
      ]
    }
  },
  "example": {
    "message": "Invalid client credentials",
    "trackingId": "ROUTER_1234567890ABCDEF",
    "errors": [
      {
        "description": "The provided clientSecret is invalid"
      }
    ]
  }
}