User centric API

registerUser

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

将外部 User ID 与指定设备关联。

Request headers

名称	必填	值	描述
Authorization	是	Token XXXX	用于访问 Device API 的 API Device Token。将 XXXX 替换为您实际的 Device API token。

Request body

名称	类型	描述
userId	string	要与设备关联的 User ID。如果为空，则使用 hwid。
application*	string	Pushwoosh application code
hwid*	string	Pushwoosh HWID
tz_offset	integer	设备的以秒为单位的时区偏移量。
device_type	integer	Device type。查看 /registerDevice 中的可能值。

200

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

稍后可在 /createMessage API 调用中使用（users 参数）。
通常在获取 push token 之前和调用 /registerDevice 之前调用此函数。

Example

{
  "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
  }
}

注意

对于电子邮件，请调用 /registerEmailUser。

postEvent

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

发送事件。

Request headers

名称	必填	值	描述
Authorization	是	Token XXXX	用于访问 Device API 的 API Device Token。将 XXXX 替换为您实际的 Device API token。

Request body

名称	类型	描述
hwid*	string	在 /registerDevice 请求中使用的 Hardware device ID。可与 ‘userId’ 一起使用，以识别触发事件的用户。
application*	string	Pushwoosh application code
event*	string	在 Pushwoosh Control Panel 中创建的 Event name（完全一致）。
attributes*	object	包含事件属性的 JSON 对象。如果不需要传递属性，请将其留空。
timestampUTC	integer	UTC 时间戳。
timestampCurrent	integer	本地时间的时间戳。
userId*	string	与触发事件的用户关联的 User ID。可以替换为 HWID 或与 HWID 一起使用。
device_type	integer	查看可能的值

200

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

请求中的事件名称必须与 Pushwoosh Control Panel 中的事件名称匹配。请注意，如果事件没有属性，“attributes” 属性可以为空（但不能省略）。

Example

{
  "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.
  }
}