انتقل إلى المحتوى

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رمز الإعداد المسبق للرسائل القصيرة من لوحة التحكم الخاصة بك.

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

Anchor link to
{
"request": {
"application": "12345-67891", // مطلوب. رمز تطبيق Pushwoosh.
"auth": "yxoPUlwqm…………pIyEX4H", // مطلوب. رمز الوصول إلى API من لوحة تحكم Pushwoosh.
"notifications": [{
"send_date": "now", // مطلوب. YYYY-MM-DD HH:mm أو "now".
"content": "Hello!", // مطلوب. نص الرسالة القصيرة (سلسلة نصية).
"devices": ["+1234567890"], // مطلوب. رقم هاتف العميل (يجب أن يكون مرتبطًا
// بـ UserId باستخدام /registerDevice ومحددًا في
// معلمة "hwid" أو استخدم "use_auto_registration").
// يمكن تحديد رقم واحد فقط هنا.
"preset": "XXXXX-XXXXX", // اختياري. رمز الإعداد المسبق للرسائل القصيرة من لوحة التحكم الخاصة بك.
"use_auto_registration": true // اختياري. تسجيل رقم الهاتف المحدد
// في معلمة "devices" تلقائيًا.
}]
}
}

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

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.

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