Skip to main content
POST
Send a WhatsApp message

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Body

application/json
to
string
required

Recipient address: a phone number (E.164 preferred, e.g. "+491234567890"; "00" prefixes and separators are normalized) or a WhatsApp business-scoped user id (BSUID, e.g. "US.13491208655302741918") for contacts who have adopted a WhatsApp username.

Maximum string length: 140
Example:

"+491234567890"

type
enum<string>
required

Which kind of message to send.

Available options:
text,
template,
media
contactName
string

Contact name to set when a new conversation is created for this number.

Maximum string length: 255
text
string

Message body. Required when type is text.

Maximum string length: 4096
Example:

"Hi! Your order has shipped."

template
object

Template payload. Required when type is template.

media
object

Media payload. Required when type is media.

Response

Message accepted by WhatsApp.

id
string
required

meetergo message id.

conversationId
string
required

Conversation this message belongs to.

waMessageId
string
required

WhatsApp's own message id (wamid).

direction
enum<string>
required
Available options:
inbound,
outbound
type
string
required

Message kind (text, image, document, template, ...).

status
enum<string>
required

Delivery status. Inbound messages are always delivered.

Available options:
pending,
sent,
delivered,
read,
failed
createdAt
string<date-time>
required

When the message was created (ISO 8601).

text
string

Text body, or the caption for a media message.

mediaUrl
string

URL of the attached media, if any.

mediaMimeType
string

MIME type of the attached media.

mediaFilename
string

Filename of the attached document.

templateName
string

Template name, for template messages.

errorMessage
string

Failure reason from WhatsApp, set when status is failed.