Skip to main content

Send Text Message

Send a text message to a WhatsApp contact or group. You can include link previews, quoted messages, mentions, and delays.

Endpoint

Path Parameters

string
required
The name of your WhatsApp instance that you created

Request Body

string
required
The recipient’s WhatsApp number in international format (without + symbol)Example: 5511999999999 for a Brazilian number
string
required
The text message content you want to send
integer
Delay before sending the message in millisecondsExample: 1000 for 1 second delay
Enable or disable link preview for URLs in the messageDefault: true
object
Quote a previous message by providing its key and message object
boolean
Mention all participants in a group (use with caution)Default: false
array
Array of phone numbers to mention in the message. Each number should be a numeric string.Example: ["5511999999999", "5511888888888"]

Response

object
Message key information
object
The sent message object containing the text and metadata
string
Unix timestamp when the message was sent
string
Message status (e.g., “PENDING”, “SENT”)

Code Examples

Advanced Examples

Error Responses

Make sure your instance is connected before sending messages. Use the instance status endpoint to verify connection.
number
HTTP status code
string
Error description

Common Errors

The number field should contain only digits in international format without the + symbol. For example, use 5511999999999 instead of +55 11 99999-9999.