Référence de l'APIGET

Obtenir les paramètres d’alerte

Lit les paramètres d’alerte e-mail pour les nouvelles mentions pertinentes.

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

Lit les paramètres d’alerte e-mail pour les nouvelles mentions pertinentes.

Jeton Bearer (jeton API RedReplier)

Paramètres

Cet endpoint ne prend aucun paramètre de chemin ou de requête.

Corps de la requête

Cet endpoint ne nécessite aucun corps JSON.

Réponse

Renvoie les paramètres d’alerte du compte lié au token.

  • enabled (boolean): Indique si les alertes e-mail sont activées.
  • cadenceMinutes (number): Cadence d’alerte configurée en minutes.
  • minIntervalMinutes (number): Cadence la plus rapide autorisée par l’abonnement actuel.
  • availableCadences (number[]): Valeurs de cadence disponibles pour l’abonnement actuel.

Notes

minIntervalMinutes est la cadence la plus rapide autorisée par l’abonnement actuel.

Erreurs

  • 400 Bad Request: Entrée, URL, UUID, enum, paramètre de requête ou corps non valide.
  • 401 Unauthorized: Bearer token manquant ou non valide, ou code: "token_issuer_lost_access" quand la personne qui a créé la clé API a été désactivée ou a quitté l'espace de travail.
  • 403 Forbidden: code: "subscription_required" quand l'abonnement de l'espace de travail n'inclut pas l'accès à l'API, code: "workspace_access_denied" quand X-Workspace-Id désigne un espace de travail que ces identifiants ne peuvent pas atteindre, ou code: "permission_denied" quand votre rôle dans l'espace de travail n'a pas la permission redreplier.write (Admin et Editor l'ont).
  • 404 Not Found: La ressource n’existe pas pour le compte du token.
  • 429 Too Many Requests: Limite de débit dépassée. Attendez le nombre de secondes indiqué dans Retry-After.
  • 500 Internal Server Error: Erreur serveur inattendue.
Exemple de requête (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]
}