Saltar al contenido principal
API REST pública

El poder de la moderación,
invocable desde tu código

Conecta Telm con tus propios sistemas: comprueba cualquier texto con el motor antispam de producción, gestiona los ajustes y las reglas de los grupos desde el código, y lee el registro de decisiones y la analítica, todo a través de una API REST limpia con claves que tú controlas.

  • REST v1 estable
  • Comprobación de spam en todos los planes
  • Webhooks incluidos
$Tu códigotk_live_…Tu clave de APIMotor de TelmTu grupo

Tu primera llamada en 30 segundos

Sin ceremonias de SDK: basta con una llamada HTTPS con tu clave.

spam-check.sh
$ 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"]
}

Una solicitud, un veredicto del motor de producción, con una puntuación y las razones que se activaron. La respuesta llega en bastante menos de un segundo para las comprobaciones basadas en reglas.

Lo que puede hacer la API

Comprobaciones de spam y usuarios

Pasa cualquier texto por el mismo motor que protege los grupos de Telm: llamadas individuales, lotes de hasta 20 y verificación de usuarios contra CAS y el propio conjunto de datos de Telm.

POST /spam/checkPOST /spam/check-batchPOST /users/check

Grupos y ajustes

Lee y modifica (PATCH) los ajustes de protección, gestiona reglas de moderación personalizadas y la lista blanca, para un grupo o para toda una flota.

GET/PATCH /groups/{id}/settingsCRUD /groups/{id}/rulesCRUD /groups/{id}/whitelist

Registro de moderación y analítica

Lee cada decisión del motor con veredicto, puntuación y reglas activadas, obtén series de analítica diarias y controla el uso de tu propia cuota.

GET /groups/{id}/journalGET /groups/{id}/analyticsGET /usage

Gestión de webhooks

Crea y gestiona endpoints de webhook, envía pings de prueba e inspecciona el historial de entrega, todo a través de la API.

CRUD /webhooksPOST /webhooks/{id}/testGET /webhooks/{id}/deliveries

Límites honestos, impresos en la caja

PlanLlamadas al díaLímite de frecuenciaAcceso a la API
Free10060/minComprobación de spam
Basic1 00060/minComprobación de spam
Pro10 000600/minAPI completa + webhooks
Business50 0001 800/minAPI completa + webhooks

Los límites se aplican por cuenta, no por clave. Cada respuesta incluye las cabeceras X-Quota-Limit, X-Quota-Used y X-Quota-Reset, y al alcanzar un límite se devuelve un 429 limpio con Retry-After; sin sorpresas.

Claves hechas como deben ser

Mostrada una vez, almacenada con hash

La clave completa aparece exactamente una vez, al crearla. Telm solo almacena un hash: nadie, ni siquiera nosotros, puede volver a leer tu clave.

Ámbitos de lectura/escritura

Las claves llevan ámbitos de lectura y escritura. Dale a tu script de informes una clave de solo lectura: físicamente no puede cambiar ningún ajuste.

Revocación instantánea

Revoca cualquier clave desde el panel y dejará de funcionar de inmediato. Un interruptor de emergencia por cuenta puede congelar todo el acceso a la API a la vez.

API completa en Pro y Business

La API completa y los webhooks están incluidos en Pro y Business. La comprobación de spam está disponible en todos los planes —incluido Free— dentro de la cuota diaria.

El mismo motor, ahora bajo tu control

La API pública expone el mismo motor de moderación que hace funcionar el bot de Telm, no una imitación simplificada. Envía un texto por POST a /spam/check y pasará por la misma canalización que usan tus grupos: señales de reputación, reglas y, opcionalmente, el clasificador de IA. Eso significa que puedes integrar el criterio de Telm en cualquier sitio: un formulario de soporte, tu propio bot, una sección de comentarios o una herramienta interna.

Más allá de las comprobaciones, la API gestiona tus grupos como código. Lee y modifica (PATCH) los ajustes de protección, crea reglas de moderación y mantén listas blancas: las mismas operaciones que el panel, pero automatizables. Las agencias que gestionan decenas de comunidades pueden desplegar un cambio de política con un solo bucle en lugar de decenas de clics.

El historial es de primera clase: el endpoint del registro de moderación devuelve cada decisión que tomó el motor —veredicto, puntuación, qué reglas se activaron y qué acción se aplicó— con paginación por cursor pensada para archivar. Combinado con el endpoint de analítica, puedes crear archivos de cumplimiento, paneles internos o alertas sobre los datos reales de tu grupo.

La autenticación es deliberadamente aburrida: claves bearer creadas en tu panel, mostradas una sola vez, almacenadas con hash, con ámbitos de lectura/escritura y revocación instantánea. Cada respuesta incluye cabeceras de cuota, así que tu integración siempre sabe en qué punto 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.

¿Empezamos?

Empieza a proteger tu comunidad hoy. Plan Free disponible.