انتقل إلى المحتوى
أدلة المستخدمالدعم طلب عرض توضيحي تسجيل الدخول
Pushwoosh.com

واجهة برمجة تطبيقات واتساب (WhatsApp API)

createWhatsAppMessage مهمل

Anchor link to

يُستخدم لإرسال رسائل واتساب إلى المستخدمين

POST https://api.pushwoosh.com/json/1.3/createWhatsAppMessage

نص الطلب

Anchor link to
الاسم
مطلوب
النوعالوصف
auth*نعمstringرمز الوصول إلى API من لوحة تحكم Pushwoosh.
application*نعمstringرمز تطبيق Pushwoosh
notifications*نعمarrayإعدادات المحتوى. مصفوفة JSON من معلمات الرسالة. انظر التفاصيل أدناه.

معلمات الإشعار

Anchor link to
الاسم
مطلوبالنوعالوصف
send_date*نعمstringتاريخ ووقت إرسال الإشعار. استخدم التنسيق YYYY-MM-DD HH:mm أو 'now' للإرسال فورًا.
contentمطلوب إذا لم يتم توفير content_id.stringالمحتوى النصي لرسالة واتساب.
content_idمطلوب إذا لم يتم توفير content.stringمعرف لقالب واتساب معتمد مسبقًا من حسابك في Meta.
devices*نعمarrayرقم هاتف العميل (يجب أن يكون مرتبطًا بـ User ID باستخدام /registerDevice ومحددًا في معلمة hwid، أو استخدم use_auto_registration). يمكن تحديد رقم واحد فقط هنا.
use_auto_registrationلاbooleanإذا تم تعيينه إلى true، فسيتم تسجيل رقم الهاتف المحدد في معلمة devices تلقائيًا.
content_variablesلاobjectمتغيرات المحتوى لتخصيص محتوى الرسالة. سيتم استبدال كل عنصر نائب بالقيم الديناميكية المقابلة.
button_url_variablesلاobjectمتغيرات URL الديناميكية للأزرار. يمثل كل مفتاح فهرس زر، وقيمته هي المتغير الديناميكي الذي سيتم استبداله في URL الزر. ملاحظة: يبدأ فهرس الأزرار من 0، حيث يكون الزر الأول 0، والثاني 1، وهكذا.
header_variablesلاobjectمتغيرات للرأس في رسالة قالب واتساب. حدد type (على سبيل المثال، text، image، video، document) والقيمة المقابلة. مثال: "header_variables": {"image": "https://image-url.png"}
presetلاstringرمز الإعداد المسبق لواتساب (WhatsApp Preset Code) من لوحة التحكم الخاصة بك.
languageلاstringاللغة المحلية لقالب واتساب (يجب أن تتطابق مع اللغة المحلية في محرر قوالب واتساب في Meta). الافتراضي: "en_US". مثال: "en_GB".

مثال على الطلب

Anchor link to
{
  "request": {
    "application": "12XXX-67XXX",           // مطلوب. رمز تطبيق Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",         // مطلوب. رمز الوصول إلى API من لوحة تحكم Pushwoosh.
    "notifications": [{
      "send_date": "now",                   // مطلوب. YYYY-MM-DD HH:mm أو "now".
      "content": "Hello! {{1}}",            // مطلوب إذا لم يتم توفير content_id. نص الرسالة.
      "content_id": "hello_world",          // مطلوب إذا لم يتم توفير content. معرف قالب واتساب.
      "devices": ["whatsapp:+1234567890"],  // مطلوب. رقم هاتف واتساب للعميل (يجب أن يكون مرتبطًا
                                            //           بـ UserId باستخدام /registerDevice ومحددًا في
                                            //           معلمة "hwid" أو استخدم "use_auto_registration").
                                            //           يمكن تحديد رقم واتساب واحد فقط هنا.
      "preset": "XXXXX-XXXXX",              // اختياري. رمز الإعداد المسبق لواتساب من لوحة التحكم الخاصة بك.
      "content_variables": {                // اختياري. متغيرات المحتوى لتخصيص محتوى الرسالة.
        "1": "John"
      },
      "header_variables": {                 // اختياري. متغيرات لرأس رسالة واتساب.
        "image": "https://image-url.png"
      },
      "language": "en_GB",                  // اختياري. اللغة المحلية لقالب واتساب (يجب أن تتطابق مع اللغة المحلية في محرر قوالب واتساب في Meta). الافتراضي: "en_US".
      "use_auto_registration": true         // اختياري. تسجيل رقم واتساب المحدد تلقائيًا
                                            //           في معلمة "devices".
    }]
  }
}

مثال: إرسال رمز مصادقة ثنائية عبر واتساب

Anchor link to
{
    "request": {
        "application":"APP_CODE", "auth":"AUTH_TOKEN",
        "notifications":[{
            "send_date":"now",
            "content_id":"replace_with_your_meta_two_factor_template_name",
            "content_variables":{"1":"AUTH_CODE"},
            "button_url_variables":{"0":"AUTH_CODE"},
            "devices":["whatsapp:REPLACE_WITH_YOUR_PHONE_NO"]
        }]
    }
}

مثال على الاستجابة

Anchor link to
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10EXXX-0D9F2XXX"
    ]
  }
}

استجابة الخطأ

Anchor link to
{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}