Referência da APIGET

Obter configurações de alerta

Lê as configurações de alerta por e-mail para novas menções relevantes.

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

Lê as configurações de alerta por e-mail para novas menções relevantes.

Token Bearer (token de API do RedReplier)

Parâmetros

Este endpoint não aceita parâmetros de caminho nem de consulta.

Corpo da requisição

Este endpoint não exige um corpo JSON.

Resposta

Retorna as configurações de alerta da conta do token.

  • enabled (boolean): Indica se alertas por e-mail estão ativados.
  • cadenceMinutes (number): Cadência de alerta configurada em minutos.
  • minIntervalMinutes (number): Cadência mais rápida permitida pelo plano atual.
  • availableCadences (number[]): Valores de cadência disponíveis para o plano atual.

Notas

minIntervalMinutes é a cadência mais rápida permitida pelo plano atual.

Erros

  • 400 Bad Request: Entrada, URL, UUID, enum, parâmetro de consulta ou corpo inválido.
  • 401 Unauthorized: Bearer token ausente ou inválido, ou code: "token_issuer_lost_access" quando a pessoa que criou a chave API foi desativada ou saiu do workspace.
  • 403 Forbidden: code: "subscription_required" quando o plano do workspace não inclui acesso à API, code: "workspace_access_denied" quando X-Workspace-Id indica um workspace que esta credencial não pode alcançar, ou code: "permission_denied" quando seu papel no workspace não tem a permissão redreplier.write (Admin e Editor têm).
  • 404 Not Found: O recurso não existe para a conta do token.
  • 429 Too Many Requests: Limite de requisições excedido. Aguarde os segundos indicados em Retry-After.
  • 500 Internal Server Error: Erro inesperado do servidor.
Exemplo de solicitação (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]
}