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

ملاحظة

قبل إرسال رسائل LINE، تأكد من أن منصة Line مهيأة بشكل صحيح. اعرف المزيد

createLineMessage

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

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

إرسال رسالة نصية

رسائل LINE بسيطة تتكون من نص عادي فقط، بدون صور أو أزرار. اعرف المزيد

نصيحة: للتنسيق المتقدم والوسائط الغنية، استخدم قوالب الرسائل مثل Flex، أو صورة، أو عرض دوار.

نص الطلب

المعلمة	النوع	مطلوب	الوصف
application	string	نعم	رمز تطبيق Pushwoosh
auth	string	نعم	رمز الوصول لواجهة برمجة التطبيقات (API) لمصادقة الطلب.
notifications	array of objects	نعم	قائمة بكائنات رسائل LINE المراد إرسالها.
content	string	نعم	نص رسالة LINE المراد إرسالها. الحد الأقصى للأحرف: 5000. ملاحظة: إذا تم تضمين كل من preset و content، فإن القيمة من الطلب تتجاوز preset.
preset	string	لا	رمز إعداد LINE المسبق الذي أنشأته في لوحة تحكم Pushwoosh. ملاحظة: إذا تم تضمين كل من preset و content، فإن القيمة من الطلب تتجاوز preset.
send_date	string	نعم	تاريخ ووقت إرسال الرسالة. استخدم التنسيق YYYY-MM-DD HH:mm أو now للإرسال فورًا.
devices	array of strings	نعم	قائمة برموز الأجهزة (معرفات المستخدم) لإرسال رسالة LINE إليها.

{
    "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
        "notifications": [
            {
                "content": "test",
                "preset": "preset_code",
                "send_date":"now",
                "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"]
            }
        ]
    }
}

إرسال رسالة صورة

يمكنك إرسال رسالة صورة إلى مستخدمي LINE عن طريق تحديد كائن صورة داخل حقل القالب في طلبك.

تتطلب كل رسالة صورة عنواني URL للصورة: أحدهما للصورة بالحجم الكامل (image_url) والآخر للمعاينة (preview_image_url). عندما ينقر المستخدمون على المعاينة، تفتح الصورة بالحجم الكامل. تأكد من أن كلا عنواني URL يستخدمان HTTPS (TLS 1.2 أو أحدث) ويربطان بملفات صور يمكن الوصول إليها بشكل عام.

للتفاصيل، راجع قسم رسالة الصورة في توثيق واجهة برمجة تطبيقات رسائل LINE.

نص الطلب

المعلمة	النوع	مطلوب	الوصف
application	string	نعم	رمز تطبيق Pushwoosh
auth	string	نعم	رمز الوصول لواجهة برمجة التطبيقات (API) المستخدم لمصادقة الطلب.
notifications	array of objects	نعم	قائمة بالرسائل المراد إرسالها.
content	string	نعم	يُستخدم كنص احتياطي أو نص معاينة للرسالة. رمز إعداد LINE المسبق الذي أنشأته في لوحة تحكم Pushwoosh. ملاحظة: إذا تم تضمين كل من preset و template، فسيتم استخدام template من الطلب. إذا تم تضمين كل من preset و content، فإن content من الطلب يتجاوز الإعداد المسبق.
send_date	string	نعم	تاريخ ووقت إرسال الرسالة. استخدم التنسيق YYYY-MM-DD HH:mm أو now للإرسال فورًا.
devices	array of strings	نعم	قائمة برموز الأجهزة (معرفات المستخدم) لإرسال رسالة LINE إليها.
preset	string	لا	رمز إعداد LINE المسبق الذي أنشأته في لوحة تحكم Pushwoosh. ملاحظة: إذا تم تضمين كل من معلمتي preset و template في الطلب، فإن القيم من template ستتجاوز تلك المحددة في الإعداد المسبق. إذا تم تضمين كل من preset و content في نفس الطلب، فإن content المقدم مباشرة في الطلب سيتجاوز المحتوى من preset.
template	object	نعم	قالب تخطيط الرسالة. يدعم أنواع رسائل متعددة. انظر التفاصيل أدناه.

معلمات القالب

النوع: image

المعلمة	النوع	مطلوب	الوصف
image_url	string	نعم	عنوان URL للصورة بالحجم الكامل (يجب استخدام HTTPS). الحد الأقصى للطول: 2000 حرف. التنسيق: JPEG, PNG. الحجم الأقصى: 10 ميجابايت.
preview_image_url	string	نعم	عنوان URL لصورة المعاينة المعروضة في الدردشة (يجب استخدام HTTPS). الحد الأقصى للطول: 2000 حرف. التنسيق: JPEG, PNG. الحجم الأقصى: 1 ميجابايت.

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image": {
              "alt_text": "some text",
              "image_url": "https://images.com/1.jpg",
              "preview_image_url": "https://images.com/1.png"
            }
          }
        }
      }
    ]
  }
}

إرسال رسالة عرض صور دوار

تتيح لك رسائل عرض الصور الدوار عرض صور متعددة في تنسيق قابل للتمرير أفقيًا. تظهر كل صورة كعمود منفصل غير قابل للنقر يمكن للمستخدمين التمرير خلاله في واجهة دردشة LINE.

هذا التنسيق مثالي لعرض العناصر أو العروض الترويجية أو التحديدات المرئية بطريقة جذابة.

للتفاصيل، راجع قسم قالب عرض الصور الدوار في توثيق واجهة برمجة تطبيقات رسائل LINE.

نص الطلب

المعلمة	النوع	مطلوب	الوصف
application	string	نعم	رمز تطبيق Pushwoosh
auth	string	نعم	رمز الوصول لواجهة برمجة التطبيقات (API) المستخدم لمصادقة الطلب.
notifications	array of objects	نعم	قائمة بالرسائل المراد إرسالها.
content	string	نعم	يُستخدم كنص احتياطي أو نص معاينة للرسالة. ملاحظة: إذا تم تعيين كل من content و template، فسيتم استخدام template. إذا تم تضمين كل من preset و content في نفس الطلب، فإن content المقدم مباشرة في الطلب سيتجاوز المحتوى من preset.
send_date	string	نعم	تاريخ ووقت إرسال الرسالة. استخدم التنسيق YYYY-MM-DD HH:mm أو "now".
devices	array of strings	نعم	قائمة برموز الأجهزة (معرفات المستخدم) لإرسال رسالة LINE إليها.
preset	string	لا	رمز إعداد LINE المسبق الذي أنشأته في لوحة تحكم Pushwoosh. ملاحظة: إذا تم تضمين كل من معلمتي preset و template في الطلب، فإن القيم من template ستتجاوز تلك المحددة في preset. إذا تم تضمين كل من preset و content في نفس الطلب، فإن content المقدم مباشرة في الطلب سيتجاوز المحتوى من preset.
template	object	نعم	قالب تخطيط الرسالة. يدعم أنواع رسائل متعددة. انظر التفاصيل أدناه.

معلمات القالب

النوع: image_carousel

المعلمة	النوع	مطلوب	الوصف
alt_text	string	نعم	نص احتياطي يُعرض في معاينات الإشعارات وعلى الأجهزة غير المدعومة. الحد الأقصى 400 حرف.
columns	array of objects	نعم	مصفوفة من أعمدة الصور (مدعوم من 1 إلى 10). يتضمن كل عمود صورة.
image_url	string	نعم	عنوان URL للصورة المعروضة في كل عمود من العرض الدوار يشير إلى ملف JPEG أو PNG يمكن الوصول إليه بشكل عام. يجب استخدام HTTPS.

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image_carousel": {
              "alt_text": "some text",
              "columns": [
                { "image_url": "https://images.com/1.jpg" },
                { "image_url": "https://images.com/2.jpg" },
                { "image_url": "https://images.com/3.jpg" }
              ]
            }
          }
        }
      }
    ]
  }
}

إرسال رسالة Flex

رسائل Flex هي أنواع رسائل قوية وقابلة للتخصيص تتيح لك إنشاء تخطيطات منظمة باستخدام النصوص والصور والأزرار والمكونات الأخرى. وهي مثالية لحالات الاستخدام مثل الإيصالات أو بطاقات المنتجات أو القوائم أو أي محتوى يستفيد من التنظيم المرئي.

لإرسال رسالة Flex، قم بتضمين كائن template مع حمولة raw داخل طلبك. يجب أن يتبع تخطيط الرسالة مواصفات رسائل LINE Flex.

نصيحة: يمكنك تصميم ومعاينة رسائل Flex باستخدام محاكي رسائل LINE Flex.

نص الطلب

المعلمة	النوع	مطلوب	الوصف
application	string	نعم	رمز تطبيق Pushwoosh
auth	string	نعم	رمز الوصول لواجهة برمجة التطبيقات (API) المستخدم لمصادقة الطلب.
notifications	array of objects	نعم	قائمة بالرسائل المراد إرسالها.
content	string	نعم	يُستخدم كنص احتياطي أو نص معاينة للرسالة. ملاحظة: إذا تم تعيين كل من content و template، فسيتم استخدام القالب. إذا تم تضمين كل من preset و content، فإن المحتوى من الطلب يتجاوز الإعداد المسبق.
send_date	string	نعم	وقت إرسال الرسالة. استخدم "now" أو تنسيق YYYY-MM-DD HH:mm.
devices	array of strings	نعم	قائمة برموز أجهزة LINE (معرفات المستخدم) لتلقي الرسالة.
preset	string	لا	رمز إعداد LINE المسبق الذي أنشأته في لوحة تحكم Pushwoosh. ملاحظة: إذا تم تضمين كل من preset و template، فإن القالب يتجاوز الإعداد المسبق. إذا تم تضمين كل من preset و content، فإن المحتوى من الطلب يتجاوز الإعداد المسبق.
template	object	نعم	قالب تخطيط الرسالة. يدعم أنواع رسائل متعددة. انظر التفاصيل أدناه.

معلمات القالب

لرسالة Flex، استخدم البنية الخام. النوع: raw (Flex)

المعلمة	النوع	مطلوب	الوصف
alt_text	string	نعم	نص احتياطي يُعرض في الإشعارات ومعاينات الدردشة والاقتباسات. الحد الأقصى 400 حرف.
content	object	نعم	تخطيط رسالة Flex، منظم باستخدام bubble و box و text ومكونات أخرى وفقًا لمواصفات Flex الخاصة بـ LINE.

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

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
        "preset": "preset_code",
        "template": {
          "en": {
            "raw": {
              "alt_text": "My raw template",
              "content": {
                "type": "bubble",
                "body": {
                  "type": "box",
                  "layout": "vertical",
                  "contents": [
                    {
                      "type": "text",
                      "text": "RECEIPT",
                      "weight": "bold",
                      "color": "#1DB446",
                      "size": "sm"
                    }
                    // Additional components...
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}