v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
Message Sending

Send Template Message

Use this endpoint to send WhatsApp template messages (text, media, coupon, carousel, product, order, interactive, LTO).
The request body structure determines the template type. Batching is supported: include up to 100 messages in the message array per request.

Workflow

  1. Confirm user opt-in and template approval.
  2. Build the payload using the appropriate template structure.
  3. Send the request and track delivery via webhooks.
post/v2/message/nc

Request body

Example request

{
  "message": [
    {
      "recipient_type": "individual",
      "recipient_whatsapp": "916267725099",
      "category": "utility",
      "ttl_seconds": 600,
      "source": "source-sample",
      "cta_link_track": "1",
      "retry_enabled": "1",
      "message_type": "limited_time_offer_template",
      "x-apiheader": "netcore_api_header",
      "type_template": [
        {
          "name": "lto_template_image_qa_2_3",
          "attributes": [
            "something",
            "everything",
            "https://www.amazon.com"
          ],
          "language": {
            "locale": "en",
            "policy": "deterministic"
          }
        }
      ],
      "type_media_template": {
        "type": "image",
        "url": "https://cpaas-media-us.s3.us-east-1.amazonaws.com/whatsapp-media-stage/Web%201920%20%E2%80%93%203_20251014130024_1760446824780.jpeg",
        "media_id": "731736671839227",
        "filename": "document.pdf",
        "button": [
          {
            "index": "0",
            "payload": "12345",
            "sub_type": "copy_code"
          }
        ],
        "expiration_time_ms": "1756980336345"
      },
      "type_mpm_template": {
        "thumbnail_product_retailer_id": "J11124551",
        "sections": [
          {
            "title": "Hetvi 1",
            "product_items": [
              {
                "product_retailer_id": "JVS1204476"
              }
            ]
          }
        ]
      },
      "type_spm_template": {
        "product": {
          "product_retailer_id": "33398614556808",
          "catalog_id": "1139381570069099"
        },
        "button": [
          {
            "sub_type": "copy_code",
            "payload": "12345",
            "index": "0"
          }
        ]
      },
      "type_product_card_carousel": {
        "cards": [
          {
            "card_index": "0",
            "product_retailer_id": "1139381570069099",
            "catalog_id": "33398614556808",
            "button": [
              {
                "sub_type": "copy_code",
                "payload": "12345",
                "index": "0"
              }
            ]
          }
        ]
      },
      "type_carousel_template": {
        "cards": [
          {
            "card_index": "0",
            "components": [
              {
                "type": "header",
                "parameters": [
                  {
                    "type": "image",
                    "image": {
                      "id": "1234567890",
                      "url": "https://www.example.com"
                    },
                    "text": "text",
                    "button": {
                      "sub_type": "copy_code",
                      "payload": "12345",
                      "index": "0"
                    }
                  }
                ]
              }
            ]
          }
        ]
      },
      "type_location": [
        {
          "longitude": -122.425332,
          "latitude": 37.758056,
          "name": "Facebook HQ",
          "address": "1 Hacker Way, Menlo Park, CA 94025"
        }
      ],
      "type_contact": [
        {
          "addresses": [
            {
              "city": "Pune",
              "country": "india",
              "country_code": "91",
              "state": "Maharashtra",
              "street": "sample",
              "type": "home",
              "zip": "421501"
            }
          ],
          "birthday": "1998-10-23",
          "emails": [
            {
              "email": "htshmadsf@gmail.com",
              "type": "personal"
            }
          ],
          "name": {
            "first_name": "hitesh",
            "formatted_name": "hitesh",
            "last_name": "madgulkar"
          },
          "org": {
            "company": "netcore",
            "department": "engineering",
            "title": "developer"
          },
          "phones": [
            {
              "phone": "9049871578",
              "type": "mobile",
              "wa_id": "919049871578"
            }
          ],
          "urls": [
            {
              "type": "email",
              "url": "hcfgftshmadfgfghhulhhkar@gmail.com"
            }
          ]
        }
      ],
      "type_text": [
        {
          "content": "Visit our office website - https://netcorecloud.com/industries/business-and-financial-services/"
        }
      ],
      "type_interactive": [
        {
          "type": "button",
          "header": {
            "type": "image",
            "url": "https://res.cloudinary.com/demo/image/upload/v1312461204/sample.jpg",
            "filename": "document.pdf",
            "text": "Header text"
          },
          "footer": "This is Footer",
          "body": "body text here",
          "action": [
            {
              "name": "send_location",
              "buttons": [
                {
                  "type": "reply",
                  "name": "cta_url",
                  "reply": {
                    "id": "1",
                    "title": "hi"
                  },
                  "parameters": {
                    "display_text": "Visit Website",
                    "url": "https://www.example.com"
                  }
                }
              ],
              "parameters": {
                "payment_type": "upi",
                "payment_configuration": "dhruv_upi",
                "country": "IN",
                "values": {
                  "name": "CUSTOMER_NAME",
                  "phone_number": "+91xxxxxxxxxx",
                  "in_pin_code": "666666",
                  "address": "Some other location",
                  "city": "Delhi",
                  "state": "Maha",
                  "building_name": "Nandgopal"
                }
              }
            }
          ]
        }
      ],
      "type_media": [
        {
          "attachments": [
            {
              "attachment_type": "sticker",
              "attachment_url": "https://www.tyntec.com/sites/default/files/2020-07/tyntec_rocket_sticker_512px_001_.webp"
            }
          ]
        }
      ],
      "context": {
        "message_id": "wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTdCNTg5RjY1MEMyRjlGMjRGNgA="
      }
    }
  ]
}

Response

Success response for single or batch requests.

object required