Bandwidth · Schema

Error

Error schema from Bandwidth messaging API

CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Properties

Name Type Description
type string The error type identifier
description string A human-readable description of the error
fieldErrors array
View JSON Schema on GitHub

JSON Schema

messaging-error-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/messaging-error-schema.json",
  "title": "Error",
  "description": "Error schema from Bandwidth messaging API",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The error type identifier"
    },
    "description": {
      "type": "string",
      "description": "A human-readable description of the error"
    },
    "fieldErrors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "description": "The field that caused the error"
          },
          "description": {
            "type": "string",
            "description": "Description of the field error"
          }
        }
      }
    }
  }
}