Send Messages

The primary endpoint for sending WhatsApp messages is:

POST /message/text
Authorization: Bearer <cartat_api_token>
Content-Type: application/json

The provider is selected automatically from the instance data. In most cases, you do not need to send provider in the request.

Request examples

Sends a plain text message through Meta Cloud API when the instance is Meta.

{
  "number": "+966501234567",
  "message": "Hello, your order was received successfully."
}

Use this shape when the template has a header parameter:

{
  "number": "+966501234567",
  "template_name": "invoice_ready",
  "header": {
    "type": "document",
    "document": {
      "link": "https://example.com/invoice.pdf",
      "filename": "invoice.pdf"
    }
  },
  "parameters": {
    "customer_name": "John"
  }
}

Use this shape when the template has a URL button or quick reply:

{
  "number": "+966501234567",
  "template_name": "payment_link",
  "parameters": {
    "customer_name": "John"
  },
  "buttons": [
    {
      "url": "https://store.example.com/pay/ORD-1001"
    }
  ]
}

Response

When Meta succeeds, the response follows this general shape:

{
  "status": "success",
  "id": "wamid.xxxxx",
  "from": "1234567890",
  "to": "966501234567",
  "type": "template",
  "provider": "meta",
  "response": {
    "messages": [
      {
        "id": "wamid.xxxxx"
      }
    ]
  }
}

Meta daily-limit usage is deducted only after a successful Meta response, and after creating message_log when possible. No deduction happens while preparing the request or before the provider responds successfully.

Behavior by connection type

Connection type

Behavior