انتقل إلى المحتوى
مستندات المطورينتجريبي

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

من مفتاح جديد إلى رسالة وصلت وأول webhook، في نحو خمس دقائق.

تحتاج إلى مساحة عمل في موجود على باقة مدفوعة، فيها رقم واتساب مربوط وقالب واحد معتمد على الأقل. تجد قوالبك في موجود › قوالب واتساب.

أنشئ مفتاحًا

افتح موجود › الإعدادات › للمطورين وأنشئ مفتاحًا (متاح للمالكين والمديرين). انسخه الآن، فهو يظهر مرة واحدة فقط. احتفظ به على الخادم، ولا تضعه أبدًا في موقع ويب أو تطبيق جوال.

export MAWGOOD_API_KEY="mwg_sk_live_..."

أرسل بمفتاح حقيقي (mwg_sk_live_). أما مفتاح التجربة (mwg_sk_test_) فيفحص الطلب كاملًا، ثم يرد بالخطأ 403 test_key_cannot_send بدلًا من الإرسال.

تأكد أنه يعمل:

curl https://api.mawgood.ai/v1/me \
  -H "Authorization: Bearer $MAWGOOD_API_KEY"

اختر قالبًا

اعرض قوالبك المعتمدة. كل قالب يوضح الأرقام التي يمكنها إرساله والمتغيرات التي يحتاجها.

curl "https://api.mawgood.ai/v1/templates?status=approved" \
  -H "Authorization: Bearer $MAWGOOD_API_KEY"
الاستجابة (مختصرة)
{
  "data": [
    {
      "id": "tpl_8Kq2mZ",
      "name": "order_shipped",
      "language": "ar",
      "category": "utility",
      "status": "approved",
      "numbers": ["num_3Fh7Ws"],
      "variables": {
        "body": [
          { "index": 1, "name": "customer.name", "example": "Mona" },
          { "index": 2, "name": "order.id", "example": "#1042" }
        ],
        "buttons": []
      }
    }
  ]
}

أرسل إلى رقم واحد

أرسل القالب إلى هاتفك أولًا. ضع قيم النص بالترتيب، فهي تُرسل كما تكتبها بالضبط. وترويسة Idempotency-Key مطلوبة: إعادة المحاولة بالمفتاح نفسه لا ترسل الرسالة مرتين أبدًا.

curl https://api.mawgood.ai/v1/campaigns \
  -H "Authorization: Bearer $MAWGOOD_API_KEY" \
  -H "Idempotency-Key: quickstart-1" \
  -H "Content-Type: application/json" \
  -d '{
    "template": { "name": "order_shipped", "language": "ar" },
    "recipients": [
      { "phone": "+201001234567", "variables": { "body": ["Mona", "#1042"] } }
    ]
  }'

ستحصل على 202 Accepted وبيانات الحملة:

{
  "id": "cmp_9Xa4Lr",
  "status": "preparing",
  "total": 1,
  "pacing": { "mode": "all_at_once" },
  "pacingAdjusted": false,
  "estimatedCredits": 1,
  "skipped": []
}

تصل الرسالة إلى هاتفك بعد ثوانٍ. ويمكنك أيضًا متابعتها عبر GET /campaigns/cmp_9Xa4Lr.

استقبل webhook

من الإعدادات › للمطورين، أدخل عنوان الـ webhook واختر أحداثه وانسخ مفتاح التوقيع الخاص به. للتجربة الأولى يكفي عنوان HTTPS عام مؤقت (خدمة لاستقبال الطلبات، أو نفق إلى جهازك)، وزر «ابعت حدث تجربة» يرسل إليه حدث ping. أرسل رسالة أخرى، وستصلك مع كل تغيير في الحالة طلبات POST مثل هذا:

message.status (مختصر)
{
  "id": "evt_4Rt9Kp",
  "type": "message.status",
  "createdAt": "2026-11-20T10:15:04Z",
  "data": {
    "campaignId": "cmp_9Xa4Lr",
    "campaignName": "order_shipped",
    "source": "api",
    "at": "2026-11-20T10:15:04Z",
    "recipient": {
      "phone": "+201001234567",
      "status": "delivered",
      "deliveredAt": "2026-11-20T10:15:03Z"
    }
  }
}

قبل الاعتماد عليه في بيئة الإنتاج، تحقق من التوقيع.

الخطوة التالية

في هذه الصفحة