واجهة برمجة تطبيقات WhatsApp

createWhatsAppMessage مهمل

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

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

نص الطلب

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

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

الاسم	مطلوب	النوع	الوصف
send_date*	نعم	string	تاريخ ووقت إرسال الإشعار. استخدم التنسيق `YYYY-MM-DD HH:mm` أو `'now'` للإرسال فورًا.
content	مطلوب إذا لم يتم توفير `content_id`.	string	المحتوى النصي لرسالة WhatsApp.
content_id	مطلوب إذا لم يتم توفير `content`.	string	معرف قالب WhatsApp معتمد مسبقًا من حساب 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	متغيرات لرأس الصفحة في رسالة قالب WhatsApp. حدد `type` (على سبيل المثال، `text`، `image`، `video`، `document`) والقيمة المقابلة. مثال: `"header_variables": {"image": "https://image-url.png"}`
preset	لا	string	رمز إعداد WhatsApp المسبق من لوحة التحكم الخاصة بك.
language	لا	string	اللغة المحلية لقالب WhatsApp (يجب أن تتطابق مع اللغة المحلية في محرر قوالب Meta WhatsApp). الافتراضي: `"en_US"`. مثال: `"en_GB"`.

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

{
  "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. معرف قالب WhatsApp.
      "devices": ["whatsapp:+1234567890"],  // مطلوب. رقم هاتف WhatsApp للعميل (يجب أن يكون مرتبطًا
                                            //           بـ UserId باستخدام /registerDevice ومحددًا في
                                            //           معلمة "hwid" أو استخدم "use_auto_registration").
                                            //           يمكن تحديد رقم WhatsApp واحد فقط هنا.
      "preset": "XXXXX-XXXXX",              // اختياري. رمز إعداد WhatsApp المسبق من لوحة التحكم الخاصة بك.
      "content_variables": {                // اختياري. متغيرات المحتوى لتخصيص محتوى الرسالة.
        "1": "John"
      },
      "header_variables": {                 // اختياري. متغيرات لرأس رسالة WhatsApp.
        "image": "https://image-url.png"
      },
      "language": "en_GB",                  // اختياري. اللغة المحلية لقالب WhatsApp (يجب أن تتطابق مع اللغة المحلية في محرر قوالب Meta WhatsApp). الافتراضي: "en_US".
      "use_auto_registration": true         // اختياري. تسجيل رقم WhatsApp المحدد تلقائيًا
                                            //           في معلمة "devices".
    }]
  }
}

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

{
    "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"]
        }]
    }
}

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

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

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

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