Skip to main content
GET
/
user
/
whatsapp
/
senders
/
{senderId}
/
templates
curl -X GET "https://call.aiployees.com/api/user/whatsapp/senders/12/templates" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": [
    {
      "id": 45,
      "name": "appointment_reminder",
      "language": "en",
      "category": "utility",
      "status": "approved",
      "body_text": "Hi {{1}}, this is a reminder for your appointment on {{2}} at {{3}}. Reply YES to confirm or NO to reschedule.",
      "variables": ["customer_name", "date", "time"],
      "has_variables": true
    },
    {
      "id": 46,
      "name": "welcome_message",
      "language": "en",
      "category": "marketing",
      "status": "approved",
      "body_text": "Welcome to Acme Corp! We're excited to have you. How can we help you today?",
      "variables": [],
      "has_variables": false
    }
  ]
}
Този endpoint връща всички шаблони за съобщения, свързани с определен WhatsApp подател. Шаблоните са необходими за започване на разговори или изпращане на съобщения до потребители извън 24-часовия прозорец за съобщения.

Параметри в пътя

senderId
integer
required
ID-то на WhatsApp подателя (получено от Get Senders endpoint)

Query параметри

status
string
Филтриране на шаблони по статус на одобрение. По подразбиране: approved. Използвайте all за да върнете всички шаблони независимо от статуса.

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

data
array

Грешни отговори

404 Not Found
curl -X GET "https://call.aiployees.com/api/user/whatsapp/senders/12/templates" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": [
    {
      "id": 45,
      "name": "appointment_reminder",
      "language": "en",
      "category": "utility",
      "status": "approved",
      "body_text": "Hi {{1}}, this is a reminder for your appointment on {{2}} at {{3}}. Reply YES to confirm or NO to reschedule.",
      "variables": ["customer_name", "date", "time"],
      "has_variables": true
    },
    {
      "id": 46,
      "name": "welcome_message",
      "language": "en",
      "category": "marketing",
      "status": "approved",
      "body_text": "Welcome to Acme Corp! We're excited to have you. How can we help you today?",
      "variables": [],
      "has_variables": false
    }
  ]
}

Забележки

  • По подразбиране се връщат само approved шаблони. Шаблони със статус pending или rejected не могат да се използват за изпращане на съобщения.
  • Статусът на одобрение на шаблона се синхронизира с Meta автоматично на всеки 4 часа.
  • Променливите в body_text са показани като {{1}}, {{2}} и т.н. Масивът variables предоставя четими имена за всеки местозапълвач.
  • Шаблоните са необходими при първо съобщение до потребител или извън 24-часовия прозорец за съобщения.