Audience API

bulkSetTags

POST https://api.wavesend.ru/api/v2/audience/bulkSetTags

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

Важно

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

Тело запроса

Название	Тип	Описание
application*	String	Код приложения Wavesend
auth*	String	API Access token из Wavesend Control Panel.
create_missing_tags	Boolean	Если true, отсутствующие Tags создаются автоматически.
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	Определяет, как устанавливать значения для Tags списочного типа: set, append или remove
devices.tags*	Object	Значения, которые нужно установить для указанных Tags.

ОК

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

Ошибка

{
  "message": "invalid request"
}

Запрос:

{
  "application": "application code",   // обязательно. Код приложения Wavesend
  "auth": "Wavesend auth token",       // обязательно. API Access token из Wavesend Control Panel
  "create_missing_tags": false,        // опционально. Следует ли автоматически создавать отсутствующие Tags
  "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",            // обязательно. Для Tags-списков. Определяет, как устанавливать значения для
                                       //           Tags списочного типа: set, append или remove
    "tags": {                          // обязательно. Значения для установки для указанных Tags.
      "tag_name": "tagvalue",          //           используйте правильный тип значения
      "tag_name2": "tagvalue2"
    }
  }]
}

Ответ:

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

Статус bulkSetTags

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

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

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

Название	Тип	Описание
request_id	String	ID запроса из предыдущего вызова /bulkSetTags

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

Название	Тип	Описание
detailed	Boolean	(true/false) возвращать ли подробную информацию по каждому устройству

Ответ:

{
  "request_id": "ID запроса",
  "status": "Completed",          // также "Pending", "Failed"
  "progress": 100,                // прогресс выполнения задачи 0-100
  "devices_success": 100,         // устройства, обработанные успешно
  "devices_not_found": 0,         // устройства не найдены в Wavesend
  "devices_failed": 0,            // устройства, обработанные с ошибкой
  "devices": [{                   // отчет по устройствам (только при detailed = true)
    "hwid": "device hwid",
    "status": "done",             // также "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "tag не найден",
      "tagName3": "неверное значение. ожидается :string",
    }
  }]
}

bulkRegisterDevice

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

POST https://api.wavesend.ru/api/v2/audience/bulkRegisterDevice

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

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

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

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

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

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

Ответ

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

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

Статус bulkRegisterDevice

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

GET https://api.wavesend.ru/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

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

POST https://api.wavesend.ru/api/v2/audience/bulkUnregisterDevice

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

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

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

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

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

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

Ответ

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

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

Статус bulkUnregisterDevice

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

GET https://api.wavesend.ru/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"
    }
  ]
}