الرسائل
أدر سلاسل الرسائل الفردية في مشروع وأضف إليها رسائل.
GET/v1/messages
| Parameter | Type | Description |
|---|---|---|
status | string | تصفية السلاسل: open أو closed. |
limit | integer | حجم الصفحة. الافتراضي 20. |
offset | integer | عدد العناصر المراد تخطّيها. الافتراضي 0. |
GET/v1/messages/:threadId
POST/v1/messages
| Parameter | Type | Description |
|---|---|---|
emailrequired | string | البريد الإلكتروني للمستخدم النهائي المعني بالسلسلة. |
name | string | اسم العرض للمستخدم النهائي. |
subject | string | موضوع السلسلة. |
body | string | رسالة أولى اختيارية في السلسلة. |
locale | string | لغة رسائل الإشعار التي يُطلقها هذا (en, ar, de, es, fr, he, hi, it, ja, ru, zh). الافتراضي en. |
PATCH/v1/messages/:threadId
| Parameter | Type | Description |
|---|---|---|
status | string | open أو closed. |
subject | string | موضوع جديد للسلسلة. |
DELETE/v1/messages/:threadId
POST/v1/messages/:threadId/messages
| Parameter | Type | Description |
|---|---|---|
bodyrequired | string | نص الرسالة. |
sender | string | end_user أو member أو system. الافتراضي member. |
locale | string | لغة رسائل الإشعار التي يُطلقها هذا (en, ar, de, es, fr, he, hi, it, ja, ru, zh). الافتراضي en. |
تتطلّب الكتابات وصول API بخطة مدفوعة Pro.
الإشعارات: الكتابة تصل إلى أشخاص، ويُوجَّه ذلك حسب من تكلّم.
| المرسِل | من يُشعَر |
|---|---|
end_user | أعضاء المشروع، وفق تفضيلات إشعاراتهم — إضافةً إلى Slack والويب هوك الصادرة والإشعارات الفورية |
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