واجهة برمجة تطبيقات iOS Live Activities

وثائق Apple:

• حول Live Activities
• تحديث وإنهاء Live Activities باستخدام إشعارات ActivityKit

startLiveActivity

استخدم هذه الطريقة لإنشاء iOS Live Activities.

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

تسمح بإنشاء iOS Live Activities.

Request body

المعامل	النوع	مطلوب/اختياري	الوصف
application	String	مطلوب	كود تطبيق Pushwoosh
auth	String	مطلوب	API access token من لوحة تحكم Pushwoosh.
notifications	Array	مطلوب	مصفوفة JSON لمعاملات الرسالة. انظر التفاصيل في جدول الإشعارات أدناه.

Notifications

المعاملات المستخدمة في المصفوفة notifications:

المعامل	النوع	مطلوب/اختياري	الوصف
content	String	مطلوب	محتوى احتياطي للأجهزة التي تعمل بإصدارات iOS أقل من 16.1 التي لا تدعم Live Activity. في iOS 16.1+ (مع دعم Live Activity)، يتم الحصول على المحتوى من حقل live_activity.
title	String	اختياري	عنوان رسالة الإشعار.
live_activity	Object	مطلوب	بيانات Live Activity لإنشاء Live Activity في iOS.
content-state	Object	مطلوب	محتوى لإشعار Live Activity.
attributes-type	String	مطلوب	نوع السمات (attributes) المستخدمة في Live Activity.
attributes	Object	مطلوب	سمات (Attributes) لـ Live Activity.
live_activity_id	String	مطلوب	معرف فريد لـ Live Activity، يتم إنشاؤه بواسطة المستخدم.
filter_code	String	اختياري	كود الفلتر (Segment) لاستهداف شرائح جمهور محددة.
devices	Array of strings	اختياري	Tokens أو HWIDs لإرسال إشعارات push مستهدفة، بحد أقصى 1000. إذا تم تعيينه، سيتم إرسال الرسالة فقط إلى الأجهزة الموجودة في القائمة. ملاحظة: مجموعة التطبيقات (Application Group) لقائمة الأجهزة غير مسموح بها، ويجب أن تكون رموز iOS push tokens بأحرف صغيرة.
users	Array of strings	اختياري	إذا تم تعيينه، سيتم تسليم الرسالة فقط إلى User IDs المحددة (المعينة عبر استدعاء /registerUser). يمكنك تضمين ما يصل إلى 1000 user ID في المصفوفة. ملاحظة: إذا تم استخدامه مع المعامل devices، ستكون الأولوية للمعامل users. مجموعة التطبيقات (Application Group) لقائمة المستخدمين غير مسموح بها.

Response

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

Request example

{
  "request": {
    "application": "XXXXX-XXXXX",        // مطلوب. كود تطبيق Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // مطلوب. API access token من لوحة تحكم Pushwoosh
    "notifications": [{
      "live_activity": {                 // مطلوب. بيانات Live Activity لإنشاء Live Activity في iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID", // اختياري. المعرف الفريد لـ Live Activity.
      "filter_code": "FILTER_NAME",      // اختياري. تحديد الفلتر.
      "devices": [                       // اختياري. حدد tokens أو hwids لإرسال إشعارات push
          "hwid_XXXX"                    //           مستهدفة. لا يزيد عن 1000 tokens/hwids في
      ],                                 //           المصفوفة. إذا تم تعيينه، سيتم إرسال الرسالة فقط إلى
                                         //           الأجهزة الموجودة في القائمة. Application Group لـ
                                         //           قائمة الأجهزة غير مسموح بها.
                                         //           رموز iOS push tokens يجب أن تكون بأحرف صغيرة فقط.
      "users": [                         // اختياري. إذا تم تعيينه، سيتم تسليم الرسالة فقط إلى
        "user_XXXX"                      //           user ID's المحددة (المعينة عبر استدعاء /registerUser). إذا تم تحديده
      ]                                  //           مع المعامل devices، سيتم تجاهل الأخير.
                                         //           لا يزيد عن 1000 user ID في المصفوفة.
                                         //           Application Group لقائمة المستخدمين غير مسموح بها.
    }]
  }
}

ملاحظة:

اقرأ هذه المقالة لمعرفة المزيد حول العمل مع Live Activities باستخدام Pushwoosh iOS SDK.

updateLiveActivity

استخدم هذه الطريقة لإدارة iOS Live Activities.

ملاحظة

وثائق Apple:

• حول Live Activities
• تحديث وإنهاء Live Activities باستخدام إشعارات ActivityKit

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

يسمح بإنشاء وإدارة iOS Live Activities.

Request body

المعامل	النوع	مطلوب/اختياري	الوصف
auth	String	مطلوب	API access token من لوحة تحكم Pushwoosh.
application	String	مطلوب	كود تطبيق Pushwoosh
notifications	Array	مطلوب	مصفوفة JSON لمعاملات الرسالة. انظر التفاصيل في جدول الإشعارات أدناه.

Notifications

المعاملات المستخدمة في المصفوفة notifications:

المعامل	النوع	مطلوب/اختياري	الوصف
live_activity	Object	مطلوب	بيانات Live Activity لتحديث Live Activity في iOS.
event	String	مطلوب	يحدد نوع الحدث. استخدم "update" لتحديث Live Activity أو "end" لإغلاقه.
content-state	Object	مطلوب	كائن (Object) يحتوي على أزواج مفتاح-قيمة (key-value) تُستخدم لتمرير البيانات إلى Live Activity لتحديث محتواه.
dismissal-date	Integer	اختياري	الوقت (بالثواني) الذي يجب أن ينتهي فيه Live Activity.
live_activity_id	String	مطلوب	معرف فريد لـ Live Activity الذي يتم تحديثه.
stale-date	Integer	اختياري	الوقت (بالثواني) الذي يمثل التاريخ الذي يصبح فيه Live Activity قديماً (stale) أو منتهي الصلاحية.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

Request example

{
  "request": {
    "application": "XXXXX-XXXXX",        // مطلوب. كود تطبيق Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // مطلوب. API access token من لوحة تحكم Pushwoosh
    "notifications": [{
      "live_activity": {                 // مطلوب. بيانات Live Activity لتحديث Live Activity في iOS
        "event": "update",               // مطلوب. استخدم "update" لتحديث Live Activity أو
                                         //           "end" لإغلاق Live Activity
        "content-state": {               // مطلوب. كائن يحتوي على أزواج مفتاح-قيمة تُستخدم لتمرير البيانات
          "courierName": "NUMBER: 15",   //           إلى Live Activity لتحديث محتواه
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // اختياري. وقت إنهاء Live Activity بالثواني
        "stale-date": 23456789           // اختياري. الوقت (بالثواني) الذي يصبح فيه Live Activity قديماً
      },
      "live_activity_id": "unique UUID"  // اختياري. المعرف الفريد لـ Live Activity.
    }]
  }
}

اقرأ هذه المقالة لمعرفة المزيد حول العمل مع Live Activities باستخدام Pushwoosh iOS SDK.