GET
/automacoesListar automações para ligar a uma regra
automacoes:lermódulo Automações
Com gatilho=comentario: as automações que uma regra de comentário pode iniciar (automacao_id).
GET /automacoes
curl "https://chat.forsi.com.br/api/v1/automacoes?gatilho=comentario" \
-H "Authorization: Bearer $FORSI_CHAVE"const resposta = await fetch('https://chat.forsi.com.br/api/v1/automacoes?gatilho=comentario', {
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/automacoes",
headers={
"Authorization": f"Bearer {os.environ['FORSI_CHAVE']}",
},
params={
"gatilho": "comentario",
},
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": "fb75ed96-6799-4508-92b2-6bc7d57ff8a9",
"nome": "Maria Souza"
}
]
}Parâmetros de consulta#
gatilho"comentario"opcionalPor enquanto só
comentario: automações que podem ser ligadas a uma regra de comentário.
Resposta#
200 com {"dados": ...}: uma lista de AutomacaoResumo.
iduuidopcional—nomestringopcional—
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 devolver19
regra_inexistenteRegra de comentário não encontrada (veja GET /regras-comentario).regra_conexao_invalidaconexao_id precisa ser uma conta do Instagram conectada por login (veja GET /instagram/contas).regra_sem_palavrasInforme de 1 a 30 palavras, ou use qualquer_comentario: true.regra_modo_invalidomodo deve ser contem ou igual.regra_sem_acaoA regra precisa de uma resposta pública ou de uma resposta privada.regra_texto_longoTexto longo demais: resposta pública até 2200 caracteres e resposta privada até 1000.regra_variantes_demaisNo máximo 5 respostas_publicas.regra_extra_sem_publicorespostas_publicas e ocultar_apos só valem com responder_publico preenchido.regra_automacao_invalidaautomacao_id não é uma automação desta organização (veja GET /automacoes?gatilho=comentario).regra_automacao_sem_privadaPara ligar uma automação, preencha resposta_privada.regra_botao_longoCada botão tem no máximo 20 caracteres.regra_botao_repetidoBotões repetidos. Cada botão deve ser diferente.regra_botao_url_invalidaA url do botão deve ser um link https:// válido, com até 2000 caracteres.regra_botoes_demaisNo máximo 3 botões.regra_botoes_invalidosbotoes deve ser uma lista de textos ou de objetos { titulo, url }.regra_botoes_sem_privadaPara ter botões, preencha resposta_privada.recurso_desligadoEste recurso não está liberado para a sua organização.seguir_invalidoAlgum campo de `seguir` é inválido. A mensagem diz qual: textos de 1 a 640 caracteres (os de "já segue" e "seguiu depois" podem ser vazios), botões de 1 a 20 e sem `{` (botão não troca variáveis), cada texto até 900 bytes (emoji e acento contam mais), sem caractere de controle ou invisível, `max_tentativas` de 1 a 50 e link do conteúdo em https.limite_de_regrasLimite de 200 regras de comentário por organização. Apague alguma para criar outra.
Os erros que valem para qualquer rota (chave, limite, JSON) estão em Erros.