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

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

ตัวอย่างคำขอ

{
  "request": {
    "userId": "user_3078a",                     // optional. If empty, use hwid
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID
    "tz_offset": -3600,                         // optional. Timezone offset in seconds
    "device_type": 3                            // optional. Device type, see /registerDevice
                                                //           for device types
  }
}

ตัวอย่างการตอบกลับ

200

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

หมายเหตุ

สำหรับอีเมล ให้เรียกใช้ /registerEmailUser

deleteUser

POST https://api.pushwoosh.com/api/v2/device-api/deleteUser

ลบผู้ใช้และอุปกรณ์ทั้งหมดที่เชื่อมโยงกับ User ID ที่ระบุภายในแอปพลิเคชัน คำขอจะถูกประมวลผลแบบอะซิงโครนัส และ endpoint จะส่งคืน 200 OK ทันทีที่คำขอลบได้รับการยอมรับเพื่อการประมวลผล

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

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

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

ชื่อ	จำเป็น	ประเภท	คำอธิบาย
application	ใช่	string	รหัสแอปพลิเคชัน Pushwoosh
user_id	ใช่	string	User ID ที่จะลบ อุปกรณ์ทั้งหมดที่เชื่อมโยงกับผู้ใช้นี้ในแอปพลิเคชันที่ระบุจะถูกลบออก

ตัวอย่างคำขอ

{
  "application": "XXXXX-XXXXX",   // required. Pushwoosh application code
  "user_id": "user_3078a"         // required. User ID to delete
}

ตัวอย่างการตอบกลับ

200

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

รหัสสถานะ

รหัสสถานะ HTTP	status_code	คำอธิบาย
200	200	คำขอลบได้รับการยอมรับ
200	210	ข้อผิดพลาดของอาร์กิวเมนต์ ดู status_message สำหรับข้อมูลเพิ่มเติม
400	N/A	สตริงคำขอมีรูปแบบไม่ถูกต้อง
401	N/A	ไม่มีโทเค็น Authorization หรือโทเค็นไม่ถูกต้อง
500	500	ข้อผิดพลาดภายใน

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

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

ตัวอย่างคำขอ

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID used in a /registerDevice API.
                                                //           Can be used along with an userId to identify a
                                                //           user who has triggered an event.
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "event": "activityCompleted",               // required. Event name exactly as created in Pushwoosh Control Panel
    "attributes": {                             // required. Leave empty if no attributes need to be passed.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi"
    },
    "timestampUTC": 1435228403,                 // optional. Timestamp in UTC
    "timestampCurrent": 1435253603,             // optional. Timestamp in local time
    "userId": "someuser@user.com",              // required. A user id which is used for identification of
                                                //           users on multiple devices. Can be replaced by
                                                //           or used along with an HWID.
    "device_type": 1                            // optional.
  }
}

ตัวอย่างการตอบกลับ

200

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