iOS Live Activities API

เอกสารประกอบของ Apple:

• เกี่ยวกับ Live Activities
• การอัปเดตและสิ้นสุด Live Activities ด้วย ActivityKit push notifications

startLiveActivity

ใช้เมธอดนี้เพื่อสร้าง iOS Live Activities

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

อนุญาตให้สร้าง iOS Live Activities

Request body

พารามิเตอร์	ประเภท	จำเป็น/ไม่จำเป็น	คำอธิบาย
application	String	จำเป็น	Pushwoosh application code
auth	String	จำเป็น	API access token จาก Pushwoosh Control Panel
notifications	Array	จำเป็น	JSON array ของพารามิเตอร์ข้อความ ดูรายละเอียดในตาราง Notifications ด้านล่าง

Notifications

พารามิเตอร์ที่ใช้ใน array notifications:

พารามิเตอร์	ประเภท	จำเป็น/ไม่จำเป็น	คำอธิบาย
content	String	จำเป็น	เนื้อหาสำรอง (Fallback content) สำหรับอุปกรณ์ที่รัน 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	จำเป็น	ID ที่ไม่ซ้ำกันสำหรับ Live Activity ซึ่งสร้างโดยผู้ใช้
filter_code	String	ไม่จำเป็น	Filter (Segment) code เพื่อกำหนดเป้าหมายกลุ่มผู้ชมเฉพาะ
devices	Array of strings	ไม่จำเป็น	Tokens หรือ HWIDs เพื่อส่ง push notifications แบบเจาะจง สูงสุด 1000 รายการ หากกำหนดค่านี้ ข้อความจะถูกส่งไปยังอุปกรณ์ในรายการเท่านั้น หมายเหตุ: ไม่อนุญาตให้ใช้ Application Group สำหรับรายการอุปกรณ์ และ iOS push tokens ต้องเป็นตัวพิมพ์เล็ก
users	Array of strings	ไม่จำเป็น	หากกำหนดค่านี้ ข้อความจะถูกส่งไปยัง User ID ที่ระบุเท่านั้น (กำหนดผ่านการเรียก /registerUser) คุณสามารถระบุ User ID ได้สูงสุด 1000 รายการใน array หมายเหตุ: หากใช้ร่วมกับพารามิเตอร์ devices พารามิเตอร์ users จะมีความสำคัญกว่า ไม่อนุญาตให้ใช้ Application Group สำหรับรายการผู้ใช้

Response

200

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

ตัวอย่าง Request

{
  "request": {
    "application": "XXXXX-XXXXX",        // จำเป็น Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",      // จำเป็น API access token จาก Pushwoosh Control Panel
    "notifications": [{
      "live_activity": {                 // จำเป็น ข้อมูล Live Activity เพื่อสร้าง Live Activity ใน iOS
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID", // ไม่จำเป็น Unique identifier ของ Live Activity
      "filter_code": "FILTER_NAME",      // ไม่จำเป็น ระบุ filter
      "devices": [                       // ไม่จำเป็น ระบุ tokens หรือ hwids เพื่อส่ง push
          "hwid_XXXX"                    //           notifications แบบเจาะจง ไม่เกิน 1000 tokens/hwids ใน
      ],                                 //           array หากกำหนด ข้อความจะถูกส่งไปยัง
                                         //           อุปกรณ์ในรายการเท่านั้น ไม่อนุญาตให้ใช้ Application Group
                                         //           สำหรับรายการอุปกรณ์
                                         //           iOS push tokens ต้องเป็นตัวพิมพ์เล็กเท่านั้น
      "users": [                         // ไม่จำเป็น หากกำหนด ข้อความจะถูกส่งไปยัง
        "user_XXXX"                      //           user ID ที่ระบุเท่านั้น (กำหนดผ่าน /registerUser) หากระบุ
      ]                                  //           ร่วมกับพารามิเตอร์ devices พารามิเตอร์หลังจะถูก
                                         //           ละเว้น ไม่เกิน 1000 user ID ใน array
                                         //           ไม่อนุญาตให้ใช้ Application Group สำหรับรายการผู้ใช้
    }]
  }
}

หมายเหตุ:

อ่าน บทความนี้ เพื่อเรียนรู้เพิ่มเติมเกี่ยวกับการทำงานกับ Live Activities โดยใช้ Pushwoosh iOS SDK

updateLiveActivity

ใช้เมธอดนี้เพื่อจัดการ iOS Live Activities

หมายเหตุ

เอกสารประกอบของ Apple:

• เกี่ยวกับ Live Activities
• การอัปเดตและสิ้นสุด Live Activities ด้วย ActivityKit push notifications

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

อนุญาตให้สร้างและจัดการ iOS Live Activities

Request body

พารามิเตอร์	ประเภท	จำเป็น/ไม่จำเป็น	คำอธิบาย
auth	String	จำเป็น	API access token จาก Pushwoosh Control Panel
application	String	จำเป็น	Pushwoosh application code
notifications	Array	จำเป็น	JSON array ของพารามิเตอร์ข้อความ ดูรายละเอียดในตาราง Notifications ด้านล่าง

Notifications

พารามิเตอร์ที่ใช้ใน array 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	จำเป็น	Unique identifier สำหรับ Live Activity ที่กำลังอัปเดต
stale-date	Integer	ไม่จำเป็น	เวลา (เป็นวินาที) ที่แสดงถึงวันที่ที่ Live Activity จะกลายเป็น stale หรือล้าสมัย

200

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

ตัวอย่าง Request

{
  "request": {
    "application": "XXXXX-XXXXX",        // จำเป็น Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H",      // จำเป็น API access token จาก Pushwoosh Control Panel
    "notifications": [{
      "live_activity": {                 // จำเป็น ข้อมูล Live Activity เพื่ออัปเดต Live Activity ใน iOS
        "event": "update",               // จำเป็น ใช้ "update" เพื่ออัปเดต Live Activity หรือ
                                         //           "end" เพื่อปิด Live Activity
        "content-state": {               // จำเป็น Object ที่มีคู่ key-value ใช้เพื่อส่งข้อมูล
          "courierName": "NUMBER: 15",   //           ไปยัง Live Activity เพื่ออัปเดตเนื้อหา
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // ไม่จำเป็น เวลาสิ้นสุด Live Activity เป็นวินาที
        "stale-date": 23456789           // ไม่จำเป็น เวลา (เป็นวินาที) เมื่อ Live Activity กลายเป็น stale
      },
      "live_activity_id": "unique UUID"  // ไม่จำเป็น Unique identifier ของ Live Activity
    }]
  }
}

อ่านบทความนี้ เพื่อเรียนรู้เพิ่มเติมเกี่ยวกับการทำงานกับ Live Activities โดยใช้ Pushwoosh iOS SDK