iMissive - Enterprise Messaging Platform
تكامل المطورين

وثائق API

دليل شامل لدمج خدمات SMS و OTP و Webhooks و SMPP من آي ميسيف في تطبيقاتك

Quick Start

البداية السريعة

أرسل رسالتك الأولى في دقائق معدودة

1
الحصول على مفتاح API

سجل دخولك إلى لوحة التحكم واحصل على مفتاح API الخاص بك من قسم الإعدادات.

2
إرسال رسالة

استخدم الكود التالي لإرسال رسالتك الأولى:

مثال - نقطة نهاية تجريبية
curl -X POST https://api.imissive.com/v1/sms/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+966501234567",
    "message": "Hello from iMissive!",
    "sender_id": "MyCompany"
  }'

* استبدل YOUR_API_KEY بمفتاح API الفعلي. نقاط النهاية وبيانات الاعتماد للإنتاج تُقدم بعد التعاقد وتفعيل الحساب.

Authentication

المصادقة

جميع طلبات API تتطلب مصادقة عبر Bearer Token

إضافة رأس المصادقة
HTTP Header
Authorization: Bearer YOUR_API_KEY

أضف هذا الرأس إلى جميع طلبات API الخاصة بك. مفاتيح API متاحة من لوحة التحكم.

أفضل ممارسات الأمان
  • لا تشارك مفتاح API الخاص بك أبداً
  • استخدم متغيرات البيئة لتخزين المفاتيح
  • قم بتدوير المفاتيح بانتظام
  • استخدم HTTPS دائماً
SMS API

SMS API

إرسال رسائل نصية فردية أو جماعية

إرسال رسالة واحدة
POST /v1/sms/send
JSON
{
  "to": "+966501234567",
  "message": "Your message content here",
  "sender_id": "MyCompany",
  "scheduled_at": "2024-01-15T10:00:00Z" // optional
}
إرسال رسائل جماعية
POST /v1/sms/bulk
JSON
{
  "messages": [
    { "to": "+966501234567", "message": "Hello User 1" },
    { "to": "+966501234568", "message": "Hello User 2" }
  ],
  "sender_id": "MyCompany"
}
OTP API

OTP API

إنشاء والتحقق من رموز التحقق لمرة واحدة

إرسال رمز OTP
POST /v1/otp/send
JSON
{
  "phone": "+966501234567",
  "length": 6,           // 4-8 digits
  "expiry": 300,         // seconds (configurable)
  "template": "Your verification code is: {code}"
}
التحقق من رمز OTP
POST /v1/otp/verify
JSON
{
  "otp_id": "otp_abc123",
  "code": "123456"
}
Webhooks

Webhooks

استقبل إشعارات فورية عن حالة الرسائل

تكوين Webhook

قم بتكوين عنوان URL الخاص بك من لوحة التحكم لاستقبال الإشعارات.

Example Webhook Payload
POST https://your-server.com/webhook

{
  "event": "message.delivered",
  "message_id": "msg_abc123xyz",
  "timestamp": "2024-01-15T10:01:23Z",
  "data": {
    "to": "+966501234567",
    "status": "delivered",
    "delivered_at": "2024-01-15T10:01:22Z"
  }
}
أنواع الأحداث
message.queuedالرسالة في قائمة الانتظار
message.sentتم إرسال الرسالة
message.deliveredتم تسليم الرسالة
message.failedفشل تسليم الرسالة
SMPP

اتصال SMPP

اتصال SMPP v3.4 للمؤسسات ذات الحجم الكبير

معلومات الاتصال
الخادميُقدم أثناء التعاقد الفني
المنفذيُقدم أثناء التعاقد الفني
system_idيُقدم أثناء التعاقد الفني
passwordيُقدم أثناء التعاقد الفني
الإصدارSMPP v3.4
نوع الربطحسب تكوين الحساب
الإنتاجيةحسب الاتفاقية التجارية والفنية
تقارير التسليممدعومة عند التفعيل للحساب

* بيانات اعتماد SMPP ومعلومات الاتصال متاحة بعد إتمام التعاقد الفني للعملاء المؤهلين

الميزات المدعومة
  • دعم Unicode للرسائل العربية
  • الرسائل الطويلة (التقسيم التلقائي)
  • تقارير التسليم (DLR)
  • جدولة الرسائل
  • اتصالات متعددة
Rate Limits

حدود الاستخدام

تعتمد حدود الاستخدام والإنتاجية على تكوين الحساب المعتمد والمسار ونوع المرسل والاتفاقية التجارية

أنواع الحدود
طلبات APIعدد الطلبات في الثانية/الدقيقة
إنتاجية الرسائلالرسائل في الثانية/الدقيقة
إنتاجية SMPPتحدد حسب الاتفاقية
حدود الحملاتأقصى عدد مستلمين لكل طلب
حدود الحسابالحد الأقصى اليومي/الشهري

* تواصل مع فريق المبيعات للحصول على تفاصيل الحدود الخاصة بحسابك

رؤوس الاستجابة
HTTP Headers
X-RateLimit-Limit: <account_limit>
X-RateLimit-Remaining: <remaining_quota>
X-RateLimit-Reset: <reset_timestamp>
Error Codes

رموز الأخطاء

مرجع رموز الأخطاء الشائعة وكيفية التعامل معها

أخطاء HTTP
400

طلب غير صالح

تحقق من صحة البيانات المرسلة

401

غير مصرح

مفتاح API غير صالح أو مفقود

403

محظور

ليس لديك صلاحية لهذا الإجراء

429

طلبات كثيرة

تم تجاوز حد الاستخدام

500

خطأ في الخادم

حاول مرة أخرى لاحقاً

رموز أخطاء الرسائل
أمثلة على رموز الأخطاء الشائعة
INVALID_PHONEرقم الهاتف غير صالح
INVALID_SENDERمعرف المرسل غير مصرح
INSUFFICIENT_CREDITSرصيد غير كافٍ
MESSAGE_TOO_LONGالرسالة تتجاوز الحد المسموح

الأسئلة الشائعة

إجابات على الأسئلة الأكثر شيوعاً

أمثلة الكود

أمثلة سريعة للبدء في الدمج

إرسال رسالة نصية
مثال - نقطة نهاية تجريبية
bash
curl -X POST https://api.imissive.com/v1/sms/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+966501234567",
    "message": "Hello from iMissive!",
    "sender_id": "MyCompany"
  }'

هل أنت مستعد لبدء التكامل؟

تواصل معنا للحصول على مفاتيح API الخاصة بك والبدء في دمج خدمات الرسائل المؤسسية