واجهة برمجة تطبيقات (API) الأنشطة المباشرة في iOS

وثائق Apple:

حول الأنشطة المباشرة

تحديث وإنهاء الأنشطة المباشرة باستخدام إشعارات الدفع من ActivityKit

startLiveActivity

استخدم هذا الأسلوب لإنشاء الأنشطة المباشرة في iOS.

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

يسمح بإنشاء الأنشطة المباشرة في iOS.

جسم الطلب

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

الإشعارات

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

المعلمة	النوع	مطلوب/اختياري	الوصف
content	String	مطلوب	محتوى احتياطي للأجهزة التي تعمل بإصدارات iOS أقل من 16.1 والتي لا تدعم الأنشطة المباشرة. في iOS 16.1+ (مع دعم الأنشطة المباشرة)، يتم الحصول على المحتوى من حقل `live_activity`.
title	String	اختياري	عنوان رسالة الإشعار.
live_activity	Object	مطلوب	بيانات النشاط المباشر لإنشاء نشاط مباشر في iOS.
content-state	Object	مطلوب	محتوى إشعار النشاط المباشر.
attributes-type	String	مطلوب	نوع السمات المستخدمة في النشاط المباشر.
attributes	Object	مطلوب	سمات النشاط المباشر.
live_activity_id	String	مطلوب	معرف فريد للنشاط المباشر، يتم إنشاؤه بواسطة المستخدم.

الاستجابة

200

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

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

{
  "request": {
    "application": "XXXXX-XXXXX",        // مطلوب. رمز تطبيق Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",      // مطلوب. رمز الوصول إلى واجهة برمجة التطبيقات (API) من لوحة تحكم Pushwoosh
    "notifications": [{
      "live_activity": {                 // مطلوب. بيانات النشاط المباشر لإنشاء نشاط مباشر في iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID"  // اختياري. معرف فريد للنشاط المباشر.
    }]
  }
}

ملاحظة:

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

updateLiveActivity

استخدم هذا الأسلوب لإدارة الأنشطة المباشرة في iOS.

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

يسمح بإنشاء وإدارة الأنشطة المباشرة في iOS.

جسم الطلب

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

الإشعارات

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

المعلمة	النوع	مطلوب/اختياري	الوصف
live_activity	Object	مطلوب	بيانات النشاط المباشر لتحديث النشاط المباشر في iOS.
event	String	مطلوب	يحدد نوع الحدث. استخدم `"update"` لتحديث النشاط المباشر أو `"end"` لإغلاقه.
content-state	Object	مطلوب	كائن يحتوي على أزواج من المفاتيح والقيم يستخدم لتمرير البيانات إلى النشاط المباشر لتحديث محتواه.
dismissal-date	Integer	اختياري	الوقت (بالثواني) الذي يجب أن ينتهي فيه النشاط المباشر.
live_activity_id	String	مطلوب	معرف فريد للنشاط المباشر الذي يتم تحديثه.
relevance-score	Integer	اختياري	يخبر نظام iOS أي نشاط مباشر له أولوية أعلى من غيره. يقبل القيم من 1 إلى ما لا نهاية (يوصى بالقيم حتى 100).
stale-date	Integer	اختياري	الوقت (بالثواني) الذي يمثل التاريخ الذي يصبح فيه النشاط المباشر قديماً أو غير محدث.

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

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

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

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