Перейти к содержанию
Руководства пользователяПоддержка Запросить демо Войти
Pushwoosh.com

Audience API

bulkSetTags

Anchor link to

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

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

Тело запроса

Anchor link to
ИмяТипОписание
application*StringКод приложения Pushwoosh
auth*StringТокен доступа API из Панели управления Pushwoosh.
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Определяет, как устанавливать значения для тегов типа “list”: set, append или remove
devices.tags*ObjectЗначения, которые нужно установить для указанных тегов.
{
  "request_id": "request_id для использования в GET-методе для получения статуса задачи",
  "status": "В ожидании"
}
Запрос:
{
  "application": "application code",   // обязательно. Код приложения Pushwoosh
  "auth": "Pushwoosh auth token",      // обязательно. Токен доступа API из Панели управления 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". Определяет, как устанавливать значения для
                                       //           тегов типа "list": set, append или remove
    "tags": {                          // обязательно. Значения для указанных тегов.
      "tag_name": "tagvalue",          //           используйте правильный тип значения
      "tag_name2": "tagvalue2"
    }
  }]
}
Ответ:
{
  "request_id": "request_id для использования в GET-методе для получения статуса задачи",
  "status": "В ожидании"
}

Статус bulkSetTags

Anchor link to

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

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

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

Anchor link to
ИмяТипОписание
request_idStringid запроса из предыдущего вызова /bulkSetTags

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

Anchor link to
ИмяТипОписание
detailedBoolean(true/false) возвращать ли подробную информацию по каждому устройству
Ответ:
{
  "request_id": "id запроса",
  "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": "тег не найден",
      "tagName3": "неверное значение. ожидается :string",
    }
  }]
}

bulkRegisterDevice

Anchor link to

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

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

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

Anchor link to
ПараметрТипОбязательныйОписание
applicationstringДаКод приложения Pushwoosh
authstringДаТокен доступа API.
devicesarrayДаМассив объектов устройств. Каждый объект представляет устройство и связанные с ним данные. Подробности смотрите в таблице Параметры объекта устройства ниже.

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

Anchor link to
ПараметрТипОбязательныйОписание
hwidstringДаАппаратный ID или уникальный идентификатор устройства.
push_tokenstringДаPush-токен устройства.
platformintegerДаИдентификатор платформы. Подробнее
list_operatorstringНетОпределяет действие для тегов типа “list”:
- “append”: Добавить указанное значение в список тегов.
- “remove”: Удалить указанное значение из списка тегов.
Примечание: Если параметр list_operator не указан, все существующие значения в списке тегов будут заменены предоставленными значениями.
tagsobjectНетПользовательские теги, присвоенные устройству. Теги представляют собой пары “ключ-значение”, используемые для сегментации.

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

Anchor link to
{
  "application": "application code",   // обязательно. Код приложения Pushwoosh
  "auth": "Pushwoosh auth token",      // обязательно. Токен доступа API из Панели управления Pushwoosh
  "devices": [{                        // обязательно. Массив устройств
    "hwid": "device hwid",             // обязательно. Уникальный идентификатор устройства (может быть email).
    "push_token": "device push token", // обязательно. Токен push-уведомлений для устройства.
    "platform": 14,                    // обязательно. Платформа устройства (например, 14 для email).
    "list_operator": "append",         // опционально. Для тегов типа "list". Добавляет или удаляет указанное значение(я) из тега типа "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"
    }
  }]
}

Ответ

Anchor link to

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

{
  "request_id": "request_id для использования в GET-методе для получения статуса задачи",
  "status": "В ожидании"
}

Статус bulkRegisterDevice

Anchor link to

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

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

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

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

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

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

Anchor link to
ПараметрТипОбязательныйОписание
applicationstringДаКод приложения Pushwoosh
authstringДаТокен доступа API
devicesarrayДаМассив объектов устройств. Каждый объект представляет устройство и связанные с ним данные. Подробности смотрите в таблице Параметры объекта устройства ниже.

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

Anchor link to
ПараметрТипОбязательныйОписание
hwidstringДаАппаратный ID или уникальный идентификатор устройства. Подробнее

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

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

Ответ

Anchor link to

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

{
  "request_id": "request_id для использования в GET-методе для получения статуса задачи",
  "status": "В ожидании"
}

Статус bulkUnregisterDevice

Anchor link to

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

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

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

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

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