صناديق البريد

إنشاء صندوق

POSThttps://api.temporam.com/v3/mailboxes

الحقلالنوعمطلوبالوصف
domainstringنعمنطاق أرجعته نقطة النطاقات
local_partstringلاالجزء المحلي، ويُنشأ عند حذفه
  1. 1curl -X POST https://api.temporam.com/v3/mailboxes \
  2. 2 -H "Authorization: Bearer YOUR_API_KEY" \
  3. 3 -H "Content-Type: application/json" \
  4. 4 -d '{"domain":"temporam.com","local_part":"demo"}'
حقل الاستجابةالنوعالوصف
data.idstringمعرّف صندوق البريد
data.addressstringعنوان صندوق البريد الكامل
data.local_partstringالجزء المحلي من العنوان
data.domainstringنطاق العنوان
data.statusstringحالة صندوق البريد
data.created_atstringوقت الإنشاء
meta.remainingintegerالحصة المتبقية ذات الصلة عند توفرها

عرض الصناديق

GEThttps://api.temporam.com/v3/mailboxes

المعلمةالموقعالنوعمطلوبالافتراضيالوصف
pagequeryintegerلا1رقم الصفحة
limitqueryintegerلا20عدد العناصر في الصفحة
حقل الاستجابةالنوعالوصف
dataarrayصناديق البريد بالحقول الموضحة أعلاه
meta.totalintegerالعدد الإجمالي لصناديق البريد
meta.pageintegerالصفحة الحالية
meta.limitintegerعدد العناصر في الصفحة
meta.remainingintegerالحصة المتبقية ذات الصلة عند توفرها

الاستعلام عن صندوق

GEThttps://api.temporam.com/v3/mailboxes/{id}

المعلمةالموقعالنوعمطلوبالوصف
idpathstringنعممعرّف صندوق البريد
حقل الاستجابةالنوعالوصف
dataobjectتفاصيل صندوق البريد بالحقول الموضحة أعلاه
meta.remainingintegerالحصة المتبقية ذات الصلة عند توفرها

حذف صندوق

DELETEhttps://api.temporam.com/v3/mailboxes/{id}

المعلمةالموقعالنوعمطلوبالوصف
idpathstringنعممعرّف صندوق البريد
حقل الاستجابةالنوعالوصف
data.deletedbooleanتكون دائمًا true عند نجاح الحذف
meta.remainingintegerالحصة المتبقية ذات الصلة عند توفرها