Skip to main content
The Connexease Gateway exposes a single endpoint for all outbound WhatsApp messages. You send one HTTP request — the Gateway authenticates you, checks your rate limits and balance, and forwards the payload to Meta on your behalf. The response contains a wamid that you can use to track delivery status via webhooks. This page covers text, media, and interactive messages, plus a basic template example. The full template reference lives under Templates.

Sending a template?

Templates are required to start a conversation or to reach a customer outside the 24-hour window. See the Templates section for the component reference and an example for every template type.

Endpoint

string
required
API key in Bearer sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx format. See Authentication.
string
required
Always application/json.

Query Parameters

boolean
default:"false"
When true, routes the request through the Meta Marketing Messages Lite endpoint. Applies to marketing templates — see Marketing Messages Lite.
boolean
default:"false"
Sandbox mode. When true, auth, rate limiting, and billing checks run normally; the Meta API call is skipped and a fake wamid is returned. Ideal for development and load testing.

Request Body

string
required
Always "whatsapp".
string
required
Recipient phone number including country code, without +, spaces, or dashes. E.g. 905321234567, 14155552671.
string
required
Message type. Values: text, image, audio, document, interactive, template. For template, see Templates.

Message Types

string
required
Message text. Maximum 4096 characters.
boolean
default:"false"
Show a link preview if the message contains a URL.
Publicly accessible image URL. Maximum 5 MB. Supported formats: JPG, PNG.
string
Caption text displayed below the image.
Publicly accessible audio file URL. Maximum 16 MB. Supported formats: MP3, AAC, AMR, OGG (Opus codec).
Publicly accessible file URL. Maximum 100 MB.
string
Caption text displayed above the document.
string
File name shown to the recipient (e.g. invoice_march_2025.pdf).
Presents up to 3 tappable buttons. When a user taps a button, an interactive.button_reply webhook event is sent to your endpoint.
string
required
For buttons: "button"
string
required
Message body text.
array
required
Maximum 3 buttons. Each button: type: "reply", reply.id (unique ID, max 256 chars), reply.title (max 20 chars).
Displays a scrollable, sectioned list of options. When a user selects an option, an interactive.list_reply webhook event is sent.
string
required
For lists: "list"
string
required
Description text shown above the list.
string
required
Label for the button that opens the list. Maximum 20 characters.
array
required
Array of sections. Each section has a title and rows (options). Row id max 200 chars, title max 24 chars.
Templates must be approved by Meta before you send them. They are required to start a conversation or to reach a user outside the 24-hour service window.
string
required
The name of the approved template.
string
required
The language the template was approved in. E.g. en_US, tr. Must exactly match the approved template.
array
Values for the template’s variables, media, and buttons. Omit it when the template has nothing to fill in.
For templates with variables, media headers, or buttons — and examples of every template type — see Templates.

Response

Success (HTTP 200)

Response Fields:
boolean
true = message accepted. Does not mean the message was delivered.
string
Always "whatsapp".
string
The phone number you sent in the request.
string
The WhatsApp-normalized phone number. Usually the same as input.
string
The unique wamid for this message. Store this to correlate with incoming delivery status webhooks.

Error Response

See Error Codes for the full list.

Key Notes

HTTP 200 ≠ Delivered. The response confirms the message was accepted, not that it reached the recipient. Listen to message_status webhook events for actual delivery confirmation.
Store data.messages[0].id in your database. You’ll need this wamid to match it against incoming message_status and read webhooks.
24-hour window: The message types on this page can only be sent within 24 hours of the last message from the user. Outside this window, send a template.