Skip to Content
API संदर्भसंदेश

संदेश

किसी प्रोजेक्ट के 1:1 संदेश थ्रेड प्रबंधित करें और उनमें संदेश जोड़ें।

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कोई नहीं

body के साथ POST /v1/messages उस बॉडी को 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