API Reference
DashboardGet API keyAPI key

Getting started

  • Introduction
  • Authentication
  • Errors & rate limits

Voice agents

WhatsApp agents

    • Overview
    • GETList messages
    • POSTSend message

Workspace

WhatsApp agentsMessages

Messages

Read a conversation's messages and reply to the customer.

Messages belong to a conversation. They're recorded as they happen: customer messages, AI agent replies, template messages, and replies sent by your team or through this API.

WhatsApp only allows free-form replies within 24 hours of the customer's last message. Messages older than your plan's history window are not returned.

Endpoints

GETList messages/whatsapp/conversations/{id}/messagesPOSTSend message/whatsapp/conversations/{id}/messages

The message object

  • idstring (uuid)

    Message id.

  • conversation_idstring (uuid)

    Conversation the message belongs to.

  • tenant_idstring (uuid)

    The workspace that owns the message.

  • wamidstringnullable

    WhatsApp's own message id.

  • directionstring

    inbound (from the customer) or outbound.

    Allowed:inboundoutbound
  • sender_typestring

    customer, agent (the AI) or human (a person on your team or the API).

    Allowed:customeragenthuman
  • message_typestring

    e.g. text, template, image.

  • bodystringnullable

    Message text.

  • template_namestringnullable

    Template name, for template messages.

  • statusstring

    received, pending, sent, delivered, read or failed.

  • errorstringnullable

    Why delivery failed, if it did.

  • created_atstring (date-time)nullable

    When the message was sent or received.

  • updated_atstring (date-time)nullable

    When its status last changed.

The message object
{
  "id": "0a1b2c3d-4e5f-4061-9283-a4b5c6d7e8f9",
  "conversation_id": "d2c3b4a5-9687-4f1e-8d2c-3b4a59687f1e",
  "tenant_id": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
  "wamid": "wamid.HBgMOTE5ODc2NTQzMjEwFQIAERgSQTFCMkMzRDRFNUY2QTdCOEMA",
  "direction": "inbound",
  "sender_type": "customer",
  "message_type": "text",
  "body": "Can you share the documents list?",
  "template_name": null,
  "status": "received",
  "error": null,
  "created_at": "2026-10-24T14:03:11.508Z",
  "updated_at": "2026-10-24T14:03:11.508Z"
}
PreviousGet lead summaryNextList messages