Base URL

https://lip-backend-1064145932505.southamerica-east1.run.app

Enviar template

POST /api/external/whatsapp/templates/send

Escopo necessario: whatsapp:send

Body:

• to (string, obrigatorio)
• templateName (string, obrigatorio)
• language (string, opcional, default pt_BR)
• templateParams (objeto, opcional)
• templateButtonParams (array, opcional)

Observacao sobre language:

• A Meta exige idioma no envio de template.
• Se nao enviar, usamos pt_BR.

Observacao sobre templateParams:

• Os valores sao enviados na ordem das chaves do objeto.
• Para garantir ordem, use chaves numericas em string ("1", "2", "3").

Observacao sobre templateButtonParams:

• Usado para preencher botoes de template do tipo url ou quick_reply.
• Para botao url, o text e obrigatorio.
• index deve seguir o indice configurado no template (ex: 0).

Exemplo:

Copiar

Resposta:

Copiar

Templates (CRUD)

Listar templates

GET /api/external/whatsapp/templates

Escopo necessario: whatsapp:templates:read

Query params:

• category (string)
• isActive (boolean)
• search (string)
• page (number)
• limit (number)

Resposta:

Copiar

Obter template

GET /api/external/whatsapp/templates/{id}

Escopo necessario: whatsapp:templates:read

Resposta (exemplo):

Copiar

Criar template

POST /api/external/whatsapp/templates

Escopo necessario: whatsapp:templates:write

Campos principais:

• name (string, obrigatorio)
• content (string, obrigatorio)
• category (string, opcional)
• mediaUrl (string, opcional)
• mediaType (string, opcional: image|audio|video|document)
• variableMappings (array, opcional)
• isActive (boolean, opcional)

variableMappings:

• index (number)
• source (SYSTEM | CUSTOM)
• fieldId (string)

Exemplo (criacao simples):

Copiar

Exemplo com variableMappings:

Copiar

Opcional (apenas para API oficial do WhatsApp):

• metaData com o payload esperado pela Meta

Exemplo com metaData:

Copiar

Atualizar template

PUT /api/external/whatsapp/templates/{id}

Escopo necessario: whatsapp:templates:write

Excluir template

DELETE /api/external/whatsapp/templates/{id}

Escopo necessario: whatsapp:templates:write

Status e categorias

Categorias (Meta):

• AUTHENTICATION
• MARKETING
• UTILITY

Status (Meta):

• PENDING
• APPROVED
• REJECTED
• PAUSED
• DISABLED