Referencia de APIGET

Obtener configuración de alertas

Lee la configuración de alertas por correo para nuevas menciones relevantes.

GEThttps://ai.redreplier.com/ai-app/api/v1/alert-settings

Lee la configuración de alertas por correo para nuevas menciones relevantes.

Token Bearer (token de API de RedReplier)

Parámetros

Este endpoint no acepta parámetros de ruta ni de consulta.

Cuerpo de la solicitud

Este endpoint no requiere un cuerpo JSON.

Respuesta

Devuelve la configuración de alertas de la cuenta del token.

  • enabled (boolean): Indica si las alertas por correo están activadas.
  • cadenceMinutes (number): Cadencia configurada de alertas en minutos.
  • minIntervalMinutes (number): Cadencia más rápida permitida por el plan actual.
  • availableCadences (number[]): Valores de cadencia disponibles para el plan actual.

Notas

minIntervalMinutes es la cadencia más rápida permitida por el plan actual.

Errores

  • 400 Bad Request: Entrada, URL, UUID, enum, parámetro de consulta o cuerpo no válido.
  • 401 Unauthorized: Bearer token ausente o no válido, o code: "token_issuer_lost_access" cuando la persona que creó la clave API fue desactivada o salió del workspace.
  • 403 Forbidden: code: "subscription_required" cuando el plan del workspace no incluye acceso a la API, code: "workspace_access_denied" cuando X-Workspace-Id indica un workspace al que esta credencial no puede acceder, o code: "permission_denied" cuando tu rol en el workspace no tiene el permiso redreplier.write (lo tienen Admin y Editor).
  • 404 Not Found: El recurso no existe para la cuenta del token.
  • 429 Too Many Requests: Límite de solicitudes superado. Espera los segundos indicados en Retry-After.
  • 500 Internal Server Error: Error inesperado del servidor.
Solicitud de ejemplo (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/alert-settings \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "enabled": true,
  "cadenceMinutes": 240,
  "minIntervalMinutes": 60,
  "availableCadences": [60, 120, 180, 240, 720, 1440]
}