GET
/modelosListar modelos do WhatsApp
modelos:ler
Modelos da API oficial sincronizados com a Meta, com as variáveis de cada um.
GET /modelos
curl "https://chat.forsi.com.br/api/v1/modelos?estado=APPROVED" \
-H "Authorization: Bearer $FORSI_CHAVE"const resposta = await fetch('https://chat.forsi.com.br/api/v1/modelos?estado=APPROVED', {
headers: {
Authorization: `Bearer ${process.env.FORSI_CHAVE}`,
},
});
const json = await resposta.json();
if (!resposta.ok) throw new Error(`${resposta.status} ${json.erro.codigo}: ${json.erro.mensagem}`);
console.log(json.dados);import os
import requests
resposta = requests.get(
"https://chat.forsi.com.br/api/v1/modelos",
headers={
"Authorization": f"Bearer {os.environ['FORSI_CHAVE']}",
},
params={
"estado": "APPROVED",
},
timeout=30,
)
corpo = resposta.json()
if not resposta.ok:
raise RuntimeError(f"{resposta.status_code} {corpo['erro']['codigo']}: {corpo['erro']['mensagem']}")
print(corpo["dados"])Resposta 200
{
"dados": [
{
"id": "2eabdd6d-7cb0-4c12-9da3-8f9441056099",
"nome": "lembrete_consulta",
"idioma": "pt_BR",
"categoria": "UTILITY",
"estado": "APPROVED",
"caixa_id": "7a9d53e9-9d1b-4122-923b-fac67958f445",
"formato_parametros": "positional",
"variaveis": ["texto"],
"texto": "Olá {{1}}, sua consulta é amanhã às {{2}}.",
"componentes": [],
"atualizado_em": "2026-10-04T13:05:12.481Z"
}
]
}Parâmetros de consulta#
estadostringopcionalAPPROVED, PENDING, REJECTED...
- até 30 caracteres
caixa_iduuidopcional—
Resposta#
200 com {"dados": ...}: uma lista de Modelo.
iduuidopcional—nomestringopcional—idiomastringopcional—categoriastringopcional—estadostringopcional- ex.: APPROVED
caixa_iduuidopcional—formato_parametrosstringopcional—variaveislista de stringopcional—textostringopcional—componentesarrayopcional—atualizado_emdata e hora ISO 8601opcional—
Erros#
Todo erro vem como {"erro": {"codigo", "mensagem"}}. Trate pelo codigo: ele não muda.
| Status | Quando |
|---|---|
| 401 | Chave ausente ou inválida (resposta igual para qualquer motivo). |
| 403 | Plano sem API, escopo insuficiente ou https/origem recusados. |
| 422 | Dados inválidos ou regra de negócio (ex.: janela_fechada; conta_restrita = a Meta restringiu a conta por spam: erro traz os campos de RestricaoMeta, como ate, escopo, motivo e retry_after_s). |
| 429 | Limite de requisições. Veja Retry-After. |
Códigos de erro que esta área pode devolver1
caixa_inexistenteCaixa não encontrada (veja GET /me).
Os erros que valem para qualquer rota (chave, limite, JSON) estão em Erros.