Skip to main content
GET
/
user
/
whatsapp
/
senders
/
{senderId}
/
templates
curl -X GET "https://suasofia.online/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": "Olá {{1}}, este é um lembrete para seu compromisso em {{2}} às {{3}}. Responda SIM para confirmar ou NÃO para reagendar.",
      "variables": ["customer_name", "date", "time"],
      "has_variables": true
    },
    {
      "id": 46,
      "name": "welcome_message",
      "language": "pt_BR",
      "category": "marketing",
      "status": "approved",
      "body_text": "Bem-vindo à Sua SofIA! Estamos empolgados em tê-lo. Como podemos ajudá-lo hoje?",
      "variables": [],
      "has_variables": false
    }
  ]
}
Este endpoint retorna todos os templates de mensagem associados a um remetente WhatsApp específico. Templates são necessários para iniciar conversas ou enviar mensagens para usuários fora da janela de mensagens de 24 horas.

Parâmetros de Caminho

senderId
integer
required
O ID do remetente WhatsApp (obtido do endpoint Get Senders)

Parâmetros de Consulta

status
string
Filtrar templates por status de aprovação. Padrão: approved. Use all para retornar todos os templates independentemente do status.

Campos de Resposta

data
array

Respostas de Erro

404 Not Found
curl -X GET "https://suasofia.online/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": "Olá {{1}}, este é um lembrete para seu compromisso em {{2}} às {{3}}. Responda SIM para confirmar ou NÃO para reagendar.",
      "variables": ["customer_name", "date", "time"],
      "has_variables": true
    },
    {
      "id": 46,
      "name": "welcome_message",
      "language": "pt_BR",
      "category": "marketing",
      "status": "approved",
      "body_text": "Bem-vindo à Sua SofIA! Estamos empolgados em tê-lo. Como podemos ajudá-lo hoje?",
      "variables": [],
      "has_variables": false
    }
  ]
}

Notas

  • Apenas templates approved são retornados por padrão. Templates com status pending ou rejected não podem ser usados para enviar mensagens.
  • O status de aprovação do template é sincronizado com a Meta a cada 4 horas automaticamente.
  • Variáveis em body_text são mostradas como {{1}}, {{2}}, etc. O array variables fornece nomes legíveis para humanos para cada placeholder.
  • Templates são necessários ao enviar mensagens para um usuário pela primeira vez ou fora da janela de mensagens de 24 horas.