Skip to main content
POST
/
user
/
whatsapp
/
send-freeform
curl -X POST "https://call.aiployees.com/api/user/whatsapp/send-freeform" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_id": 12,
    "recipient_phone": "+1234567890",
    "message": "Thank you for your inquiry! Our team will review your request and get back to you within 2 hours."
  }'
{
  "success": true,
  "conversation_id": 1234,
  "message_id": 567,
  "whatsapp_message_id": 890,
  "message_sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "session_status": {
    "is_open": true,
    "can_send_freeform": true,
    "requires_template": false,
    "message": "Session open (23 hr 45 min remaining). Unlimited free-form messages allowed.",
    "minutes_remaining": 1425,
    "expires_at": "2026-02-25T10:30:00+00:00"
  }
}
Този endpoint изпраща WhatsApp съобщение със свободна форма (свободен текст) до получател. За разлика от template съобщенията, съобщенията със свободна форма могат да съдържат всякакъв текст, но изискват активен 24-часов прозорец за съобщения — което означава, че получателят трябва да е изпратил съобщение на вашия WhatsApp изпращач в рамките на последните 24 часа.
Съобщения със свободна форма могат да се изпращат само по време на активен 24-часов прозорец за съобщения. Ако сесията е изтекла, първо трябва да изпратите template съобщение, за да започнете отново разговора. Използвайте Session Status endpoint, за да проверите дали сесията е активна.
Този endpoint е ограничен до 5 заявки в секунда на потребител.

Request Body

sender_id
integer
required
ID на WhatsApp изпращача, от който да се изпрати (получен от Get Senders endpoint)
recipient_phone
string
required
Телефонният номер на получателя в международен формат (например, +1234567890)
message
string
required
Съдържанието на съобщението за изпращане (максимум 4096 символа)

Response Fields

success
boolean
Дали съобщението е изпратено успешно
conversation_id
integer
ID на разговора, свързан с това съобщение
message_id
integer
ID на записа на съобщението в разговора
whatsapp_message_id
integer
ID на записа на WhatsApp съобщението
message_sid
string
Twilio message SID за проследяване на доставката
session_status
object
Обновен статус на сесията след изпращане на съобщението

Error Responses

402 Недостатъчен баланс
403 Сесията е изтекла
404 Не е намерен
503 Изпращачът е офлайн
curl -X POST "https://call.aiployees.com/api/user/whatsapp/send-freeform" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_id": 12,
    "recipient_phone": "+1234567890",
    "message": "Thank you for your inquiry! Our team will review your request and get back to you within 2 hours."
  }'
{
  "success": true,
  "conversation_id": 1234,
  "message_id": 567,
  "whatsapp_message_id": 890,
  "message_sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "session_status": {
    "is_open": true,
    "can_send_freeform": true,
    "requires_template": false,
    "message": "Session open (23 hr 45 min remaining). Unlimited free-form messages allowed.",
    "minutes_remaining": 1425,
    "expires_at": "2026-02-25T10:30:00+00:00"
  }
}

24-часов прозорец за съобщения

WhatsApp прилага политика за 24-часов прозорец за съобщения:
  1. Когато клиент изпрати съобщение на вашия WhatsApp Business номер, се отваря 24-часов прозорец.
  2. По време на този прозорец можете да изпращате съобщения със свободна форма без ограничения.
  3. След като прозорецът изтече, трябва да използвате template съобщение, за да започнете отново разговора.
  4. Всяко ново съобщение от клиента нулира 24-часовия таймер.
Използвайте Session Status endpoint, за да проверите дали сесията е активна преди да се опитате да изпратите съобщение със свободна форма.

Забележки

  • Максималната дължина на съобщението е 4,096 символа (ограничение на WhatsApp).
  • Изпращачът трябва да е online. Офлайн изпращачи връщат 503 грешка.
  • Разходите за съобщения се приспадат автоматично от баланса ви.
  • Ограничение за заявки: 5 заявки в секунда на потребител.