How do we send a WhatsApp message from our system?

From signup to your first message

1. 1Create an API key

   In app.realoffice.ai, open Integration, then API Accounts, create an API account and copy its key. You can restrict it to a single IP address.

2. 2Pick a WhatsApp number

   GET /api/whatsapp/accounts returns your office WhatsApp numbers. Keep the id and pass it as whatsappAccountId. Without it, the message goes out from the first active number.

3. 3Send a template

   The first message to a customer goes out as a Meta-approved template through POST /api/whatsapp/send-template. WhatsApp templates

4. 4Continue in free text

   When the customer replies, a 24-hour window opens, and you can send plain text with POST /api/whatsapp/send-message.

Send a WhatsApp template

Pass the key in an Authorization: Bearer header or an X-API-Key header. Template parameters are a dictionary: body-1, body-2 for positional variables, or body-name for named ones. For templates with a media header or buttons, send componentsJson in the Meta format instead.

curl -X POST https://api.realoffice.ai/api/whatsapp/send-template \
  -H "Authorization: Bearer $REALOFFICE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "972501234567",
    "templateName": "appointment_reminder",
    "language": "he",
    "parameters": { "body-1": "Dana", "body-2": "10:00" }
  }'

A text message inside the 24-hour window

Free text only goes through if the customer wrote to the number in the last 24 hours. That is a WhatsApp rule; outside the window, send a template. The body is simple: to, message and an optional whatsappAccountId.

curl -X POST https://api.realoffice.ai/api/whatsapp/send-message \
  -H "Authorization: Bearer $REALOFFICE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "972501234567",
    "message": "Thanks Dana, see you tomorrow at 10:00",
    "whatsappAccountId": "YOUR_WHATSAPP_ACCOUNT_ID"
  }'

Every endpoint

The base URL is https://api.realoffice.ai/api. Every call except the health check needs an API key, and every response comes in the same JSON envelope.

Rules worth knowing

• The 24-hour windowFree text is delivered only within 24 hours of the customer's last message. Before that, or after it, send an approved template.
• Rate limitsUp to 100 requests per minute and 1,000 per hour from each IP address. Beyond that you get HTTP 429; wait and retry.
• One response envelopeEvery response has success, data, message, errors and timestamp. On an error, success is false and message says what happened.
• Several WhatsApp numbersWithout whatsappAccountId, the message goes out from the first active number. When scheduling with several active numbers, the number is required.
• One key per systemEach API account has its own key, with optional IP restriction. A disabled account gets 403, and a regenerated key stops the old one at once.
• Request logSend requests and their responses are stored, and you can review them in the app on the API Messages screen.

Developer questions