ข้ามไปยังเนื้อหา

API กล่องข้อความ

getInboxMessages

ส่งคืนรายการข้อความใน Inbox สำหรับ HWID ที่ระบุ

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

ส่วนหัวของคำขอ (Request headers)

ชื่อ (Name)	จำเป็น (Required)	ค่า (Value)	คำอธิบาย (Description)
Authorization	จำเป็น	Token `XXXX`	โทเค็น API ของอุปกรณ์เพื่อเข้าถึง Device API แทนที่ `XXXX` ด้วยโทเค็น API ของอุปกรณ์จริงของคุณ

เนื้อหาของคำขอ (Request Body)

ชื่อ (Name)	ประเภท (Type)	คำอธิบาย (Description)
application*	string	รหัสแอปพลิเคชัน Pushwoosh
userId*	string	หากไม่มีการตั้งค่า User ID แบบกำหนดเอง ให้ใช้ HWID
hwid	string	Hardware ID ของอุปกรณ์ เพื่อรับข้อความ Inbox
last_code	string	รหัสของข้อความสุดท้ายที่ดึงมาในการตอบกลับก่อนหน้า หากเว้นว่าง จะส่งคืนข้อความแรกสุด
count	integer	จำนวนข้อความที่จะแสดงในการตอบกลับครั้งเดียว ใช้สำหรับการแบ่งหน้า (pagination) 0 สำหรับการโหลดข้อความทั้งหมดใน Inbox

200

{
  "response": {
    "messages": [{                      // อาร์เรย์ของข้อความที่จัดเก็บอยู่ใน Inbox ของผู้ใช้ในปัจจุบัน
      "inbox_id": "avde1c792cd",
      "rt": "146078676",                // วันที่ที่จะลบข้อความออกจาก Inbox
      "send_date": "1459758676",        // วันที่ที่ข้อความถูกบันทึกลงใน Inbox
      "order": "59138176",              // ตำแหน่งในการแสดงผลของ Inbox
      "title": "New Rich Media in inbox!",
      "text": "Hi! New feature is available right now!",
      "action_type": "RichMedia",
      "action_params": {                // payload ที่อธิบายการกระทำเมื่อเปิด push
        "rm": "{\"url\":\"https:\/\/richmedia.pushwoosh.com\/C82F7-51FC1.zip\",\"ts\":\"1459758676\",\"tags\":{\"tagName\":\"tagValue\"}}"
      },
      "status": 1,                      // 1 - ส่งแล้ว, 2 - อ่านแล้ว, 3 - เปิดแล้ว,
                                        // 4 - ลบแล้ว (โดยผู้ใช้), 5 - ลบจาก Control Panel
      "hash":"1C"                       // แฮชโค้ดของการแจ้งเตือนแบบพุช
    }, {
      ...
    }],
    "next":"afarew511",                 // รหัส Inbox ถัดไปที่จะถูกส่งคืนโดย
                                        // คำขอ /getInboxMessages ครั้งต่อไป
    "deleted": ["bbaf85ab", "a41957b"], // รายการข้อความที่ถูกลบจาก Control Panel
    "new_inbox": 6                      // จำนวนข้อความใน Inbox ที่ส่งแล้วสำหรับผู้ใช้นั้น (สามารถใช้สำหรับ badge)
  }
}

{
  "request": {
    "application": "XXXXX-XXXXX", // จำเป็น รหัสแอป Pushwoosh
     "userId": "user_name_1",     // จำเป็น User ID ที่ลงทะเบียนใน Pushwoosh
     "device_type": 1             // ไม่จำเป็น สำหรับประเภทอุปกรณ์ โปรดดูที่ /registerDevice
  }
}

inboxStatus

อัปเดตสถานะของข้อความ Inbox ที่เฉพาะเจาะจง

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

ส่วนหัวของคำขอ (Request headers)

ชื่อ (Name)	จำเป็น (Required)	ค่า (Value)	คำอธิบาย (Description)
Authorization	จำเป็น	Token `XXXX`	โทเค็น API ของอุปกรณ์เพื่อเข้าถึง Device API แทนที่ `XXXX` ด้วยโทเค็น API ของอุปกรณ์จริงของคุณ

เนื้อหาของคำขอ (Request Body)

ชื่อ (Name)	ประเภท (Type)	คำอธิบาย (Description)
application*	string	รหัสแอปพลิเคชัน Pushwoosh
inbox_code*	string	สามารถรับได้จากรายละเอียดข้อความใน Control Panel หรือจากพารามิเตอร์ “order” ของคำขอ /getInboxMessages
hash	string	แฮชโค้ดของข้อความ Inbox
hwid	string	Hardware ID ของอุปกรณ์ เพื่ออัปเดตสถานะ Inbox
time	string	ไทม์สแตมป์ของวันที่ส่ง
userID*	string	หากไม่มีการตั้งค่า User ID แบบกำหนดเอง ให้ใช้ HWID
status*	integer	1 - ส่งแล้ว, 2 - อ่านแล้ว, 3 - เปิดแล้ว, 4 - ลบโดยผู้ใช้
device_type	integer	ดูค่าที่เป็นไปได้ด้านล่าง

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

{
  "request": {
    "application": "XXXXX-XXXXX",    // จำเป็น รหัสแอป Pushwoosh
    "inbox_code": "874393934032909", // จำเป็น พารามิเตอร์ "order" ของคำขอ /getInboxMessages
    "hash": "1C",                    // ไม่จำเป็น
    "userId": "some_user",           // จำเป็น
    "status": 2,                     // จำเป็น สถานะที่จะตั้งค่า: 1-ส่งแล้ว, 2-อ่านแล้ว, 3-เปิดแล้ว, 4-ลบแล้ว (โดยผู้ใช้)
    "device_type": 3                 // ไม่จำเป็น
  }
}