messagebird · Schema

WhatsAppMessageSend

Properties

Name Type Description
to string The recipient WhatsApp phone number in international format.
from string The WhatsApp channel identifier to send from.
type string The type of WhatsApp message content.
content object
reportUrl string The URL for delivery and read receipt callbacks.
View JSON Schema on GitHub

JSON Schema

messagebird-whatsappmessagesend-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WhatsAppMessageSend",
  "title": "WhatsAppMessageSend",
  "type": "object",
  "required": [
    "to",
    "from",
    "type",
    "content"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "The recipient WhatsApp phone number in international format."
    },
    "from": {
      "type": "string",
      "description": "The WhatsApp channel identifier to send from."
    },
    "type": {
      "type": "string",
      "description": "The type of WhatsApp message content.",
      "enum": [
        "text",
        "image",
        "video",
        "audio",
        "file",
        "location",
        "hsm",
        "interactive"
      ]
    },
    "content": {
      "$ref": "#/components/schemas/WhatsAppContent"
    },
    "reportUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL for delivery and read receipt callbacks."
    }
  }
}