Canal Telegram #
Registra el token de BotFather y administra el webhook de tu bot.
Prepara tu terminal una vez
Variables para bash o zsh
export FLOWORDR_BASE_URL="https://app.flowordr.com"
export FLOWORDR_API_KEY="<tu-api-key>"
export FLOWORDR_TENANT_ID="<tu-tenant-id>"Ejecuta este bloque antes de los cURL. Sustituye los valores entre ángulos por tus credenciales; ningún ejemplo contiene claves reales.
GET /api/telegram/bots
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
cURL
curl "$FLOWORDR_BASE_URL/api/telegram/bots" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 lista de bots.
POST /api/telegram/bots
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| botUsername | body string | Sí | 1–50 caracteres | — | Nombre de usuario en Telegram. |
| botToken | body string | En creación | Hasta 100 caracteres | — | Token entregado por BotFather. |
| welcomeMessage / helpMessage | body string | No | Hasta 500 / 1000 caracteres | — | Mensajes del bot. |
| defaultDocumentIds | body integer[] | No | IDs del tenant | Todos | Documentos consultados. |
| defaultRagOptions | body object | No | minScore, maxChunks, temperature, maxHistoryTurns, strictMode, promptMode y más | Defaults de Telegram | Opciones RAG. |
| rateLimitPerMinute | body integer | null | No | 0–100; 0 sin límite | Default de Telegram | Límite por usuario. |
| isActive | body boolean | null | No | true, false | Activo | Estado del bot. |
cURL
curl -X POST "$FLOWORDR_BASE_URL/api/telegram/bots" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID" -H "Content-Type: application/json" -d '{"botUsername":"<nombre-del-bot>","botToken":"<token-de-botfather>"}'Respuesta: 201 bot; 400 validación o configuración inválida.
GET /api/telegram/bots/{botId}
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| botId | path UUID | Sí | ID devuelto por POST /api/telegram/bots | — | Bot del tenant. |
cURL
curl "$FLOWORDR_BASE_URL/api/telegram/bots/<bot-id>" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 bot; 404 si no existe.
PUT /api/telegram/bots/{botId}
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| botId | path UUID | Sí | ID devuelto por POST /api/telegram/bots | — | Bot del tenant. |
| botUsername | body string | Sí | 1–50 caracteres | — | Nombre de usuario en Telegram. |
| botToken | body string | En creación | Hasta 100 caracteres | — | Token entregado por BotFather. |
| welcomeMessage / helpMessage | body string | No | Hasta 500 / 1000 caracteres | — | Mensajes del bot. |
| defaultDocumentIds | body integer[] | No | IDs del tenant | Todos | Documentos consultados. |
| defaultRagOptions | body object | No | minScore, maxChunks, temperature, maxHistoryTurns, strictMode, promptMode y más | Defaults de Telegram | Opciones RAG. |
| rateLimitPerMinute | body integer | null | No | 0–100; 0 sin límite | Default de Telegram | Límite por usuario. |
| isActive | body boolean | null | No | true, false | Activo | Estado del bot. |
cURL
curl -X PUT "$FLOWORDR_BASE_URL/api/telegram/bots/<bot-id>" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID" -H "Content-Type: application/json" -d '{"botUsername":"<nombre-del-bot>"}'Respuesta: 200 bot actualizado; 400 o 404.
DELETE /api/telegram/bots/{botId}
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| botId | path UUID | Sí | ID devuelto por POST /api/telegram/bots | — | Bot del tenant. |
cURL
curl -X DELETE "$FLOWORDR_BASE_URL/api/telegram/bots/<bot-id>" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 204 sin contenido; 404 si no existe.
GET /api/telegram/bots/{botId}/status
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| botId | path UUID | Sí | ID devuelto por POST /api/telegram/bots | — | Bot del tenant. |
cURL
curl "$FLOWORDR_BASE_URL/api/telegram/bots/<bot-id>/status" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 estado del webhook.
POST /api/telegram/bots/{botId}/webhook
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| botId | path UUID | Sí | ID devuelto por POST /api/telegram/bots | — | Bot del tenant. |
| webhookUrl | body URL | null | No | URL HTTPS pública | URL del sistema | Destino del webhook. |
| secretToken | body string | No | Hasta 100 caracteres | — | Validación de Telegram. |
| dropPendingUpdates | body boolean | No | true, false | true | Descarta mensajes pendientes. |
cURL
curl -X POST "$FLOWORDR_BASE_URL/api/telegram/bots/<bot-id>/webhook" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID" -H "Content-Type: application/json" -d '{}'Respuesta: 200 configuración del webhook; 400 si falla.
DELETE /api/telegram/bots/{botId}/webhook
| Nombre | Tipo | Obligatorio | Valores aceptados / rango | Default | Descripción |
|---|---|---|---|---|---|
| X-Api-Key (header) | string | Sí | Clave activa del tenant | — | Autenticación. |
| X-Tenant-Id (header) | UUID | Condicional | Tenant autorizado | Tenant de la clave | Necesario si la clave permite varios tenants. |
| botId | path UUID | Sí | ID devuelto por POST /api/telegram/bots | — | Bot del tenant. |
cURL
curl -X DELETE "$FLOWORDR_BASE_URL/api/telegram/bots/<bot-id>/webhook" -H "X-Api-Key: $FLOWORDR_API_KEY" -H "X-Tenant-Id: $FLOWORDR_TENANT_ID"Respuesta: 200 desactivación del webhook.