Default

Send Message

post

Send a WhatsApp message to a customer. Supports various message types like text, template, media, and interactive messages.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

phone_number_idstringRequired

The Phone Number ID of the sender (WABA phone number ID).

Body

application/json

messaging_productstringOptionalExample: whatsapp

recipient_typestringOptionalExample: individual

tostringOptional

Recipient phone number with country code (no + sign).

typestring · enumOptionalPossible values:

templateobjectOptional

textobjectOptional

imageobjectOptional

audioobjectOptional

videoobjectOptional

documentobjectOptional

stickerobjectOptional

locationobjectOptional

contactsarrayOptional

reactionobjectOptional

interactiveobjectOptional

Responses

200

Successful Response

application/json

post

/{phone_number_id}/messages

HTTPcURLJavaScriptPython

POST /api/partner/v1/{phone_number_id}/messages HTTP/1.1
Host: avianya-backend-51182513424.asia-south1.run.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 356

{
  "messaging_product": "whatsapp",
  "to": "919999999999",
  "type": "template",
  "template": {
    "name": "seasonal_promo_2024",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "image",
            "image": {
              "link": "https://example.com/promo-banner.jpg"
            }
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "User Name"
          },
          {
            "type": "text",
            "text": "50%"
          }
        ]
      }
    ]
  }
}

Marketing Template (Image Header)Utility Template (Order Update)Authentication Template (OTP)Catalog TemplateText MessageReply to Text (Context)Text Message with Preview URLImage MessageDocument MessageAudio MessageVideo MessageSticker MessageList Message (Menu)Reply ButtonsReaction MessageCarousel with URL ButtonsCarousel with Quick RepliesProduct CarouselCatalog MessageSingle Product MessageMulti-Product Message (List)Location MessageContact Message

200

Successful Response

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "[phone]",
      "wa_id": "16505551234"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA"
    }
  ]
}