ابدأ هنا
طلبك الأول في أربع خطوات
نجمع صندوق بريد في لوحة التحكم
نسخ كلا من الآبيكي و صندوق البريد
أرسل رسالة إلكترونية بسيطة أولاً
لا تضيف ملحقات أو صور مدمجة إلا بعد أن يعمل الطلب الأساسي.
WEBHOOK V2 لواجهة API هذه
اشترك فقط في أحداث الأجهزة المحمولة التي يحتاجها سير عملك.
يمكن لوجهة واحدة استقبال كل شيء، أو يمكنك فصل أنظمة الإنتاج والتحليلات والتنبيهات التشغيلية. كل حدث له اسم دقيق حتى يتعامل تطبيقك معه بشكل متوقّع.
email.sentتم إرسال بريد إلكتروني.
تم إنشاء طلب إرسال بريد إلكتروني بواسطة SMSMobileAPI.
email.receivedتم استلام بريد إلكتروني.
استلم صندوق بريد متصل رسالة إلكترونية.
المصادقة
حافظ على أوراق اعتمادك على خادمك
نقاط نهاية البريد تتطلب حساباً من "أبيكي" و صندوق بريدي محدد تخزين كلا من خادم وثائق التفويض وقناعها في سجلات الطلبات.
إدارة التاريخ
تاريخ واضح بأمان: استعراض أولي، حذف، متابعة التقدم
هذه النقط النهائية تُوضّح تاريخ الخادم المختار لك API مفتاح، وليس رسائل على الهواتف أو الخدمات الخارجية. ولا توفر هذه البلدان فترة من الحساب. النشاط الجديد يمكن أن يظهر بعد الإنزال
اقرأ request_id دليل إعادة التأهيل
وبحسب التخلف، تظل السجلات المرتبطة أو المعالجة مرئية. فقط استخدام include_linked=1 إذا قبلت أن الإدماج أو التجهيزات الجارية قد تتوقف عن العمل
كيف request_id الأشغال
- تمهيد العد action=previewلا request_id ويلزم عدم حذف أي سجلات.
- جيل فريد request_id لحذف جديد، على سبيل المثال UUIDأنقذه قبل إرساله action=delete-
- للمراكز أو الإجازات أو HTTP 202، إعادة استخدام نفس API مفتاح، نقطة نهاية التاريخ، request_id و include_linked قيمة لا تولد هوية جديدة تلقائياً بعد خطأ
- عندما completed=trueلقد انتهت العملية ويعود استخدام بطاقة هويتها بنفس النتيجة بدلا من حذف السجلات التي وصلت حديثا. استخدم هوية جديدة فقط لتنظيف جديد متعمد
request_id يحدد عملية حذفك، وليس فرد SMSالشكل المسموح به: ١٦-١٢٨ ASCII رسائل، أرقام، فيتامينات أو تأكيدات ألف UUID مُولّد بالبريدوتو..
يُنفذ الحذف على دفعات. إذا كانت الاستجابة HTTP 202 ومعها continue_required=true، فأعد طلب action=delete بعد 3 ثوانٍ. لا تعمل مهمة cron في الخلفية. يقرأ action=status التقدم فقط ولا يتابع الحذف، حتى لو كانت الاستجابة HTTP 200.
أمثلة للحذف والوضع
يستعاض عن العينة request_id مع قيمتك الفريدة قبل أن تبدأ وتُغيّر الطلبات الواردة أدناه تاريخ الحساب الحقيقي؛ وهي ليست استعراضات مسبقة.
curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
-H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -G "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=status" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"GET أيضاً تقبل action=preview أو action=delete- POST يوصى بما يلي: يمكن أن تتسرب البارامترات الأوروبية إلى تاريخ المروج وسجلات الخواديم. لا تضع أبداً انحرافاً في حلقة عامة أو صورة أو مفترقة
للاستعداد POSTأرسل كل المعالم في هيئة أو JSON اعترض، لا يوجد في سلسلة الاستفسارات وتُرفض المعايير غير المعروفة؛ ولا تدعم المواصفات المتحركة أو المرشّحات.
التوثيق بالنسبة لنقاط نهاية التاريخ
الاستخدام apikey أو Authorization: Bearer منفذ SMSMobileAPI OAuth2لا ترسلوا مركباً جديداً أو API مفتاح كـ Bearer مُتَحدّد. تم رفض المكسورين المفصولين
عندما يتم تحديد النطاقات history:read يسمح بالفحص الأولي/الوضع history:delete كما يسمح بالحذف. القيود المفروضة على كل من المكسورين OAuth زبونة تتقدم وتحتفظ المكسورات غير المزودة بنطاقات بالحسابات الموجودة.
OAuth2 يختارون المُصدر الفريد API مفتاح إذا كان هناك عدة مفاتيح رئيسية، تقدم أيضاً apikey لاختيار واحد من ممتلكات الحساب. مفاتيح الثانوية لا تسمح أبداً بالدخول إلى التاريخ الرئيسي
اقرأ الرد قبل مواصلة
count_delete هو العدد التراكمي الذي أزالته هذه العملية. selected_at_start (أ) الاختيار الأولي؛ protected_at_start يحسب السجلات المستبعدة. الاستخدام preview.linked_or_processing حتى عندما يُحسب include_linked=1-
{
"result": {
"error": 0,
"history": "email",
"action": "delete",
"request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
"status": "processing",
"completed": false,
"count_delete": 100,
"total_before": 250,
"selected_at_start": 200,
"protected_at_start": 50,
"include_linked": 0,
"continue_required": true,
"message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
}
}- 200 مع completed=true: أنهيت ولا يثبت أن هناك 200 من الردود المسبقة أو الحالة لا تكتمل وحدها.
- 400 INVALID_REQUEST_ID: تحقق من الشكل 404 REQUEST_NOT_FOUNDلا توجد عملية لهذا الهوية API مفتاح وتاريخ
- 401: وثائق تفويض غير صحيحة أو منتهية الصلاحية. 403: عدم كفاية نطاق OAuth أو حساب غير مأذون به.
- 409 HISTORY_BUSY: تطهير آخر يجري؛ مواصلة تشغيله من العميل الأصلي. 409 INCLUDE_LINKED_CONFLICT: اعيدوا الأصل include_linked قيمة
- 409 OAUTH_ACCOUNT_AMBIGUOUS: توفير API مفتاح هذا الحساب
- 503 أو انقطاع الشبكات: قد تكتمل بالفعل بعض الخفافيش. التكوين الشيكى، ثم العودة مع الأصلي request_id- لا تخلق عملية بديلة تلقائيا.
بريد
أرسل رسالة إلكترونية
https://api.smsmobileapi.com/sendemail/يرسل رسالة واضحة أو بريد إلكتروني من خلال صندوق بريد مُحدّد.
استخدمه في البريد الإلكتروني أو العملي من طلبك
حدود
| الاسم | يكتب | الاحتياجات | وصف |
|---|---|---|---|
apikey |
خيط | مطلوب | حسابك (زكى 8كى زى) |
apikeybox |
خيط | مطلوب | مفتاح صندوق البريد المكون |
sender_name |
خيط | مطلوب | اكتب اسم المرسل |
sender_email |
بريد إلكتروني | مطلوب | عنوان البريد الإلكتروني |
recipient_email |
بريد إلكتروني | مطلوب | عنوان متلقي |
mail_subject |
خيط | مطلوب | ارسال |
mail_body |
خيط | مطلوب | رسالة نصية أو جثة (هاب كي إل) |
allow_self_signed |
نعم لا | مطلوب | لن تُوافق إلا عندما يستخدم خادم البريد المُشكل شهادة مُثق بها ذاتية مُوقعة |
unsubscribe |
1 | الاختياري | يضيف شروط غير مقصودة وربطة |
email_cc1 |
بريد إلكتروني | الاختياري | أول متلقي اختياري لـ (سي.آي.سي) |
email_cc2 |
بريد إلكتروني | الاختياري | ثاني مستفيد من برنامج (سي.آي) |
email_cc3 |
بريد إلكتروني | الاختياري | ثالث مستفيد من برنامج (سي.أ.ك) |
attachmentBase64 |
القاعدة 64 | الاختياري | محتوى المرفق المشفر بتنسيق Base64. |
attachmentBase64_name_1 |
الاسم | الاختياري | Original attachment file name with extension, for example invoice.pdf. مطلوب عندما يكون لـ (ملحق (باسي 64 قيمة |
charset |
خيط | الاختياري | مجموعة من المصنفات، وفرقة عمل واحدة من طراز UTF-8. |
embeddedImage |
تدق العجلات | الاختياري | أتخيل أن ندخل في البريد الإلكتروني |
embeddedImage_cid |
خيط | الاختياري | إشارة إلى وحدة التحكم في الممتلكات من هيئة HTML. |
format |
خيط | الاختياري | استمارة الاستجابة المطلوبة. |
reply_name |
خيط | الاختياري | جواب إلى اسمِ عرضِ. |
reply_email |
بريد إلكتروني | الاختياري | رد على العنوان |
مثال
curl -X POST "https://api.smsmobileapi.com/sendemail/" \
-d "apikey=YOUR_API_KEY" \
-d "apikeybox=YOUR_MAILBOX_KEY" \
--data-urlencode "sender_name=Example Team" \
-d "sender_email=team@example.com" \
-d "recipient_email=customer@example.net" \
--data-urlencode "mail_subject=Order confirmation" \
--data-urlencode "mail_body=Your order has been confirmed." \
--data-urlencode "attachmentBase64=BASE64_FILE_CONTENT" \
-d "attachmentBase64_name_1=invoice.pdf" \
-d "allow_self_signed=no"
هل تريد أن تدير هذا الطلب؟اتصل بمفتاحك في أعلى الصفحة لفتح المُختبر التفاعلي
مفتاح الوصل- أفضل "بي أو تي" لأنّ أجهزة البريد الإلكتروني قد تكون طويلة
- وإذا قُدم الملحق رقم 64، فإن الضبط رقم 1 مطلوب ويجب أن يشمل تمديد الملف.
- ملحقات القاعدة 64 يمكنها أن تقدم طلبات كبيرة، وتطبيق حدود معقولة في حجم تطبيقك.
يحصل
استرجعوا الرسائل
https://api.smsmobileapi.com/getemail/يسترد رسائل من ملف بريدي مجهز
استخدمها لتزامن البريد الإلكتروني في مكتب المساعدة أو تدفق العمل
حدود
| الاسم | يكتب | الاحتياجات | وصف |
|---|---|---|---|
apikey |
خيط | مطلوب | حسابك (زكى 8كى زى) |
apikeybox |
خيط | مطلوب | مفتاح صندوق البريد API. |
mbox |
خيط | مطلوب | ملف صندوق البريد، على سبيل المثال إنبوكس |
start |
ثلاجة | مطلوب | مؤشر البداية، صفر في الصفحة الأولى. |
مثال
curl "https://api.smsmobileapi.com/getemail/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&mbox=INBOX&start=0"
هل تريد أن تدير هذا الطلب؟اتصل بمفتاحك في أعلى الصفحة لفتح المُختبر التفاعلي
مفتاح الوصل- وتشمل الردود التفاصيل المتاحة عن الموضوع والمرسل والمتلقي والجسد والأوقات والملحقات.
يحصل
تحقق من الاتصالات غير المُشتبه فيها
https://api.smsmobileapi.com/email/unsubscribed/تفحص سجلات الغير مستنسخة بواسطة رسائل إلكترونية أرسلت عبر المنصة
استخدمه قبل إرسال الحملات وعند تزامن قوائم القمع
حدود
| الاسم | يكتب | الاحتياجات | وصف |
|---|---|---|---|
apikey |
خيط | مطلوب | حسابك (زكى 8كى زى) |
apikeybox |
خيط | مطلوب | مفتاح صندوق البريد API. |
email |
بريد إلكتروني | الاختياري | أُرسل اتصالاً واحداً النتيجة الفارغة تعني أنه لم يتم العثور على سجل غير خفي |
مثال
curl "https://api.smsmobileapi.com/email/unsubscribed/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&email=customer@example.net"
هل تريد أن تدير هذا الطلب؟اتصل بمفتاحك في أعلى الصفحة لفتح المُختبر التفاعلي
مفتاح الوصل- حافظ على قاعدة بياناتك الخاصة متزامنة مع نتائج غير مقصودة
- أنتِ تظلين مسؤولة عن قواعد مكافحة التجسس و الخصوصية
POST ; GET
مسح سجل رسائل البريد الإلكتروني المرسلة
https://api.smsmobileapi.com/delete-history-email/أرسل (كلير) سجلات بريد إلكتروني لهذا API مفتاح عبر صناديق البريد لا تحذف الرسائل في صندوق بريد لا apikeybox مطلوب.
استخدمي العرض الأول، وتحققي من التهم، ثم طلبي حذفها صراحة. هذا يُوضّحُ التاريخَ المختارَ بالكاملَ ل API مفتاح، بدون موعد، هاتف أو مرشحات رسائل
حدود
| الاسم | يكتب | الاحتياجات | وصف |
|---|---|---|---|
apikey |
خيط | الاختياري | مطلوبة بدون OAuth2مع OAuth2اختيار اختياري API مفتاح الحساب نفسه |
action |
ما قبل الاستعراض تحذف | الحالة | الاختياري | preview يحسب السجلات دون حذف؛ delete يبدأ الحذف أو يتابعه؛ status يعرض التقدم فقط. القيمة الافتراضية في API هي delete، وفي أداة الاختبار هذه هي preview. |
include_linked |
0 | 1 | الاختياري | الافتراض صفر: الاحتفاظ بسجلات متصلة أو تجهيز. وضع 1 لضمها، مع خطر كسر التكامل. أبق هذه القيمة دون تغيير عندما تستمر في الحذف |
request_id |
خيط | الاختياري | مطلوب مع delete وstatus، واختياري مع preview. استخدم من 16 إلى 128 حرف ASCII أو رقم أو شرطة (-) أو شرطة سفلية (_). أنشئ معرّفًا فريدًا لكل عملية حذف جديدة واحتفظ به في جميع المحاولات المتكررة. هذا ليس معرّف رسالة ولا مفتاح API. |
مثال
curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=preview" -d "include_linked=0"
أمثلة للحذف والوضع
يستعاض عن العينة request_id مع قيمتك الفريدة قبل أن تبدأ وتُغيّر الطلبات الواردة أدناه تاريخ الحساب الحقيقي؛ وهي ليست استعراضات مسبقة.
curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
-H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
-d "action=delete" -d "include_linked=0" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"curl -G "https://api.smsmobileapi.com/delete-history-email/" \
--data-urlencode "apikey=YOUR_API_KEY" \
-d "action=status" \
-d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"مثال على الإجابة
{
"result": {
"error": 0,
"history": "email",
"action": "preview",
"total": 120,
"simple": 100,
"linked_or_processing": 20,
"selected": 100,
"include_linked": 0,
"operation_in_progress": false,
"active_include_linked": null
}
}
هل تريد أن تدير هذا الطلب؟اتصل بمفتاحك في أعلى الصفحة لفتح المُختبر التفاعلي
مفتاح الوصل- المثال الوارد أعلاه هو استعراض مسبق، وليس حذف. فالعدادات توضيحية؛ والاختيار النهائي يتم تحديده عند بدء حذفها.
- include_linked=1 قد يُعطل GHL، Zapierأو آليات أو وصلات غير مصففة أو تتبع تسليم. لا يتعدى على حساب الملكية أو فحص سلامة التخزين
استكشاف الأخطاء وإصلاحها
السطو والمستودعات الآمنة
اقرأي حالة HTTP وميدان خطأ JSON قبل إعادة التجريب. لا تُعيد التثبت من صحة الطلب أو تُثبت فشله دون تصحيح الطلب أولاً.
| HTTP | المدونة | ماذا تفعل؟ |
|---|---|---|
| 400 | missing_parameter | البارامترات المطلوبة فارغة أو غير موجودة. تحقق من طاولة البارامترات في نقطة النهاية |
| 403 | invalid_apikey | ومفتاح API غير معروف أو منتهية أو غير مأذون به بالنسبة للميمة المطلوبة. |
| 429 | too_many_requests | الطلبات تصل بسرعة انتظر، ثمّ يَعْزلُ بالتراجعِ الهائلِ. |
| 500 | server_error | ولم تستطع الدائرة إكمال الطلب. الحفاظ على الاستجابة ودعم الاتصال إذا استمر. |
هل تحتاج إلى مساعدة؟
أحضري سياق الطلب ليس أسرارك
Share the endpoint, timestamp, HTTP status and sanitized response. لا تشمل أبداً مفاتيح API، أو مداخل أو محتوى الرسائل الخاصة.
