跳到内容
用户指南支持 请求演示 登录
Pushwoosh.com

Audience API

bulkSetTags

Anchor link to

POST https://api.pushwoosh.com/api/v2/audience/bulkSetTags

为设备列表设置标签值。

Request Body

Anchor link to
名称类型描述
application*StringPushwoosh Application code
auth*String来自 Pushwoosh 控制面板的 API access token。
create_missing_tagsBoolean如果为 true，将自动创建缺失的标签。
devices*Object设备数组。
devices.hwidString可用于代替 user_id 或 push_token 来标识设备。了解更多
devices.user_idString可用于代替 hwid 或 push_token 来标识用户。了解更多
devices.push_tokenString可用于代替 hwid 或 user_id 来标识设备。了解更多
devices.list_operatorString定义如何设置列表类型 标签 的值：set（设置）、append（追加）或 remove（移除）
devices.tags*Object为指定标签设置的值。
{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}
Request:
{
  "application": "application code",   // 必填。Pushwoosh App 代码
  "auth": "Pushwoosh auth token",      // 必填。来自 Pushwoosh 控制面板的 API access token
  "create_missing_tags": false,        // 可选。是否自动创建缺失的标签
  "devices": [{                        // 必填。设备数组
    "hwid": "device hwid",             // 可选。可用于代替 "user_id" 或 "push_token"
                                       //       来标识设备。
    "user_id": "user ID",              // 可选。可用于代替 "hwid" 或 "push_token" 来标识用户。
    "push_token": "device push token", // 可选。可用于代替 "hwid" 或 "user_id" 来标识设备。
    "list_operator": "set",            // 必填。用于列表标签。定义如何设置列表类型标签的值：
                                       //       set、append 或 remove
    "tags": {                          // 必填。为指定标签设置的值。
      "tag_name": "tagvalue",          //       使用正确的值类型
      "tag_name2": "tagvalue2"
    }
  }]
}
Response:
{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkSetTags status

Anchor link to

GET https://api.pushwoosh.com/api/v2/audience/bulkSetTags/{request_id}?detailed=false

返回 /bulkSetTags 操作的状态。

Path Parameters

Anchor link to
名称类型描述
request_idString上一次 /bulkSetTags 调用返回的 request id

Query Parameters

Anchor link to
名称类型描述
detailedBoolean(true/false) 是否返回每个设备的详细信息
Response:
{
  "request_id": "id of the request",
  "status": "Completed",          // 或者是 "Pending", "Failed"
  "progress": 100,                // 任务进度 0-100
  "devices_success": 100,         // 成功的设备
  "devices_not_found": 0,         // 在 Pushwoosh 中未找到的设备
  "devices_failed": 0,            // 出错
  "devices": [{                   // 设备报告（仅当 detailed = true 时）
    "hwid": "device hwid",
    "status": "done",             // 或者是 "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "tag not found",
      "tagName3": "wrong value. expect :string"
    }
  }]
}

bulkRegisterDevice

Anchor link to

在一次请求中向 Pushwoosh 注册多个设备。它还允许为每个设备指定各种标签。

POST https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice

Request body parameters

Anchor link to
参数类型必填描述
applicationstring是Pushwoosh Application code
authstring是API access token。
devicesarray是设备对象数组。每个对象代表一个设备及其关联数据。详见下方的 Device object parameters 表。

Device object parameters

Anchor link to
参数类型必填描述
hwidstring是Hardware ID 或设备的唯一标识符。
push_tokenstring是设备的 Push token。
platforminteger是平台标识符。了解更多
list_operatorstring否确定列表类型标签的操作：
- “append”：将指定值添加到标签列表。
- “remove”：从标签列表中移除指定值。
注意：如果未指定 list_operator 参数，标签列表中的所有现有值将被提供的值替换。
tagsobject否分配给设备的自定义 标签。标签是用于细分的键值对。

Request example

Anchor link to
{
  "application": "application code",   // 必填。Pushwoosh App 代码
  "auth": "Pushwoosh auth token",      // 必填。来自 Pushwoosh 控制面板的 API access token
  "devices": [{                        // 必填。设备数组
    "hwid": "device hwid",             // 必填。设备的唯一标识符（可以是电子邮件）。
    "push_token": "device push token", // 必填。设备的推送通知令牌。
    "platform": 14,                    // 必填。设备平台（例如，14 代表电子邮件）。
    "list_operator": "append",         // 可选。用于列表标签。添加或移除列表类型标签的指定值。
    "tags": {                          // 可选。为指定标签设置的值。
      "language": "en",                //       使用正确的值类型。
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // 必填。第二个设备的唯一标识符。
    "push_token": "device push token 2", // 必填。设备的推送通知令牌。
    "platform": 14,                    // 必填。设备平台。
    "list_operator": "remove",         // 可选。添加或移除列表类型标签的值。
    "tags": {                          // 可选。从指定标签中移除的值。
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // 必填。第三个设备的唯一标识符。
    "push_token": "device push token 3", // 必填。设备的推送通知令牌。
    "platform": 14,                    // 必填。设备平台。
    "tags": {                          // 可选。为指定标签设置的值。
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Response

Anchor link to

该方法返回一个操作 ID，可用于跟踪批量注册过程的状态和结果。

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkRegisterDevice status

Anchor link to

您可以通过发送以下 GET 请求来检查批量注册过程的状态：

GET https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice/{request_id}?detailed=true

参数类型必填描述
request_idstring是POST 请求返回的 request ID。
detailedboolean否如果设置为 true，响应将包含每个注册设备的详细结果。

Example response

Anchor link to
{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}

bulkUnregisterDevice

Anchor link to

在一次请求中从 Pushwoosh 注销多个设备。

POST https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice

Request body parameters

Anchor link to
参数类型必填描述
applicationstring是Pushwoosh Application code
authstring是API access token
devicesarray是设备对象数组。每个对象代表一个设备及其关联数据。详见下方的 Device object parameters 表。

Device object parameters

Anchor link to
参数类型必填描述
hwidstring是Hardware ID 或设备的唯一标识符。了解更多

Request example

Anchor link to
{
  "application": "application code",   // 必填。Pushwoosh App 代码
  "auth": "Pushwoosh auth token",      // 必填。来自 Pushwoosh 控制面板的 API access token
  "devices": [{                        // 必填。设备数组
    "hwid": "device hwid",             // 必填。设备的唯一标识符（可以是电子邮件）。
  },
  {
    "hwid": "device hwid 2",           // 必填。第二个设备的唯一标识符。
  },
  {
    "hwid": "device hwid 3",           // 必填。第三个设备的唯一标识符。
  }]
}

Response

Anchor link to

该方法返回一个操作 ID，可用于跟踪批量处理过程的状态和结果。

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkUnregisterDevice status

Anchor link to

您可以通过发送以下 GET 请求来检查批量注销过程的状态：

GET https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice/{request_id}?detailed=true

参数类型必填描述
request_idstring是POST 请求返回的 request ID。
detailedboolean否如果设置为 true，响应将包含每个注销设备的详细结果。

Example response

Anchor link to
{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}