Poder de moderação,
invocável a partir do seu código
Conecte o Telm aos seus próprios sistemas: verifique qualquer texto com o motor antispam de produção, gerencie configurações e regras de grupos por código, leia o registro de decisões e o analytics — tudo por uma API REST limpa, com chaves que você controla.
- REST v1 estável
- Verificação de spam em todos os planos
- Webhooks incluídos
Sua primeira chamada em 30 segundos
Sem cerimônia de SDK: uma chamada HTTPS com sua chave é tudo o que basta.
$ curl -X POST https://api.telm.com/api/public/v1/spam/check \
-H "Authorization: Bearer tk_live_..." \
-d '{"text": "Earn $500/day from home!! DM me now"}'
// HTTP 200
{
"verdict": "spam",
"score": 97,
"reasons": ["contact_flow", "money_lure"]
}Uma requisição, um veredito do motor de produção — com uma pontuação e os motivos que dispararam. A resposta chega em bem menos de um segundo para verificações baseadas em regras.
O que a API pode fazer
Verificação de spam e de usuários
Passe qualquer texto pelo mesmo motor que protege os grupos do Telm — chamadas únicas, lotes de até 20 e triagem de usuários contra o CAS e a base de dados própria do Telm.
POST /spam/checkPOST /spam/check-batchPOST /users/checkGrupos e configurações
Leia e ajuste (patch) as configurações de proteção, gerencie regras de moderação personalizadas e a lista branca — para um grupo ou uma frota deles.
GET/PATCH /groups/{id}/settingsCRUD /groups/{id}/rulesCRUD /groups/{id}/whitelistRegistro e analytics
Leia cada decisão do motor com veredito, pontuação e regras acionadas, obtenha séries de analytics diárias e acompanhe o uso da sua própria cota.
GET /groups/{id}/journalGET /groups/{id}/analyticsGET /usageGerenciamento de webhooks
Crie e gerencie endpoints de webhook, envie pings de teste e inspecione o histórico de entrega — inteiramente pela API.
CRUD /webhooksPOST /webhooks/{id}/testGET /webhooks/{id}/deliveriesLimites honestos, impressos na embalagem
| Plano | Chamadas por dia | Limite de taxa | Acesso à API |
|---|---|---|---|
| Free | 100 | 60/min | Verificação de spam |
| Basic | 1 000 | 60/min | Verificação de spam |
| Pro | 10 000 | 600/min | API completa + webhooks |
| Business | 50 000 | 1 800/min | API completa + webhooks |
Os limites valem por conta, não por chave. Toda resposta traz os cabeçalhos X-Quota-Limit, X-Quota-Used e X-Quota-Reset, e atingir um limite devolve um 429 limpo com Retry-After — sem surpresas.
Chaves construídas como deveriam ser
Mostrada uma vez, armazenada em hash
A chave completa aparece exatamente uma vez, na criação. O Telm armazena apenas um hash — ninguém, nem nós, consegue ler sua chave de volta.
Escopos (leitura/escrita)
As chaves carregam escopos de leitura e escrita. Dê ao seu script de relatórios uma chave somente leitura — ela fisicamente não consegue alterar nenhuma configuração.
Revogação instantânea
Revogue qualquer chave pelo painel e ela para de funcionar imediatamente. Um botão de emergência por conta pode congelar todo o acesso à API de uma vez.
A API completa e os webhooks estão incluídos no Pro e no Business. A verificação de spam está disponível em todos os planos — incluindo o Free — dentro da cota diária.
O mesmo motor, agora sob o seu controle
A API pública expõe o mesmo motor de moderação que roda no bot do Telm — não uma imitação simplificada. Envie um POST de um texto para /spam/check e ele passa pelo pipeline idêntico ao que seus grupos usam: sinais de reputação, regras e, opcionalmente, o classificador de IA. Isso significa que você pode incorporar o julgamento do Telm em qualquer lugar: um formulário de suporte, seu próprio bot, uma seção de comentários, uma ferramenta interna.
Além das verificações, a API gerencia seus grupos como código. Leia e ajuste (patch) as configurações de proteção, crie regras de moderação, mantenha listas brancas — as mesmas operações do painel, mas programáveis. Agências que administram dezenas de comunidades podem aplicar uma mudança de política com um único laço, em vez de dezenas de cliques.
O histórico é de primeira classe: o endpoint do registro devolve cada decisão que o motor tomou — veredito, pontuação, quais regras dispararam, que ação foi executada — com paginação por cursor feita para arquivamento. Combinado com o endpoint de analytics, você pode construir arquivos de conformidade, painéis internos ou alertas em cima dos dados reais do seu grupo.
A autenticação é deliberadamente sem graça: chaves bearer criadas no seu painel, mostradas uma única vez, armazenadas em hash, com escopos de leitura/escrita e revogação instantânea. Toda resposta traz cabeçalhos de cota, para que sua integração sempre saiba em que pé está.
Frequently asked questions
Which plans include API access?
Spam checking (/spam/check) works on every plan, including Free, within the daily quota. The full API — group settings, rules, journal, analytics, user screening and webhooks — is included in Pro and Business.
What are the request limits?
Daily quotas by plan: Free 100, Basic 1,000, Pro 10,000, Business 50,000 calls. Rate limits: 60 requests per minute on Free and Basic, 600 on Pro, 1,800 on Business. Every response includes X-Quota-Limit, X-Quota-Used and X-Quota-Reset headers.
How do I get an API key?
In the dashboard under Settings → API & Webhooks. The key is shown once at creation — only its hash is stored. You can hold up to 10 active keys, scope them to read-only, and revoke any of them instantly.
Can the AI classifier be used through the API?
AI checks consume the plan’s separate daily AI quota: Basic 100, Pro 1,000, Business 10,000 (Free has none).
Is there an OpenAPI specification?
Yes, the full machine-readable OpenAPI 3.1 spec is published alongside the developer documentation, so you can generate clients or plug it into your tooling.
Recursos relacionados
Explore mais maneiras pelas quais o Telm pode ajudar sua comunidade