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

import { Badge } from '@astrojs/starlight/components';

<Aside type="caution" title="تم إهمال /createSMSMessage">
يجب أن تستخدم عمليات الدمج الجديدة [واجهة برمجة تطبيقات المراسلة v2](/ar/developer/api-reference/messaging-api-v2/) — مرر `platforms: ["SMS"]` إلى `Notify`. راجع [دليل الترحيل](/ar/developer/api-reference/messaging-api-v2/migration-from-v1/#from-createsmsmessage).
</Aside>

<Aside type="note">
قبل إرسال رسائل SMS، قم بتوصيل مزود خدمة SMS الخاص بك في لوحة التحكم. [اعرف المزيد](/ar/developer/first-steps/connect-messaging-services/sms-configuration/)
</Aside>

<Aside type="caution">
لا يدعم `/createSMSMessage` رسائل الوسائط المتعددة (MMS). إذا كان `preset` يشير إلى [إعداد مسبق للرسائل القصيرة](/ar/product/content/sms-presets/) مع [مرفقات MMS](/ar/product/content/sms-presets/#add-mms-attachments)، فإن هذه الطريقة تتجاهل الموضوع والصور وترسل فقط نص الرسالة العادي. لإرسال رسائل MMS، استخدم [واجهة برمجة تطبيقات المراسلة v2 `Notify`](/ar/developer/api-reference/messaging-api-v2/payload-reference/#mms) بدلاً من ذلك.
</Aside>

<span id="createsmsmessage" />

## createSMSMessage <Badge text="مهمل" variant="caution" size="small" />

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

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

### نص الطلب

| الاسم | مطلوب | النوع | الوصف |
|--------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------|
| **auth*** | نعم | string | [رمز الوصول إلى واجهة برمجة التطبيقات (API)](/ar/developer/api-reference/api-identifiers/#api-access-token) من لوحة تحكم Pushwoosh. |
| **application*** | نعم | string | [رمز تطبيق Pushwoosh](/ar/developer/api-reference/api-identifiers/#application-code) |
| **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)](/ar/developer/api-reference/api-identifiers/#preset-code) من لوحة التحكم الخاصة بك. |

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

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

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

```json
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10ECB6-0D9F214D"
    ]
  }
}
```

### استجابة الخطأ
```json
{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}
```

<Aside type="note">
حاليًا، يجب إرسال كل رسالة SMS في طلب منفصل لكل عميل.
</Aside>

للحصول على إحصائيات الرسائل القصيرة، استخدم طريقة [totalsByIntervals](/ar/developer/api-reference/statistics-api/message-statistics-api/#totalsbyintervals).

يمكنك أيضًا عرض إحصائيات كل رسالة في قسم [سجل الرسائل](/ar/product/statistics-and-analytics/message-history/).

<Aside type="caution">
يرجى ملاحظة أن بعض مشغلي شبكات الهاتف المحمول لا ينقلون بيانات حالة التسليم، لذلك قد لا تكون الإحصائيات دقيقة. يمكنك التحقق من التفاصيل مع مشغلي شبكات الهاتف المحمول الذين يوفرون أرقامًا لعملائك.
</Aside>