Bandwidth · JSON Structure

Messaging Error Structure

Error schema from Bandwidth messaging API

Type: object Properties: 3
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Error is a JSON Structure definition published by Bandwidth, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type description fieldErrors

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-structure/messaging-error-structure.json",
  "name": "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"
          }
        }
      }
    }
  }
}