Messaging

Send and retrieve WhatsApp messages via the API.

Send Text Message

POST /api/v1/messages/text

{
  "to": "260971000000",
  "message": "Hello! This is a test message."
}

Request Parameters

Parameter	Type	Required	Description
`to`	string	Yes	Recipient phone number with country code (e.g., `260971000000`)
`message`	string	Yes	Message text, max 4,096 characters

Success Response (201)

{
  "data": {
    "message_id": "3EB0A0B4F3...",
    "status": "sent",
    "to": "260971000000",
    "created_at": "2026-03-08T10:30:00+00:00"
  }
}

Error Response (422)

{
  "error": {
    "code": "SESSION_NOT_CONNECTED",
    "message": "The session linked to this API key is not connected. Connect it from the dashboard first.",
    "status": 422
  }
}

Message History

GET /api/v1/messages

Returns paginated message history for the session linked to your API key.

Query Parameters

Parameter	Type	Default	Description
`page`	integer	1	Page number

Get Single Message

GET /api/v1/messages/{message_id}

Message Statuses

Status	Description
`queued`	Message created and queued for delivery
`sent`	Message sent to WhatsApp servers
`delivered`	Message delivered to recipient's device
`read`	Message read by recipient
`failed`	Delivery failed — check `error_message` field