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

واجهة برمجة تطبيقات الرسائل القصيرة (SMS API)

createSMSMessage مهمل

Anchor link to

تُستخدم لإرسال إشعارات SMS للمستخدمين

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

نص الطلب

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

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

الاسممطلوبالنوعالوصف
send_date*نعمstringتاريخ ووقت إرسال الإشعار. استخدم التنسيق YYYY-MM-DD HH:mm أو now للإرسال فورًا.
content*نعمstringالمحتوى النصي لرسالة SMS.
devices*نعمarrayرقم هاتف العميل (يجب أن يكون مرتبطًا بـ UserId باستخدام /registerDevice ومحددًا في المعلمة hwid أو استخدم use_auto_registration). يمكن تحديد رقم واحد فقط هنا.
use_auto_registrationلاbooleanإذا تم تعيينه على true، فسيتم تسجيل رقم الهاتف المحدد في المعلمة devices تلقائيًا.
dynamic_content_placeholdersلاobjectعناصر نائبة للمحتوى الديناميكي لتخصيص محتوى الرسالة. سيتم استبدال كل عنصر نائب بالقيم الديناميكية المقابلة.
presetلاstringرمز الإعداد المسبق للرسائل القصيرة (Preset Code) من لوحة التحكم الخاصة بك.

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

Anchor link to
{
  "request": {
    "application": "12345-67891",    // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel.
    "notifications": [{
      "send_date": "now",            // required. YYYY-MM-DD HH:mm OR "now".
      "content": "Hello!",           // required. SMS text (string).
      "devices": ["+1234567890"],    // required. Customer phone number (must be associated with
                                     //           a UserId using. /registerDevice and specified in
                                     //           the "hwid" parameter or use "use_auto_registration").
                                     //           Only one number can be specified here.
      "preset": "XXXXX-XXXXX",       // optional. SMS Preset Code from your Control Panel.
      "use_auto_registration": true  // optional. Automatically register phone number specified
                                     //           in "devices" parameter.
    }]
  }
}

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

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

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

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

للحصول على إحصائيات الرسائل القصيرة، استخدم طريقة totalsByIntervals.

يمكنك أيضًا عرض إحصائيات كل رسالة في قسم سجل الرسائل.