Descripción General
El endpoint Verificación de Estado proporciona una forma de comprobar si el servicio de Telegram está correctamente configurado y disponible para enviar mensajes. Este endpoint es fundamental para verificar la configuración antes de intentar enviar notificaciones.
🎯 Características del Endpoint
- Verificación de Configuración: Comprueba si el bot token y chat ID están configurados
- Prueba de Conectividad: Verifica la conectividad con la API de Telegram
- Respuesta Inmediata: Proporciona respuesta rápida sobre el estado
- Información de Timestamp: Incluye marca de tiempo de la verificación
- Mensaje Descriptivo: Proporciona información clara sobre el estado
Endpoint Disponible
GET
/api/telegram/status
Verifica la disponibilidad del servicio Telegram. Este endpoint comprueba si el servicio está correctamente configurado y puede enviar mensajes.
Parámetros:
- No requiere parámetros de entrada
200 OK - Servicio Disponible
Servicio Telegram configurado y disponible
{
"serviceAvailable": true,
"timestamp": "2024-01-15T10:30:00Z",
"message": "Telegram service is ready"
}
200 OK - Servicio No Disponible
Servicio Telegram no configurado o no disponible
{
"serviceAvailable": false,
"timestamp": "2024-01-15T10:30:00Z",
"message": "Telegram service is not configured or unavailable"
}
500 Internal Server Error
Error interno del servidor durante la verificación
{
"error": "An unexpected error occurred while checking Telegram service status",
"statusCode": 500,
"message": "Internal server error"
}
Ejemplo de Uso
🔧 Ejemplo con curl
curl -X GET \
'http://localhost:1379/api/telegram/status' \
-H 'accept: application/json'
🔧 Ejemplo con JavaScript
fetch('/api/telegram/status')
.then(response => response.json())
.then(data => {
console.log('Service Available:', data.serviceAvailable);
console.log('Message:', data.message);
console.log('Timestamp:', data.timestamp);
});
Servicio Utilizado
ITelegramService.IsServiceAvailableAsync() - Verifica la disponibilidad del servicio
- Retorna: bool - true si el servicio está disponible, false en caso contrario
- Funcionalidad: Comprueba la configuración del bot token y chat ID
- Conectividad: Verifica la conectividad con la API de Telegram
- Configuración: Valida que los parámetros necesarios estén configurados