Pranešimų API

Autorius: Aether365 komanda Auditorija: Kūrėjai Apimtis: Pranešimų nustatymų API galutiniai taškai

Valdykite el. pašto ir Teams pranešimų nustatymus autentifikuotai organizacijai.

Pranešimų nustatymų gavimas

GET /tenants/me/notifications

Užklausos pavyzdys

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

Atsakymo pavyzdys

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

Atsakymo laukai

Laukas	Tipas	Aprašymas
emailOnComplete	boolean	Siųsti el. laišką, kai nuskaitymas sėkmingai baigiamas
emailOnFail	boolean	Siųsti el. laišką, kai nuskaitymas nepavyksta
teamsWebhookUrl	string arba null	Microsoft Teams įeinančio webhook URL
teamsOnComplete	boolean	Skelbti Teams kanale, kai nuskaitymas baigiamas
teamsOnFail	boolean	Skelbti Teams kanale, kai nuskaitymas nepavyksta

---

Pranešimų nustatymų atnaujinimas

Atnaujina pranešimų nustatymus. Keičiami tik tie laukai, kuriuos įtraukiate.

PATCH /tenants/me/notifications

Užklausos turinys

Visi laukai neprivalomi. Įtraukite tik tuos laukus, kuriuos norite pakeisti.

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

Pavyzdys: Teams pranešimų įjungimas

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
  }'

Pavyzdys: visų el. pašto pranešimų išjungimas

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

Atsakymo pavyzdys

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

Klaidos

Kodas	HTTP	Aprašymas
AUTH_INSUFFICIENT_SCOPE	403	Nepakankamos teisės šiam veiksmui
VALIDATION_ERROR	400	Neteisingas webhook URL formatas