whatsapp

Send a WhatsApp template message

Changed on

Sends a WhatsApp template message to a specified external number.

The message is always sent as the real template, with its buttons, including inside an open 24-hour conversation window. Meta bills every send as a template message.

Permission: Access is managed by the WhatsApp service. No specific API token permission is checked.

Monitoring: No impact.

post/whatsapp/templates/send

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/whatsapp/templates/send
  • Auth
    API key in header Authorization

Request body

template_uuidstring required
external_numberinteger required
account_uuidstring

UUID of the WhatsApp account (number) used to send the template. Optional, but strongly recommended: when omitted, the account is inferred from the template, which may not be the one you expect if your WhatsApp Business Account has several numbers. The account must be allowed to send the template, otherwise the request is refused with a 403. Accounts are listed by GET /whatsapp/accounts.

variablesobject

Template variable values keyed by variable_label. Every placeholder of the template must have a value here, otherwise the send is rejected.

Example request

{
  "template_uuid": "1eb09f33-348e-42e6-bfb3-361df133c82e",
  "external_number": 33612345678,
  "account_uuid": "5b1f0f0e-8f3e-4a55-9d1e-0c2a7f3a9b11",
  "variables": {
    "firstname_contact": "John"
  }
}

Response

Successful operation — the WhatsApp template message has been sent.

Changes

  • 9e23e47609a5Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

  • 5b3e0427c522Revision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      added the new optional request property