Skip to Content
חוברת ה-APIהודעות

הודעות

נהלו את שרשורי ההודעות אחד-על-אחד של פרויקט והוסיפו אליהם הודעות.

GET/v1/messages

ParameterTypeDescription
statusstringסינון שרשורים: open או closed.
limitintegerגודל עמוד. ברירת המחדל היא 20.
offsetintegerמספר הפריטים לדילוג. ברירת המחדל היא 0.

GET/v1/messages/:threadId

POST/v1/messages

ParameterTypeDescription
emailrequiredstringהאימייל של משתמש הקצה שאיתו מתנהל השרשור.
namestringשם תצוגה למשתמש הקצה.
subjectstringנושא השרשור.
bodystringהודעה ראשונה אופציונלית בשרשור.
localestringהשפה למיילי ההתראה שזה מפעיל (en, ar, de, es, fr, he, hi, it, ja, ru, zh). ברירת המחדל היא en.

PATCH/v1/messages/:threadId

ParameterTypeDescription
statusstringopen או closed.
subjectstringנושא חדש לשרשור.

DELETE/v1/messages/:threadId

POST/v1/messages/:threadId/messages

ParameterTypeDescription
bodyrequiredstringטקסט ההודעה.
senderstringend_user, member או system. ברירת המחדל היא member.
localestringהשפה למיילי ההתראה שזה מפעיל (en, ar, de, es, fr, he, hi, it, ja, ru, zh). ברירת המחדל היא en.

פעולות כתיבה דורשות גישת API בתוכנית בתשלום Pro.

התראות: כתיבה מגיעה לאנשים, בניתוב לפי מי שדיבר.

שולחמי מקבל התראה
end_userחברי הפרויקט, לפי העדפות ההתראות שלהם — בנוסף ל-Slack, ל-webhooks יוצאים ולהתראות דחיפה
memberמשתמש הקצה, במייל, משורשר לתוך השיחה
systemאף אחד

POST /v1/messages עם body רושם את הגוף הזה כהודעת member, ולכן הוא שולח מייל למשתמש הקצה. המסירה רצה אחרי התגובה, כך שההתראות לעולם אינן מעכבות את הבקשה שלכם.

העבירו locale אופציונלי (en, ar, de, es, fr, he, hi, it, ja, ru, zh) בכל פעולת כתיבה כדי לבחור את שפת המיילים שהיא מפעילה. בהיעדרו ← אנגלית.

רשימת שרשורים

curl "https://api.supdesk.app/v1/messages?status=open&limit=20" \ -H "Authorization: Bearer sd_live_..."
{ "data": [ { "id": "t_abc123", "end_user_id": "eu_xyz789", "subject": "Question about export feature", "status": "open", "created_at": "2026-07-01T10:00:00Z" } ], "pagination": { "limit": 20, "offset": 0, "has_more": false } }

קבלת שרשור

curl "https://api.supdesk.app/v1/messages/t_abc123" \ -H "Authorization: Bearer sd_live_..."
{ "data": { "id": "t_abc123", "end_user_id": "eu_xyz789", "subject": "Question about export feature", "status": "open", "created_at": "2026-07-01T10:00:00Z", "messages": [ { "id": "m_123", "sender": "end_user", "member_id": null, "body": "I'm having trouble with the export button.", "via": "email", "created_at": "2026-07-01T10:05:00Z" }, { "id": "m_456", "sender": "member", "member_id": "mem_789", "body": "Which browser are you using? This might be a Safari-specific issue.", "via": "web", "created_at": "2026-07-01T10:10:00Z" } ] } }

יצירת שרשור

curl -X POST https://api.supdesk.app/v1/messages \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "email": "jamie@example.com", "name": "Jamie", "subject": "Question about export feature", "body": "I'm having trouble with the export button on Safari." }'
{ "data": { "id": "t_abc123", "end_user_id": "eu_xyz789", "subject": "Question about export feature", "status": "open", "created_at": "2026-07-01T10:00:00Z", "messages": [ { "id": "m_456", "sender": "member", "member_id": "mem_789", "body": "I'm having trouble with the export button on Safari.", "via": "web", "created_at": "2026-07-01T10:00:00Z" } ] } }

עדכון שרשור

curl -X PATCH https://api.supdesk.app/v1/messages/t_abc123 \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "status": "closed", "subject": "Resolved: Export button issue" }'
{ "data": { "id": "t_abc123", "end_user_id": "eu_xyz789", "subject": "Resolved: Export button issue", "status": "closed", "created_at": "2026-07-01T10:00:00Z" } }

מחיקת שרשור

curl -X DELETE https://api.supdesk.app/v1/messages/t_abc123 \ -H "Authorization: Bearer sd_live_..."

מחזיר 204 No Content בהצלחה.

הוספת הודעה לשרשור

curl -X POST https://api.supdesk.app/v1/messages/t_abc123/messages \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "body": "This issue has been fixed in version 1.4.0.", "sender": "member" }'
{ "data": { "id": "m_789", "sender": "member", "member_id": "mem_789", "body": "This issue has been fixed in version 1.4.0.", "via": "web", "created_at": "2026-07-01T11:00:00Z" } }
Last updated on