OmniMessageListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clickatell/main/json-schema/clickatell-omni-message-list-response-schema.json",
  "title": "OmniMessageListResponse",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clickatell-one-api-openapi.json#/components/schemas/OmniMessageListResponse",
  "type": "object",
  "properties": {
    "messages": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OmniMessagesResponse"
      }
    },
    "error": {
      "$ref": "#/$defs/OmniResponseError"
    },
    "type": {
      "type": "string",
      "writeOnly": true,
      "enum": [
        "SUCCESS",
        "MIXED",
        "FAIL"
      ]
    }
  },
  "$defs": {
    "OmniMessagesResponse": {
      "type": "object",
      "properties": {
        "error": {
          "$ref": "#/$defs/OmniResponseError"
        },
        "apiMessageId": {
          "type": "string",
          "description": "System defined message ID."
        },
        "accepted": {
          "type": "boolean",
          "description": "Indication if the message has passed API validation"
        },
        "to": {
          "type": "string",
          "description": "Recipient of the message, echoed back exactly as submitted. For WhatsApp this is a BSUID if a BSUID was submitted."
        },
        "clientMessageId": {
          "type": "string",
          "description": "Customer defined message ID for tracking purposes."
        }
      }
    },
    "OmniResponseError": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "description": "<i>Error Code</i> value in ",
          "format": "int32"
        },
        "description": {
          "type": "string",
          "description": "<i>Error Message</i>"
        }
      }
    }
  }
}