توثيق واجهة برمجة تطبيقات مدعوم
دليل شامل ومطور لإرسال رسائل واتساب الحرة وإدارة العمليات
رسائل الجلسة
إرسال رسائل حرة تماماً للعملاء خلال نافذة الـ 24 ساعة
أمثلة جاهزة
أكواد برمجية جاهزة بـ JavaScript, Python, PHP وغيرها
ويب هوك
استقبال إشعارات فورية عن الرسائل الواردة وتحديثات الحالة
توثيق API
نظرة عامة على API
نظام API متكامل يوفر إمكانيات شاملة لإرسال رسائل واتساب. يدعم النظام المصادقة عبر Bearer Token (API Keys).
Base URL:
https://api.mad3oom.online/v1
الميزات الرئيسية:
- إرسال رسائل حرة (Session Messages) بدون قوالب
- دعم نافذة الـ 24 ساعة للرد على العملاء
- ويب هوك لاستقبال الرسائل الواردة
- سجلات API شاملة لكل عملية
المصادقة (Authentication)
يتم استخدام API Keys للمصادقة على الطلبات. يمكنك الحصول على مفتاحك من لوحة تحكم العميل.
HTTP Headers
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
ملاحظة: لا تقم أبداً بمشاركة مفتاح API الخاص بك في الكود الأمامي (Client-side code).
نقاط الاتصال - واتساب (WhatsApp Endpoints)
تتيح لك نقاط الاتصال هذه إرسال رسائل حرة (Session Messages) للعملاء عبر واتساب ضمن نافذة الـ 24 ساعة.
POST
/whatsapp/session/send
إرسال رسالة حرة (Session Message) للعميل
المعاملات:
| المعامل | النوع | الوصف |
|---|---|---|
to |
string | رقم هاتف المستلم بالصيغة الدولية (بدون +) |
message |
string | نص الرسالة المراد إرسالها |
ملاحظة: يجب أن تكون الرسالة ضمن نافذة الـ 24 ساعة من آخر رسالة استقبلتها من العميل.
الويب هوك (Webhooks)
الويب هوك تسمح لتطبيقك بتلقي إشعارات فورية عند استقبال رسائل جديدة من العملاء.
الأحداث المدعومة:
message.received- عند استقبال رسالة جديدة من عميلmessage.status- عند تحديث حالة الرسالة المرسلة (delivered, read)
يمكنك إعداد رابط الويب هوك الخاص بك من خلال قسم "إعدادات المطور" في لوحة تحكم العميل.
معالجة الأخطاء
| الكود | المعنى | الحل |
|---|---|---|
401 |
غير مصرح | تحقق من صحة API Key |
403 |
نافذة الـ 24 ساعة منتهية | لا يمكن إرسال رسالة حرة لعميل لم يتفاعل خلال 24 ساعة |
429 |
تجاوز حد الطلبات | تقليل معدل إرسال الطلبات |
أمثلة برمجية
نماذج جاهزة للاستخدام بمختلف اللغات البرمجية لإرسال رسائل واتساب.
async function sendMessage() {
const response = await fetch('https://api.mad3oom.online/v1/whatsapp/session/send', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
to: '201025998920',
message: 'مرحباً بك، كيف يمكننا مساعدتك اليوم؟'
})
});
const data = await response.json();
console.log(data);
}
import requests
url = "https://api.mad3oom.online/v1/whatsapp/session/send"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
}
payload = {
"to": "201025998920",
"message": "مرحباً بك، كيف يمكننا مساعدتك اليوم؟"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())