Audience API

bulkSetTags

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

Устанавливает значения тегов для списка устройств.

Важно

При использовании метода bulkSetTags убедитесь, что значения тегов устанавливаются минимум для 50 устройств. Для установки тегов для одного устройства используйте метод setTags.

Тело запроса

Имя	Тип	Описание
application*	String	Pushwoosh application code (Код приложения)
auth*	String	API access token из Control Panel Pushwoosh.
create_missing_tags	Boolean	Если true, отсутствующие теги создаются автоматически.
devices*	Object	Массив устройств.
devices.hwid	String	Может использоваться для идентификации устройства вместо user_id или push_token. Подробнее
devices.user_id	String	Может использоваться для идентификации пользователя вместо hwid или push_token. Подробнее
devices.push_token	String	Может использоваться для идентификации устройства вместо hwid или user_id. Подробнее
devices.list_operator	String	Определяет способ установки значений для тегов типа list: set (установить), append (добавить) или remove (удалить).
devices.tags*	Object	Значения, которые нужно установить для указанных тегов.

OK

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

Error

{
  "message": "invalid request"
}

Request:

{
  "application": "application code",   // обязательно. Код приложения Pushwoosh
  "auth": "Pushwoosh auth token",      // обязательно. API access token из Control Panel Pushwoosh
  "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",            // обязательно. Для списочных тегов. Определяет способ установки значений для
                                       //           тегов типа list: 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

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

Возвращает статус операции /bulkSetTags.

Параметры пути

Имя	Тип	Описание
request_id	String	request id из предыдущего вызова /bulkSetTags

Параметры запроса (Query Parameters)

Имя	Тип	Описание
detailed	Boolean	(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

Регистрирует несколько устройств в Pushwoosh одним запросом. Также позволяет указывать различные теги для каждого устройства.

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

Параметры тела запроса

Параметр	Тип	Обязательно	Описание
application	string	Да	Pushwoosh application code (Код приложения)
auth	string	Да	API access token.
devices	array	Да	Массив объектов устройств. Каждый объект представляет устройство и связанные с ним данные. См. подробности в таблице Параметры объекта устройства ниже.

Параметры объекта устройства

Параметр	Тип	Обязательно	Описание
hwid	string	Да	Hardware ID или уникальный идентификатор устройства.
push_token	string	Да	Push-токен для устройства.
platform	integer	Да	Идентификатор платформы. Подробнее
list_operator	string	Нет	Определяет действие для тегов типа list: - “append”: Добавить указанное значение в список тегов. - “remove”: Удалить указанное значение из списка тегов. Примечание: Если параметр list_operator не указан, все существующие значения в списке тегов будут заменены предоставленными значениями.
tags	object	Нет	Пользовательские теги, присвоенные устройству. Теги — это пары ключ-значение, используемые для сегментации.

Пример запроса

{
  "application": "application code",   // обязательно. Код приложения Pushwoosh
  "auth": "Pushwoosh auth token",      // обязательно. API access token из Control Panel Pushwoosh
  "devices": [{                        // обязательно. Массив устройств
    "hwid": "device hwid",             // обязательно. Уникальный идентификатор устройства (может быть email).
    "push_token": "device push token", // обязательно. Push-токен для устройства.
    "platform": 14,                    // обязательно. Платформа устройства (например, 14 для email).
    "list_operator": "append",         // опционально. Для списочных тегов. Добавляет или удаляет указанное значение(я) из тега типа list.
    "tags": {                          // опционально. Значения для установки указанных тегов.
      "language": "en",                //           используйте правильный тип значения.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // обязательно. Уникальный идентификатор второго устройства.
    "push_token": "device push token 2", // обязательно. Push-токен для устройства.
    "platform": 14,                    // обязательно. Платформа устройства.
    "list_operator": "remove",         // опционально. Добавляет или удаляет значения из тегов типа list.
    "tags": {                          // опционально. Значения для удаления из указанных тегов.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // обязательно. Уникальный идентификатор третьего устройства.
    "push_token": "device push token 3", // обязательно. Push-токен для устройства.
    "platform": 14,                    // обязательно. Платформа устройства.
    "tags": {                          // опционально. Значения для установки указанных тегов.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Ответ

Метод возвращает ID операции, который можно использовать для отслеживания статуса и результатов процесса массовой регистрации.

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

Статус bulkRegisterDevice

Вы можете проверить статус процесса массовой регистрации, выполнив следующий GET запрос:

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

Параметр	Тип	Обязательно	Описание
request_id	string	Да	ID запроса, возвращенный в ответе на POST запрос.
detailed	boolean	Нет	Если установлено значение true, ответ включает подробные результаты для каждого зарегистрированного устройства.

Пример ответа

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

Удаляет регистрацию нескольких устройств из Pushwoosh одним запросом.

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

Параметры тела запроса

Параметр	Тип	Обязательно	Описание
application	string	Да	Pushwoosh application code (Код приложения)
auth	string	Да	API access token
devices	array	Да	Массив объектов устройств. Каждый объект представляет устройство и связанные с ним данные. См. подробности в таблице Параметры объекта устройства ниже.

Параметры объекта устройства

Параметр	Тип	Обязательно	Описание
hwid	string	Да	Hardware ID или уникальный идентификатор устройства. Подробнее

Пример запроса

{
  "application": "application code",   // обязательно. Код приложения Pushwoosh
  "auth": "Pushwoosh auth token",      // обязательно. API access token из Control Panel Pushwoosh
  "devices": [{                        // обязательно. Массив устройств
    "hwid": "device hwid",             // обязательно. Уникальный идентификатор устройства (может быть email).
  },
  {
    "hwid": "device hwid 2",           // обязательно. Уникальный идентификатор второго устройства.
  },
  {
    "hwid": "device hwid 3",           // обязательно. Уникальный идентификатор третьего устройства.
  }]
}

Ответ

Метод возвращает ID операции, который можно использовать для отслеживания статуса и результатов массового процесса.

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

Статус bulkUnregisterDevice

Вы можете проверить статус процесса массового удаления регистрации, выполнив следующий GET запрос:

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

Параметр	Тип	Обязательно	Описание
request_id	string	Да	ID запроса, возвращенный в ответе на POST запрос.
detailed	boolean	Нет	Если установлено значение true, ответ включает подробные результаты для каждого удаленного устройства.

Пример ответа

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