WhatsApp · JSON Structure

Whatsapp Cloud Api Interactive Message Structure

InteractiveMessage from WhatsApp API

Type: object Properties: 5 Required: 2

InteractiveMessage is a JSON Structure definition published by WhatsApp, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type header body footer action

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/whatsapp/refs/heads/main/json-structure/whatsapp-cloud-api-interactive-message-structure.json",
  "name": "InteractiveMessage",
  "description": "InteractiveMessage from WhatsApp API",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "button",
        "list",
        "product",
        "product_list",
        "cta_url",
        "location_request_message",
        "flow"
      ],
      "example": "button"
    },
    "header": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "text",
            "image",
            "video",
            "document"
          ]
        },
        "text": {
          "type": "string"
        },
        "image": {
          "$ref": "#/components/schemas/MediaObject"
        },
        "video": {
          "$ref": "#/components/schemas/MediaObject"
        },
        "document": {
          "$ref": "#/components/schemas/DocumentObject"
        }
      }
    },
    "body": {
      "type": "object",
      "required": [
        "text"
      ],
      "properties": {
        "text": {
          "type": "string",
          "maxLength": 1024
        }
      }
    },
    "footer": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "maxLength": 60
        }
      }
    },
    "action": {
      "type": "object",
      "description": "Action configuration varies by interactive type",
      "properties": {
        "buttons": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "reply"
                ]
              },
              "reply": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "maxLength": 256
                  },
                  "title": {
                    "type": "string",
                    "maxLength": 20
                  }
                }
              }
            }
          }
        },
        "button": {
          "type": "string",
          "description": "Button text for list messages",
          "maxLength": 20
        },
        "sections": {
          "type": "array",
          "maxItems": 10,
          "items": {
            "$ref": "#/components/schemas/ListSection"
          }
        },
        "catalog_id": {
          "type": "string"
        },
        "product_retailer_id": {
          "type": "string"
        },
        "name": {
          "type": "string",
          "description": "Action name for CTA URL or flow messages"
        },
        "parameters": {
          "type": "object",
          "description": "Parameters for CTA URL or flow actions"
        }
      }
    }
  },
  "required": [
    "type",
    "action"
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this

find_json_structuresBrowse and filter every JSON Structure in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Structure

curl "https://apis.io/api/v1/json-structures/whatsapp-cloud-api-interactive-message-structure"

All json structure

curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.