Dokumentacja APIPUT

Zaktualizuj ustawienia alertów

Włącz lub wyłącz alerty e-mail o nowych trafnych wzmiankach i ustaw, jak często RedReplier ma je wysyłać.

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

Włącz lub wyłącz alerty e-mail o nowych trafnych wzmiankach i ustaw, jak często RedReplier ma je wysyłać.

Token Bearer (token API RedReplier)

Uwierzytelnianie

Wysyłaj token API RedReplier jako token Bearer w każdym żądaniu. Tokeny zaczynają się od redreplier_; RedReplier ustala konto na podstawie tokena. Wyślij X-Workspace-Id, aby działać w obszarze roboczym innym niż domyślny; zobacz Lista obszarów roboczych.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

Ten endpoint nie przyjmuje parametrów ścieżki ani zapytania.

Treść żądania

  • enabled (boolean, wymagany): Włącza lub wyłącza alerty e-mail.
  • cadenceMinutes (integer, opcjonalny): Odstęp między podsumowaniami w minutach, jedna z wartości 15, 30, 60, 120, 180, 240, 720 lub 1440; każda inna zwraca 400. Pominięcie parametru przywraca najkrótszy odstęp dozwolony w planie, więc wysyłaj bieżącą wartość, gdy przełączasz tylko enabled.

Odpowiedź

Zwraca ustawienia alertów dla konta powiązanego z tokenem.

  • enabled (boolean): Czy alerty e-mail są włączone.
  • cadenceMinutes (number): Ustawiona częstotliwość alertów w minutach.
  • minIntervalMinutes (number): Najkrótszy odstęp dozwolony w obecnym planie.
  • availableCadences (number[]): Wartości częstotliwości dostępne w obecnym planie.

Przykładowe żądanie

curl -X PUT https://ai.redreplier.com/ai-app/api/v1/alert-settings \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"cadenceMinutes":240}'

Uwagi

Jeśli żądana częstotliwość jest wyższa, niż pozwala plan, RedReplier ogranicza ją do minIntervalMinutes.

Błędy

  • 400 Bad Request: Nieprawidłowe dane wejściowe, URL, UUID, wartość enum, parametr zapytania lub treść żądania.
  • 401 Unauthorized: Brak tokena Bearer lub nieprawidłowy token albo code: "token_issuer_lost_access", gdy osoba, która utworzyła klucz API, została dezaktywowana lub opuściła obszar roboczy.
  • 403 Forbidden: code: "subscription_required", gdy plan obszaru roboczego nie obejmuje dostępu do API, code: "workspace_access_denied", gdy X-Workspace-Id wskazuje obszar roboczy niedostępny dla tych poświadczeń, lub code: "permission_denied", gdy twoja rola w obszarze roboczym nie ma uprawnienia redreplier.write (mają je Administrator i Edytor).
  • 404 Not Found: Zasób nie istnieje dla konta powiązanego z tokenem.
  • 429 Too Many Requests: Przekroczono limit żądań. Odczekaj liczbę sekund podaną w Retry-After.
  • 500 Internal Server Error: Nieoczekiwany błąd serwera.
Przykładowe żądanie (curl)
curl --request PUT \
  --url https://ai.redreplier.com/ai-app/api/v1/alert-settings \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true,"cadenceMinutes":240}'
200
{
  "enabled": true,
  "cadenceMinutes": 240,
  "minIntervalMinutes": 60,
  "availableCadences": [60, 120, 180, 240, 720, 1440]
}