Paziņojumu API

Pārvaldiet e-pasta un Teams paziņojumu iestatījumus autentificētajam nomniekam.

Iegūt paziņojumu iestatījumus

GET /tenants/me/notifications

Pieprasījuma piemērs

curl https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>"

Atbildes piemērs

{
  "success": true,
  "data": {
    "emailOnComplete": true,
    "emailOnFail": true,
    "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }
}

Atbildes lauki

Lauks	Tips	Apraksts
emailOnComplete	boolean	Sūtīt e-pastu, kad skenēšana veiksmīgi pabeigta
emailOnFail	boolean	Sūtīt e-pastu, kad skenēšana neizdodas
teamsWebhookUrl	string vai null	Microsoft Teams ienākošā webhook URL
teamsOnComplete	boolean	Publicēt Teams, kad skenēšana pabeigta
teamsOnFail	boolean	Publicēt Teams, kad skenēšana neizdodas

---

Atjaunināt paziņojumu iestatījumus

Atjaunina paziņojumu iestatījumus. Tiek mainīti tikai tie lauki, kurus iekļaujat.

PATCH /tenants/me/notifications

Pieprasījuma pamatteksts

Visi lauki ir neobligāti. Iekļaujiet tikai tos laukus, kurus vēlaties mainīt.

{
  "emailOnComplete": true,
  "emailOnFail": true,
  "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
  "teamsOnComplete": true,
  "teamsOnFail": false
}

Piemērs: iespējot Teams paziņojumus

curl -X PATCH https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "teamsWebhookUrl": "https://outlook.office.com/webhook/your-webhook-url",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }'

Piemērs: atspējot visus e-pasta paziņojumus

curl -X PATCH https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "emailOnComplete": false,
    "emailOnFail": false
  }'

Atbildes piemērs

{
  "success": true,
  "data": {
    "emailOnComplete": false,
    "emailOnFail": false,
    "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }
}

Kļūdas

Kods	HTTP	Apraksts
AUTH_INSUFFICIENT_SCOPE	403	Nepietiekamas tiesības šai darbībai
VALIDATION_ERROR	400	Nederīgs webhook URL formāts