string
required
Endpoint
POST /send_sms
string
required
API key generated for the TUC (tenant under customer) associated with the sending
WhatsApp number.
Common request structure
Every message is wrapped in awa array. Each object in the array shares these
top-level fields regardless of message type:
array
required
Wrapper array for one or more WhatsApp message objects.
string
required
Always
"whatsapp".string
required
Always
"individual".string
required
Recipient’s WhatsApp phone number.
string
required
Sender’s registered WhatsApp number.
string
required
Message type — one of
text, document / image / video / audio / sticker,
interactive, or contacts. See the tabs below for the value per message type.string
Optional country prefix (e.g.
+91), set at the root of the request body alongside wa.- Text
- Media
- Address
- Contact
- URL Button
- List
- Media Carousel
- Reply
Sends a plain text message, optionally with link preview.
string
required
Message text.
boolean
Optional. Set
true to render a link preview for URLs in the body text.Request
{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "text",
"text": {
"body": "xx",
"preview_url": true
}
}
]
}
cURL
curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "text",
"text": {
"body": "xx",
"preview_url": true
}
}
]
}'
Sends a standalone media message.
type can be image, video, document, audio,
or sticker — pass the media object under the matching key name.string
Optional. Only valid for
image, video, and document types.string
Optional. Only valid for
document type.boolean
Optional. Only valid for
audio type — set true to send as a voice message.Request
{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "document",
"document": {
"link": "xx",
"caption": "xx"
}
}
]
}
cURL
curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "document",
"document": {
"link": "xx",
"caption": "xx"
}
}
]
}'
type can also be image, video, audio, or sticker — replace the document key
with the matching type name (e.g. "type": "image", "image": { "link": "xx" }).Sends an interactive address-collection message (India-specific address form).
string
required
Always
"address_message".Body text shown above the address form.
string
required
Always
"address_message".string
required
Country code, e.g.
"IN".array
Optional. Previously saved addresses associated with the user. Each entry has an
id
and a value object (name, phone_number, in_pin_code, house_number,
floor_number, tower_number, building_name, address, landmark_area, city,
state) — all fields optional.object
Optional. Prefills address fields (e.g. prefilling city with
"India"). Same field set
as saved_addresses.value, all optional.object
Optional. Raises validation errors on specific address fields; WhatsApp blocks submission
until resolved. Same field set as
values, all optional.Request
{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "address_message",
"body": {
"text": "xx"
},
"action": {
"name": "address_message",
"parameters": {
"country": "IN"
}
}
}
}
]
}
cURL
curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "address_message",
"body": {
"text": "xx"
},
"action": {
"name": "address_message",
"parameters": {
"country": "IN"
}
}
}
}
]
}'
Sends one or more vCard-style contact cards.
array
required
Array of contact objects. All fields inside each contact object are optional.
array
Address entries:
street, city, state, zip, country, country_code, type.string
Contact’s birthday.
array
Email entries:
email, type.object
formatted_name, first_name, last_name, middle_name, suffix, prefix.object
company, department, title.array
Phone entries:
phone, type, wa_id.array
URL entries:
url, type.Request
{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "contacts",
"contacts": [
{
"addresses": [
{
"street": "xx",
"city": "xx",
"state": "xx",
"zip": "xx",
"country": "xx",
"country_code": "xx",
"type": "xx"
}
],
"birthday": "xx",
"emails": [
{
"email": "xx",
"type": "xx"
}
],
"name": {
"formatted_name": "xx",
"first_name": "xx",
"last_name": "xx",
"middle_name": "xx",
"suffix": "xx",
"prefix": "xx"
},
"org": {
"company": "xx",
"department": "xx",
"title": "xx"
},
"phones": [
{
"phone": "xx",
"type": "xx",
"wa_id": "xx"
}
],
"urls": [
{
"url": "xx",
"type": "xx"
}
]
}
]
}
]
}
cURL
curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "contacts",
"contacts": [
{
"name": {
"formatted_name": "xx",
"first_name": "xx"
},
"phones": [
{
"phone": "xx",
"type": "xx",
"wa_id": "xx"
}
]
}
]
}
]
}'
Sends an interactive message with a single call-to-action URL button (
cta_url).string
required
Always
"cta_url".string
Optional.
image, video, or document. Pass the media object under the matching key
name. For a text header, pass a text parameter with a string value instead.string
required
Body text.
string
Optional footer text.
string
required
Always
"cta_url".string
required
Label shown on the button.
string
required
Destination URL.
Request
{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "cta_url",
"header": {
"type": "image",
"image": {
"link": "xx"
}
}
},
"body": {
"text": "xx"
},
"footer": {
"text": "xx"
},
"action": {
"name": "cta_url",
"parameters": {
"display_text": "xx",
"url": "xx"
}
}
}
]
}
cURL
curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "cta_url",
"header": {
"type": "image",
"image": {
"link": "xx"
}
}
},
"body": {
"text": "xx"
},
"footer": {
"text": "xx"
},
"action": {
"name": "cta_url",
"parameters": {
"display_text": "xx",
"url": "xx"
}
}
}
]
}'
Sends an interactive list message with sections of selectable rows.
string
required
Always
"list".string
Optional. Set to
"text" with a text string field.string
required
Body text.
string
Optional footer text.
string
required
Label for the button that opens the list.
array
required
Array of section objects, each with a
title and rows.object
required
Each row has
id, title, and description.Request
{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "list",
"header": {
"type": "text",
"text": "xx"
},
"body": {
"text": "xx"
},
"footer": {
"text": "xx"
},
"action": {
"button": "xx",
"sections": [
{
"title": "xx",
"rows": [
{
"id": "xx",
"title": "xx",
"description": "xx"
}
]
}
]
}
}
}
]
}
cURL
curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "list",
"header": {
"type": "text",
"text": "xx"
},
"body": {
"text": "xx"
},
"footer": {
"text": "xx"
},
"action": {
"button": "xx",
"sections": [
{
"title": "xx",
"rows": [
{
"id": "xx",
"title": "xx",
"description": "xx"
}
]
}
]
}
}
}
]
}'
Sends an interactive carousel of 2–10 cards, each with a media header and either a URL
button or quick-reply buttons.
string
required
Always
"carousel".string
required
Body text shown above the carousel.
array
required
Array of 2–10 card objects.
string
required
Zero-based card position.
string
required
"cta_url" when the card uses a URL button.string
required
Cards must use an
image or video header — no other header types are supported.
Pass the media object under the matching key name.string
required
Card body text.
string
"cta_url" — only when using a URL button.object
display_text and url — only when using a URL button.array
One or more quick-reply buttons — only when not using a URL button. Each entry:
type: "quick_reply", quick_reply: { id, title }.All cards in a carousel must use the same button configuration: either every card has
one URL button, or every card has the same number of quick-reply buttons.
Request
{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "carousel",
"body": {
"text": "xx"
},
"action": {
"cards": [
{
"card_index": "0",
"type": "cta_url",
"header": {
"type": "image",
"image": {
"link": "xx"
}
},
"body": {
"text": "xx"
},
"action": {
"name": "cta_url",
"parameters": {
"display_text": "xx",
"url": "xx"
}
}
}
]
}
}
}
]
}
cURL
curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "carousel",
"body": {
"text": "xx"
},
"action": {
"cards": [
{
"card_index": "0",
"type": "cta_url",
"header": {
"type": "image",
"image": {
"link": "xx"
}
},
"body": {
"text": "xx"
},
"action": {
"name": "cta_url",
"parameters": {
"display_text": "xx",
"url": "xx"
}
}
}
]
}
}
}
]
}'
Sends an interactive message with up to 3 quick-reply buttons.
string
required
Always
"button".string
Optional.
text, image, video, or document. Pass the media object under the
matching key name, or a text string for a text header.string
required
Body text.
string
Optional footer text.
array
required
Up to 3 button objects:
type: "reply", reply: { id, title }.Request
{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "button",
"header": {
"type": "image",
"image": {
"link": "xx"
}
},
"body": {
"text": "xx"
},
"footer": {
"text": "xx"
},
"action": {
"buttons": [
{
"type": "reply",
"reply": {
"id": "xx",
"title": "xx"
}
}
]
}
}
}
]
}
cURL
curl --location 'https://api.onexaura.com/send_sms' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wa": [
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"recipient": "919999999999",
"sender": "919888888888",
"type": "interactive",
"interactive": {
"type": "button",
"header": {
"type": "image",
"image": {
"link": "xx"
}
},
"body": {
"text": "xx"
},
"footer": {
"text": "xx"
},
"action": {
"buttons": [
{
"type": "reply",
"reply": {
"id": "xx",
"title": "xx"
}
}
]
}
}
}
]
}'
To send approved template messages instead, see
Send Template Message.