Send WhatsApp Template Message

Use this endpoint to send an already-approved WhatsApp template to one or more recipients. Templates must first be created and approved via the Create Template API.

Endpoint

POST /send_sms

Headers

string

required

API key for the sending WhatsApp number’s TUC.

string

required

application/json

Request body

array

required

Wrapper array for one or more WhatsApp message objects (batch send).

string

required

Always "whatsapp".

string

required

Always "individual".

array

required

Recipient phone number(s), without country prefix (prefix supplied separately via the root-level prefix field).

string

required

Sender’s registered WhatsApp number. A pool ID can also be passed here.

string

required

Always "template".

string

required

Name of the approved WhatsApp template.

string

required

Template language code, e.g. en_US.

array

required

Defines all template components to fill in at send time (header, body, button parameters). Shape depends on template type — see the tabs below.

string

Optional custom reference field, echoed back in delivery callbacks. custref1–custref5 are all supported.

string

Country prefix applied to all recipients, e.g. +91.

string

Optional campaign label for reporting.

integer

Time-to-live in seconds for the message send. Default 600.

object

Optional URL-shortening configuration for links in the message body.

Show urlShortener

integer

required

Set to 1 to enable URL shortening.

array

required

Array of URLs to shorten.

Show urlDetails[]

string

required

The full URL to shorten. Mandatory when flag is 1.

string

Optional custom short-link domain.

integer

Optional flag (1) to enable per-user click tracking.

cURL

curl --location 'https://api.onexaura.com/send_sms' \
--header 'Content-Type: application/json' \
--header 'apikey: YOUR_API_KEY' \
--data '{
  "wa": [
    {
      "messaging_product": "whatsapp",
      "recipient": ["919999999999"],
      "sender": "919888888888",
      "type": "template",
      "template": {
        "name": "onextel_warcs",
        "language": { "code": "en_US" }
      }
    }
  ],
  "prefix": "+91"
}'

Response

[
  {
    "messageId": "35NIvS1Ry8m1RWUylXbgESEOqRi",
    "code": 200,
    "status": "success",
    "recipient": "919999999999",
    "sender": "919888888888",
    "custref1": "custref1",
    "custref2": "custref2",
    "custref3": "",
    "custref4": "",
    "custref5": ""
  }
]

The response is an array with one entry per recipient. Which fields appear depends on the fields enabled for your TUC.

string

Unique message ID assigned by the platform. Use with the Status Check API to track delivery.

integer

Status code. 200 on successful submission.

string

"success" on successful submission.

string

Recipient phone number (only present if enabled for your TUC).

string

Sender WhatsApp number (only present if enabled for your TUC).

string

Echoed custom reference field 1–5, if supplied on the request and enabled for your TUC.

Send payload variants

Media / Variable / Button
Authentication (OTP)
Limited Time Offer
Media Card Carousel

General-purpose template send with an image header, a body text variable, a quick-reply button, and a URL button.

{
  "wa": [
    {
      "messaging_product": "whatsapp",
      "recipient_type": "individual",
      "recipient": ["919999999999", "919888888888"],
      "sender": "919777777777",
      "type": "template",
      "template": {
        "name": "utility_image_with_params",
        "language": { "code": "en_US" },
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "image",
                "image": { "link": "https://example.com/banner.jpg" }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              { "type": "text", "text": "Rahul" }
            ]
          },
          {
            "type": "button",
            "sub_type": "quick_reply",
            "index": 0,
            "parameters": [
              { "type": "payload", "payload": "confirm_order" }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": 1,
            "parameters": [
              { "type": "text", "text": "order-123" }
            ]
          }
        ]
      }
    }
  ],
  "prefix": "+91",
  "campaignName": "diwali_promo",
  "urlShortener": {
    "flag": 1,
    "urlDetails": [
      { "longUrl": "https://example.com/order/123", "domain": "short.ly", "track_user": 1 }
    ]
  }
}

Header image parameters accept either "link" (remote URL) or "id" (media ID from Media Upload). The header type can be text, image, video, document, or location. The button index is the zero-based position of that button within the template’s BUTTONS array — a quick_reply sub-type must match a QUICK_REPLY button at that index, and a url sub-type must match a URL button.

Sends a Zero Tap / One Tap / Copy Code authentication template. All three OTP variants share the same send-time payload shape — only the template’s own button configuration (set at template-creation time) differs.

string

body component carries the OTP code as a text parameter; button component (sub_type: "url") carries the same code appended to the button’s OTP URL.

{
  "wa": [
    {
      "messaging_product": "whatsapp",
      "recipient": ["919999999999"],
      "sender": "919888888888",
      "recipient_type": "individual",
      "type": "template",
      "template": {
        "name": "zero_tap_authentication_temp_3",
        "language": { "code": "en_US" },
        "components": [
          {
            "type": "body",
            "parameters": [
              { "type": "text", "text": "123490" }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": "0",
            "parameters": [
              { "type": "text", "text": "1234567890" }
            ]
          }
        ]
      }
    }
  ],
  "prefix": "+91"
}

Endpoint for Authentication sends: POST /send_sms.

Sends an LTO template with an image/video header, an expiration timestamp, a copy-code button, and a URL button.

string

required

Includes a limited_time_offer component in addition to header, body, and button.

integer

required

UNIX timestamp in milliseconds marking when the offer expires.

string

copy_code for the coupon button (parameters[].type: "coupon_code"), url for the shop-now button.

{
  "wa": [
    {
      "messaging_product": "whatsapp",
      "recipient": ["919999999999"],
      "sender": "919888888888",
      "recipient_type": "individual",
      "type": "template",
      "template": {
        "name": "lto_03",
        "language": { "code": "en_US" },
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "image",
                "image": { "url": "https://example.com/offer-image.jpg" }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              { "type": "text", "text": "Priya" }
            ]
          },
          {
            "type": "limited_time_offer",
            "parameters": [
              {
                "type": "limited_time_offer",
                "limited_time_offer": {
                  "expiration_time_ms": 1767225600000
                }
              }
            ]
          },
          {
            "type": "button",
            "sub_type": "copy_code",
            "index": 0,
            "parameters": [
              { "type": "coupon_code", "coupon_code": "SAVE25" }
            ]
          },
          {
            "type": "button",
            "sub_type": "url",
            "index": 1,
            "parameters": [
              { "type": "text", "text": "https://example.com/shop?offer=SAVE25" }
            ]
          }
        ]
      }
    }
  ],
  "prefix": "+91",
  "campaignName": "lto_campaign",
  "urlShortener": {
    "flag": 1,
    "urlDetails": [
      { "longUrl": "https://example.com/shop?offer=SAVE25", "domain": "short.ly", "track_user": 1 }
    ]
  }
}

Sends a carousel template. The top-level body component can carry multiple text parameters; each card in the carousel array is addressed by card_index and carries its own header, body, and button parameters.

string

required

Top level: body and carousel. Within each card: header, body, button.

integer

required

Zero-based index identifying which carousel card these parameters apply to.

{
  "wa": [
    {
      "messaging_product": "whatsapp",
      "recipient": ["919999999999"],
      "sender": "919888888888",
      "recipient_type": "individual",
      "type": "template",
      "template": {
        "name": "carousel_marketing_01",
        "language": { "code": "en_US" },
        "components": [
          {
            "type": "body",
            "parameters": [
              { "type": "text", "text": "Rahul" },
              { "type": "text", "text": "20%" }
            ]
          },
          {
            "type": "carousel",
            "cards": [
              {
                "card_index": 0,
                "components": [
                  {
                    "type": "header",
                    "parameters": [
                      {
                        "type": "image",
                        "image": { "url": "https://example.com/card1.jpg" }
                      }
                    ]
                  },
                  {
                    "type": "body",
                    "parameters": [
                      { "type": "text", "text": "Product A" }
                    ]
                  },
                  {
                    "type": "button",
                    "sub_type": "quick_reply",
                    "index": 0,
                    "parameters": [
                      { "type": "payload", "payload": "product_a" }
                    ]
                  },
                  {
                    "type": "button",
                    "sub_type": "url",
                    "index": 1,
                    "parameters": [
                      { "type": "text", "text": "product-a" }
                    ]
                  }
                ]
              }
              // Additional cards follow the same structure, each with its own card_index
            ]
          }
        ]
      }
    }
  ],
  "prefix": "+91",
  "campaignName": "carousel_campaign",
  "urlShortener": {
    "flag": 1,
    "urlDetails": [
      { "longUrl": "https://example.com/product/a", "domain": "short.ly", "track_user": 1 }
    ]
  }
}

Create WhatsApp Template — create and get a template approved before sending it.
Fetch WhatsApp Templates — confirm a template’s approval status.
Media — upload media to obtain a media_id for header parameters.

WhatsApp

RCS

SMS (India)

SMS (International)

OmniChannel

Verify

Send WhatsApp Template Message

Endpoint

Headers

Request body

cURL

Response

Send payload variants

​Endpoint

​Headers

​Request body

​cURL

​Response

​Send payload variants

​Related

Endpoint

Headers

Request body

cURL

Response

Send payload variants

Related