Send a message

Send a message to a recipient via SMS or WhatsApp.

Channel selection:

• If channel is omitted and messageType is text, defaults to SMS
• If messageType is anything other than text, WhatsApp is used automatically

WhatsApp 24-hour window:

• Free-form messages (non-template) require an open 24h window
• Window opens when the user messages you first
• Use template messages to initiate conversations outside the window

Daily limits:

• Unverified accounts: 200 messages per channel per day
• Complete KYC verification to increase limits to 10,000/day

POST /v1/messages

cURL

sms

curl --request POST \
  --url https://api.zavu.dev/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "[phone]",
  "text": "Your verification code is 123456"
}
'

202

Example

{
  "message": {
    "id": "jd7x2k3m4n5p6q7r8s9t0",
    "to": "[phone]",
    "createdAt": "2023-11-07T05:31:56Z",
    "from": "[phone]",
    "senderId": "sender_12345",
    "text": "<string>",
    "content": {
      "mediaUrl": "https://example.com/image.jpg",
      "mediaId": "<string>",
      "mimeType": "image/jpeg",
      "filename": "invoice.pdf",
      "latitude": 123,
      "longitude": 123,
      "locationName": "<string>",
      "locationAddress": "<string>",
      "contacts": [
        {
          "name": "<string>",
          "phones": [
            "<string>"
          ]
        }
      ],
      "buttons": [
        {
          "id": "<string>",
          "title": "<string>"
        }
      ],
      "listButton": "<string>",
      "sections": [
        {
          "title": "<string>",
          "rows": [
            {
              "id": "<string>",
              "title": "<string>",
              "description": "<string>"
            }
          ]
        }
      ],
      "ctaDisplayText": "See Dates",
      "ctaUrl": "https://example.com/schedule",
      "ctaHeaderText": "<string>",
      "ctaHeaderMediaUrl": "<string>",
      "footerText": "Dates subject to change.",
      "emoji": "<string>",
      "reactToMessageId": "<string>",
      "templateId": "<string>",
      "templateVariables": {
        "1": "John",
        "2": "ORD-12345"
      },
      "templateButtonVariables": {
        "0": "abc-report-token"
      },
      "templateHeaderVariables": {
        "1": "Jorge y Laura"
      }
    },
    "providerMessageId": "<string>",
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "cost": 123,
    "costProvider": 123,
    "costTotal": 123,
    "metadata": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Zavu-Sender · string

Optional sender profile ID. If omitted, the project's default sender will be used.

Example:

"sender_12345"

Body

application/json

Request body to send a message.

to · string · required

Recipient phone number in E.164 format, email address, or numeric chat ID (for Telegram/Instagram).

Example:

"[phone]"

channel · enum<string> · default: auto

Delivery channel. Use 'auto' for intelligent routing. If omitted, channel is auto-selected based on sender capabilities and recipient type. For email recipients, defaults to 'email'.

Available options: auto, sms, sms_oneway, whatsapp, telegram, email, instagram, voice

messageType · enum<string> · default: text

Type of message. Defaults to 'text'.

Available options: text, image, video, audio, document, sticker, location, contact, buttons, list, cta_url, reaction, template

text · string

Text body for text messages or caption for media messages.

Example:

"Your verification code is 123456."

content · object

Additional content for non-text message types.

Show child attributes

subject · string

Email subject line. Required when channel is 'email' or recipient is an email address.

Maximum string length: 998

Example:

"Your order confirmation"

htmlBody · string

HTML body for email messages. If provided, email will be sent as multipart with both text and HTML.

replyTo · string<email>

Reply-To email address for email messages.

Example:

"[e-mail]"

idempotencyKey · string

Optional idempotency key to avoid duplicate sends.

Example:

"msg_01HZY4ZP7VQY2J3BRW7Z6G0QGE"

metadata · object

Arbitrary metadata to associate with the message.

Show child attributes

fallbackEnabled · boolean · default: true

Whether to enable automatic fallback to SMS if WhatsApp fails. Defaults to true.

voiceLanguage · string

Language code for voice text-to-speech (e.g., 'en-US', 'es-ES', 'pt-BR'). If omitted, language is auto-detected from recipient's country code.

Example:

"es-ES"

attachments · object[]

Email attachments. Only supported when channel is 'email'. Maximum 40MB total size.

Maximum array length: 50

Show child attributes

Response

202

application/json

Message accepted for delivery.

message · object · required

Show child attributes