תיעוד
API של האזור האישי

הודעות

Markdown

מתודות, שדות בקשה ותשובות.

המדריך המלא

מספר המתודות בסעיף: 1. פתחו מתודה כדי לראות את תנאי הגישה, שדות הבקשה והתשובה.

מתודה ונתיבתיאורגישה
GET /api/v1/announcementsרשימה — הודעותטוקן של האזור האישי
GET /api/v1/announcements — רשימה — הודעות

גישה: טוקן של האזור האישי

GET/api/v1/announcements
קריאה; המזהה נלקח מהתשובה הקודמת שקיבלתם
curl --fail-with-body "https://ailoot.ai/api/v1/announcements" \
  -H "Authorization: Bearer $TOKEN"

פרמטרי Query

השדהטיפוסחובהבדיקה / תיאור
unread_onlybooleanלא

אין צורך בגוף בקשה. העבירו את הפרמטרים המפורטים לעיל ב-URL.

תשובה

תשובת JSON מכילה code, message ו-data. תוכן data מתואר בסכמות שלהלן.

סכמות הנתונים של התשובה: UserAnnouncement. השדות והטיפוסים מופיעים בעמודי "סכמות נתונים".

אם אפשריים כמה מבני תשובה, השדות שלהם מפורטים בסכמות נפרדות; אין לאחד אותם לאובייקט אחד.

מאפיינים: כל הנתונים האישיים והאובייקטים מוגבלים לזהות ה-subject ב-JWT.

נשארו שאלות? שלחו Request ID ותיאור — נעזור לברר.פנייה לתמיכה