مرجع واجهة برمجة التطبيقات العامة
نقاط النهاية والنطاقات والأمثلة للتذاكر والرسائل والإجراءات.
استخدم مفاتيح API ذات النطاقات لإدارة التذاكر متعددة القنوات والإجراءات من أنظمتك.
عنوان URL الأساسي
جميع الطلبات تمر عبر البوابة العامة.
https://api.threada.ai المصادقة
- أرسل مفتاح API في ترويسة `X-Api-Key`.
- أنشئ ودوّر المفاتيح في Admin → API keys؛ مفتاح واحد لكل تكامل.
- المفاتيح مقيّدة بالمستأجر وتطبّق أقل الصلاحيات عبر النطاقات.
النطاقات
- `support.read` — عرض التذاكر والرسائل والإجراءات واسترجاعها.
- `support.write` — إنشاء/تحديث التذاكر وإضافة الرسائل.
- `support.actions` — تنفيذ الإجراءات والاستعلام عن حالتها.
الترقيم
- نقاط نهاية القوائم تقبل `limit` و`page_token`.
- مرّر قيمة `next_page_token` في الطلب التالي.
الأخطاء
- الأخطاء تُرجع `{ error: { type, message, code } }`.
- رموز HTTP تعكس قيمة `code`.
أمثلة الطلب والاستجابة
عرض التذاكر
احصل على التذاكر المفتوحة عبر جميع القنوات.
طلب
curl -X GET "https://api.threada.ai/api/v1/public/tickets?limit=25" \
-H "X-Api-Key: YOUR_API_KEY" استجابة
{
"items": [
{
"ticket_id": "TICKET_ID",
"tenant_id": "TENANT_ID",
"subject": "SUBJECT",
"status": "open",
"priority": "normal",
"channel": "email",
"tags": ["vip", "returns"],
"last_message_at": "2026-02-04T18:32:11Z"
}
],
"next_page_token": "NEXT_PAGE_TOKEN"
} إنشاء تذكرة
افتح تذكرة جديدة مع رسالة أولية.
طلب
curl -X POST "https://api.threada.ai/api/v1/public/tickets" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"subject": "SUBJECT",
"priority": "normal",
"channel": "email",
"contact": {
"name": "CUSTOMER_NAME",
"email": "customer@example.com"
},
"tags": ["returns"],
"initial_message": {
"role": "user",
"content": "MESSAGE_BODY",
"external_message_id": "EXT_MSG_ID"
}
}' استجابة
{
"ticket": {
"summary": {
"ticket_id": "TICKET_ID",
"tenant_id": "TENANT_ID",
"subject": "SUBJECT",
"status": "open",
"priority": "normal",
"channel": "email",
"tags": ["returns"],
"created_at": "2026-02-04T18:32:11Z"
},
"contact": {
"name": "CUSTOMER_NAME",
"email": "customer@example.com"
},
"messages": [
{
"message_id": "MESSAGE_ID",
"role": "user",
"content": "MESSAGE_BODY",
"channel": "email",
"created_at": "2026-02-04T18:32:11Z"
}
]
}
} تنفيذ إجراء
نفّذ أتمتة HTTP مخصصة لتذكرة.
طلب
curl -X POST "https://api.threada.ai/api/v1/public/tickets/TICKET_ID/actions" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"payload": {
"type": "custom_http",
"method": "POST",
"url": "/hooks/zapier",
"headers": {
"X-Source": "threada"
},
"body_json": "{\"event\":\"ticket_updated\"}"
}
}' استجابة
{
"action": {
"action_id": "ACTION_ID",
"tenant_id": "TENANT_ID",
"ticket_id": "TICKET_ID",
"action_type": "custom_http",
"status": "succeeded",
"requested_by": "api_key:API_KEY_ID",
"payload": {
"type": "custom_http",
"method": "POST",
"url": "/hooks/zapier",
"headers": {
"X-Source": "threada"
},
"body_json": "{\"event\":\"ticket_updated\"}"
}
}
} تحتاج نقاط نهاية إضافية؟
تواصل معنا للوصول الموسع والحدود الأعلى واتفاقيات مستوى الخدمة للمؤسسات.
تواصل مع المبيعات