User centric 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 application code
hwid*	string	Pushwoosh HWID
tz_offset	integer	Timezone offset ในหน่วยวินาทีสำหรับอุปกรณ์
device_type	integer	Device type ดูค่าที่เป็นไปได้ใน `/registerDevice`

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

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

{
  "request": {
    "userId": "user_3078a",                     // ไม่บังคับ หากว่างเปล่า ให้ใช้ hwid
    "application": "XXXXX-XXXXX",               // จำเป็น Pushwoosh application code
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // จำเป็น Hardware device ID
    "tz_offset": -3600,                         // ไม่บังคับ Timezone offset ในหน่วยวินาที
    "device_type": 3                            // ไม่บังคับ Device type ดู /registerDevice
                                                //           สำหรับประเภทอุปกรณ์
  }
}

postEvent

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

เรียก event

Request headers

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

Request body

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

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

ชื่อ event ใน request ต้องตรงกับชื่อ event ใน Pushwoosh Control Panel โปรดทราบว่า property “attributes” อาจว่างเปล่า (แต่ห้ามละเว้น) ในกรณีที่ event ไม่มี attributes

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