Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.leavo.ai/llms.txt

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

​
Visão Geral

Templates podem ser associados a steps específicos de cadências para enviar mensagens oficiais do WhatsApp Business. Isso é especialmente útil para reengajar leads após a janela de 24 horas.

​
Criar Associação

POST /backend/templates/cadence-associations
Body: 
{
  "cadence_id": "uuid",
  "step_index": 0,
  "message_index": 0,
  "template_id": "uuid",
  "parameter_mapping": {
    "1": "{{LEAD_NAME}}",
    "2": "Leavo"
  }
}
CampoTipoObrigatórioDescrição
cadence_idUUIDSimID da cadência
step_indexintegerSimÍndice do step na cadência
message_indexintegerSimÍndice da mensagem no step
template_idUUIDSimID do template (deve estar APPROVED)
parameter_mappingobjectNãoMapeamento de parâmetros do template
Apenas templates com status APPROVED podem ser associados a cadências.
Resposta (201): 
{
  "id": "uuid",
  "tenant_id": "uuid",
  "cadence_id": "uuid",
  "step_index": 0,
  "message_index": 0,
  "template_id": "uuid",
  "parameter_mapping": {
    "1": "{{LEAD_NAME}}",
    "2": "Leavo"
  },
  "template": {
    "id": "uuid",
    "template_name": "boas_vindas_v1",
    "language": "pt_BR",
    "status": "APPROVED"
  },
  "created_at": "2024-01-15T10:00:00Z"
}

​
Listar Associações de uma Cadência

GET /backend/templates/cadence-associations?cadence_id={cadence_id}

​
Atualizar Mapeamento de Parâmetros

PUT /backend/templates/cadence-associations/{id}/params
Body: 
{
  "parameter_mapping": {
    "1": "{{LEAD_FIRSTNAME}}",
    "2": "Equipe Leavo"
  }
}

​
Remover Associação

DELETE /backend/templates/cadence-associations/{id}
Resposta: 204 No Content

​
Variáveis Disponíveis

Use estas variáveis no parameter_mapping para personalizar as mensagens:
VariávelDescrição
{{LEAD_NAME}}Nome completo do lead
{{LEAD_FIRSTNAME}}Primeiro nome do lead
{{LEAD_NUMBER}}Telefone do lead
{{COMPANY_NAME}}Nome da empresa do lead
{{LEAD_FIELD_KEY}}Valor de campo personalizado (substitua KEY pela chave do campo)