Skip to main content
POST

Request Headers

string
required
Bearer token. Format: Bearer nc_live_your_api_key
string
Unique key to prevent duplicate sends. Responses are cached for 24 hours. See Idempotency.

Request Body

string | string[]
required
Recipient WhatsApp number(s) in E.164 format (e.g., +919876543210). Accepts a single string or an array of up to 1,000 numbers for batch sending.
string
required
Message type. One of: text, template, image, document, video, audio, sticker, location, contacts, interactive.

Text Message

object
Required when type is text.

Template Message

object
Required when type is template.

Media Messages

object
Required when type is image. Supports JPEG/PNG, max 5MB.
object
Required when type is document. Supports PDF, DOC, XLS, etc. Max 100MB.
object
Required when type is video. MP4/3GPP, max 16MB.
object
Required when type is audio. AAC/MP4/OGG, max 16MB.
object
Required when type is sticker. WebP format, 512x512px.

Location Message

object
Required when type is location.

Contacts Message

array
Required when type is contacts. Array of contact cards.

Interactive Message

object
Required when type is interactive. Supports buttons, lists, and CTA URLs.

Optional Fields

object
Reply to a specific message. { message_id: "wamid.xxx" }
string
ISO 8601 timestamp for scheduled delivery. Must be in the future, max 7 days ahead.
string
HTTPS URL to receive delivery status webhooks (sent, delivered, read, failed).
string[]
Tags for categorization. Maximum 10 tags.
object
Custom key-value pairs passed through to webhooks.

Response

Single recipient (202 Accepted)

string
Unique identifier for the queued message.
string
"queued" or "scheduled".
string
Normalized E.164 phone number.
string
ISO 8601 timestamp.

Batch (multiple recipients)

array
Array of message objects, one per recipient.