API ที่เน้นผู้ใช้เป็นศูนย์กลาง

registerUser

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

เชื่อมโยง User ID ภายนอกกับอุปกรณ์ที่ระบุ

Request headers

ชื่อ	จำเป็น	ค่า	คำอธิบาย
Authorization	จำเป็น	Token `XXXX`	API Device Token สำหรับเข้าถึง Device API แทนที่ `XXXX` ด้วย Device API token ที่แท้จริงของคุณ

Request body

ชื่อ	ประเภท	คำอธิบาย
userId	string	User ID ที่จะเชื่อมโยงกับอุปกรณ์ หากว่างเปล่า ให้ใช้ hwid
application*	string	รหัสแอปพลิเคชัน Pushwoosh
hwid*	string	Pushwoosh HWID
tz_offset	integer	ออฟเซ็ตไทม์โซนเป็นวินาทีสำหรับอุปกรณ์
device_type	integer	ประเภทอุปกรณ์ ดูค่าที่เป็นไปได้ใน /registerDevice

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

สามารถใช้ในภายหลังในการเรียก API /createMessage (พารามิเตอร์ users)
เป็นเรื่องปกติที่จะเรียกใช้ฟังก์ชันนี้ก่อนที่คุณจะมี push token และก่อนการเรียก /registerDevice

{
  "request": {
    "userId": "user_3078a",                     // ไม่บังคับ หากว่างเปล่า ให้ใช้ hwid
    "application": "XXXXX-XXXXX",               // บังคับ รหัสแอปพลิเคชัน Pushwoosh
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // บังคับ รหัสอุปกรณ์ฮาร์ดแวร์
    "tz_offset": -3600,                         // ไม่บังคับ ออฟเซ็ตไทม์โซนเป็นวินาที
    "device_type": 3                            // ไม่บังคับ ประเภทอุปกรณ์ ดูใน /registerDevice
                                                //           สำหรับประเภทอุปกรณ์
  }
}

postEvent

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

เรียกใช้อีเวนต์

Request headers

ชื่อ	จำเป็น	ค่า	คำอธิบาย
Authorization	จำเป็น	Token `XXXX`	API Device Token สำหรับเข้าถึง Device API แทนที่ `XXXX` ด้วย Device API token ที่แท้จริงของคุณ

Request body

ชื่อ	ประเภท	คำอธิบาย
hwid*	string	รหัสอุปกรณ์ฮาร์ดแวร์ ที่ใช้ในคำขอ /registerDevice สามารถใช้ร่วมกับ ‘userId’ เพื่อระบุผู้ใช้ที่ทริกเกอร์อีเวนต์
application*	string	รหัสแอปพลิเคชัน Pushwoosh
event*	string	ชื่ออีเวนต์ตรงตามที่สร้างใน Pushwoosh Control Panel
attributes*	object	อ็อบเจกต์ JSON พร้อมแอตทริบิวต์ของอีเวนต์ ปล่อยให้ว่างไว้หากไม่จำเป็นต้องส่งแอตทริบิวต์ใดๆ
timestampUTC	integer	การประทับเวลาในรูปแบบ UTC
timestampCurrent	integer	การประทับเวลาในเวลาท้องถิ่น
userId*	string	User ID ที่เชื่อมโยงกับผู้ใช้ที่ทริกเกอร์อีเวนต์ สามารถแทนที่หรือใช้ร่วมกับ HWID ได้
device_type	integer	ดูค่าที่เป็นไปได้ในเมธอด /registerDevice

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "code": "61BC9-84DD0"
  }
}

ชื่ออีเวนต์ในคำขอต้องตรงกับชื่ออีเวนต์ใน Pushwoosh Control Panel โปรดทราบว่าคุณสมบัติ “attributes” อาจว่างเปล่าได้ (แต่ห้ามละเว้น) ในกรณีที่อีเวนต์ไม่มีแอตทริบิวต์

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // บังคับ รหัสอุปกรณ์ฮาร์ดแวร์ที่ใช้ใน /registerDevice API
                                                //           สามารถใช้ร่วมกับ userId เพื่อระบุ
                                                //           ผู้ใช้ที่ทริกเกอร์อีเวนต์
    "application": "XXXXX-XXXXX",               // บังคับ รหัสแอปพลิเคชัน Pushwoosh
    "event": "activityCompleted",               // บังคับ ชื่ออีเวนต์ตรงตามที่สร้างใน Pushwoosh Control Panel
    "attributes": {                             // บังคับ ปล่อยให้ว่างไว้หากไม่จำเป็นต้องส่งแอตทริบิวต์ใดๆ
      "login": "facebook",
      "success": "yes",
      "internet": "wifi",
    },
    "timestampUTC": 1435228403,                 // ไม่บังคับ การประทับเวลาในรูปแบบ UTC
    "timestampCurrent": 1435253603,             // ไม่บังคับ การประทับเวลาในเวลาท้องถิ่น
    "userId": "someuser@user.com",              // บังคับ User ID ที่ใช้สำหรับการระบุตัวตน
                                                //           ผู้ใช้บนอุปกรณ์หลายเครื่อง สามารถแทนที่
                                                //           หรือใช้ร่วมกับ HWID
    "device_type": 1                            // ไม่บังคับ
  }
}