API-ReferenzGET
Alert-Einstellungen abrufen
Liest die E-Mail-Alert-Einstellungen für neue relevante Mentions inklusive der vom Tarif erlaubten Kadenzen.
GET
https://ai.redreplier.com/ai-app/api/v1/alert-settingsLiest die E-Mail-Alert-Einstellungen für neue relevante Mentions inklusive der vom Tarif erlaubten Kadenzen.
Bearer-Token (RedReplier-API-Token)
Parameter
Dieser Endpoint hat keine Pfad- oder Query-Parameter.
Request-Body
Dieser Endpoint benötigt keinen JSON-Body.
Antwort
Gibt Alert-Einstellungen für das Token-Konto zurück.
enabled(boolean): Gibt an, ob E-Mail-Alerts aktiviert sind.cadenceMinutes(number): Konfigurierte Alert-Kadenz in Minuten.minIntervalMinutes(number): Schnellste vom aktuellen Tarif erlaubte Kadenz.availableCadences(number[]): Für den aktuellen Tarif verfügbare Kadenzwerte.
Hinweise
minIntervalMinutes ist die schnellste vom aktuellen Tarif erlaubte Kadenz.
Fehler
400 Bad Request: Ungültige Eingabe, URL, UUID, Enum, Query-Parameter oder Body.401 Unauthorized: Fehlendes oder ungültiges Bearer-Token, odercode: "token_issuer_lost_access", wenn die Person, die den API-Schlüssel erstellt hat, deaktiviert wurde oder den Workspace verlassen hat.403 Forbidden:code: "subscription_required", wenn der Tarif des Workspace keinen API-Zugang enthält,code: "workspace_access_denied", wennX-Workspace-Ideinen Workspace nennt, den diese Zugangsdaten nicht erreichen, odercode: "permission_denied", wenn Ihre Rolle im Workspace die Berechtigungredreplier.writenicht hat (Admin und Editor haben sie).404 Not Found: Die Ressource existiert nicht für das Token-Konto.429 Too Many Requests: Rate-Limit überschritten. Warten Sie die Sekunden ausRetry-Afterab.500 Internal Server Error: Unerwarteter Serverfehler.
Beispielanfrage (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]
}