Skip to main content
POST
/
user
/
whatsapp
/
send
curl -X POST "https://call.aiployees.com/api/user/whatsapp/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_id": 12,
    "template_id": 45,
    "recipient_phone": "+1234567890",
    "recipient_name": "John Doe",
    "variables": {
      "1": "John",
      "2": "January 15, 2026",
      "3": "2:00 PM"
    }
  }'

{
  "success": true,
  "conversation_id": 1234,
  "message_id": 567,
  "whatsapp_message_id": 890,
  "message_sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "queued"
}

Documentation Index

Fetch the complete documentation index at: https://docs.aiployees.com/llms.txt

Use this file to discover all available pages before exploring further.

Този endpoint изпраща WhatsApp съобщение чрез предварително одобрен шаблон. Шаблонните съобщения са задължителни при започване на разговор с потребител за първи път или при изпращане на съобщения извън 24-часовия прозорец за съобщения.
Този endpoint има ограничение от 5 заявки в секунда на потребител.

​
Тяло на заявката

​
sender_id
integer
required
ID на WhatsApp изпращача от който да се изпрати (получен от endpoint-а Get Senders)
​
template_id
integer
required
ID на шаблона за съобщение който да се използва (получен от endpoint-а Get Templates)
​
recipient_phone
string
required
Телефонния номер на получателя в международен формат (например, +1234567890)
​
recipient_name
string
Името на получателя, максимум 255 символа (използва се за проследяване на разговори и CRM цели)
​
variables
object
Двойки ключ-стойност за променливите на шаблона. Ключовете трябва да съответстват на имената на променливите от шаблона. Ако шаблонът има променливи {{1}}, {{2}}, и т.н., подайте ги като {"1": "стойност1", "2": "стойност2"} или използвайте именуваните ключове от масива variables на шаблона.

​
Полета в отговора

​
success
boolean
Дали съобщението е изпратено успешно
​
conversation_id
integer
ID на разговора (нов или съществуващ) свързан с това съобщение
​
message_id
integer
ID на записа на съобщението в разговора
​
whatsapp_message_id
integer
ID на записа на WhatsApp съобщението
​
message_sid
string
Twilio message SID за проследяване на доставката
​
status
string
Началният статус на доставка на съобщението (например, queued, sent)

​
Отговори при грешки

​
402 Insufficient Balance
​
404 Not Found
​
422 Unprocessable Entity
curl -X POST "https://call.aiployees.com/api/user/whatsapp/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_id": 12,
    "template_id": 45,
    "recipient_phone": "+1234567890",
    "recipient_name": "John Doe",
    "variables": {
      "1": "John",
      "2": "January 15, 2026",
      "3": "2:00 PM"
    }
  }'

{
  "success": true,
  "conversation_id": 1234,
  "message_id": 567,
  "whatsapp_message_id": 890,
  "message_sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "queued"
}

​
Забележки

  • Шаблонните съобщения трябва да използват одобрени шаблони. Шаблони със статус pending или rejected ще се провалят.
  • Изпращачът трябва да е online. Офлайн изпращачи не могат да изпращат съобщения.
  • Разходите за съобщения се приспадат автоматично от баланса на акаунта ви (кредити за tenant потребители, минути за директни потребители).
  • След изпращане на шаблонно съобщение се отваря 24-часов прозорец за съобщения. През този прозорец можете да изпращате свободни съобщения без нужда от шаблон.
  • Ако разговор със получателя вече съществува, съобщението се добавя към съществуващия разговор.
  • Ограничение на честотата: 5 заявки в секунда на потребител.