Audience API

bulkSetTags

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

Establece valores de etiquetas para la lista de dispositivos.

Request Body

Nombre	Tipo	Descripción
application*	String	Código de aplicación de Pushwoosh
auth*	String	Token de acceso a la API desde el Panel de Control de Pushwoosh.
create_missing_tags	Boolean	Si es true, las etiquetas faltantes se crean automáticamente.
devices*	Object	Array de dispositivos.
devices.hwid	String	Se puede usar para identificar un dispositivo en lugar de user_id o push_token. Más información
devices.user_id	String	Se puede usar para identificar un usuario en lugar de hwid o push_token. Más información
devices.push_token	String	Se puede usar para identificar un dispositivo en lugar de hwid o user_id. Más información
devices.list_operator	String	Define cómo establecer valores para etiquetas de tipo lista: set, append o remove
devices.tags*	Object	Valores para establecer para las etiquetas especificadas.

OK
Error

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

{
  "message": "invalid request"
}

{
  "application": "application code",   // requerido. Código de aplicación de Pushwoosh
  "auth": "Pushwoosh auth token",      // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh
  "create_missing_tags": false,        // opcional. Debería crear automáticamente las etiquetas faltantes
  "devices": [{                        // requerido. Array de dispositivos
    "hwid": "device hwid",             // opcional. Se puede usar para identificar un dispositivo en lugar de
                                       //           "user_id" o "push_token".
    "user_id": "user ID",              // opcional. Se puede usar para identificar un usuario en lugar de "hwid" o "push_token".
    "push_token": "device push token", // opcional. Se puede usar para identificar un dispositivo en lugar de "hwid" o "user_id".
    "list_operator": "set",            // requerido. Para etiquetas de lista. Define cómo establecer valores para
                                       //           etiquetas de tipo lista: set, append o remove
    "tags": {                          // requerido. Valores para establecer para las etiquetas especificadas.
      "tag_name": "tagvalue",          //           use el tipo de valor correcto
      "tag_name2": "tagvalue2"
    }
  }]
}

{
  "request_id": "request_id para usar en el método GET para obtener el estado del trabajo",
  "status": "Pending"
}

Estado de bulkSetTags

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

Devuelve el estado de la operación /bulkSetTags

Path Parameters

Nombre	Tipo	Descripción
request_id	String	id de solicitud de la llamada anterior a `/bulkSetTags`

Query Parameters

Nombre	Tipo	Descripción
detailed	Boolean	(true/false) si se debe devolver información detallada por dispositivo

{
  "request_id": "id of the request",
  "status": "Completed",          // también "Pending", "Failed"
  "progress": 100,                // progreso del trabajo 0-100
  "devices_success": 100,         // dispositivos correctos
  "devices_not_found": 0,         // dispositivos no encontrados en Pushwoosh
  "devices_failed": 0,            // con errores
  "devices": [{                   // informe del dispositivo (solo en detailed = true)
    "hwid": "device hwid",
    "status": "done",             // también "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "tag not found",
      "tagName3": "wrong value. expect :string"
    }
  }]
}

bulkRegisterDevice

Registra múltiples dispositivos en Pushwoosh en una sola solicitud. También permite especificar varias etiquetas para cada dispositivo.

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

Parámetros del cuerpo de la solicitud

Parámetro	Tipo	Requerido	Descripción
application	string	Sí	Código de aplicación de Pushwoosh
auth	string	Sí	Token de acceso a la API.
devices	array	Sí	Un array de objetos de dispositivo. Cada objeto representa un dispositivo y sus datos asociados. Ver detalles en la tabla Parámetros del objeto de dispositivo a continuación.

Parámetros del objeto de dispositivo

Parámetro	Tipo	Requerido	Descripción
hwid	string	Sí	El hardware ID o identificador único para el dispositivo.
push_token	string	Sí	Push token para el dispositivo.
platform	integer	Sí	El identificador de la plataforma. Más información
list_operator	string	No	Determina la acción para etiquetas de tipo lista: - “append”: Añade el valor especificado a la lista de etiquetas. - “remove”: Elimina el valor especificado de la lista de etiquetas. Nota: Si no se especifica el parámetro `list_operator`, todos los valores existentes en la lista de etiquetas serán reemplazados por los valores proporcionados.
tags	object	No	Etiquetas personalizadas asignadas al dispositivo. Las etiquetas son pares clave-valor utilizados para la segmentación.

Ejemplo de solicitud

{
  "application": "application code",   // requerido. Código de aplicación de Pushwoosh
  "auth": "Pushwoosh auth token",      // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh
  "devices": [{                        // requerido. Array de dispositivos
    "hwid": "device hwid",             // requerido. Identificador único para el dispositivo (puede ser un email).
    "push_token": "device push token", // requerido. Token de notificación push para el dispositivo.
    "platform": 14,                    // requerido. Plataforma del dispositivo (ej. 14 para email).
    "list_operator": "append",         // opcional. Para etiquetas de lista. Añade o elimina el/los valor(es) especificado(s) de la etiqueta de tipo lista.
    "tags": {                          // opcional. Valores para establecer para las etiquetas especificadas.
      "language": "en",                //           use el tipo de valor correcto.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // requerido. Identificador único para el segundo dispositivo.
    "push_token": "device push token 2", // requerido. Token de notificación push para el dispositivo.
    "platform": 14,                    // requerido. Plataforma del dispositivo.
    "list_operator": "remove",         // opcional. Añade o elimina valores de etiquetas de tipo lista.
    "tags": {                          // opcional. Valores para eliminar de las etiquetas especificadas.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // requerido. Identificador único para el tercer dispositivo.
    "push_token": "device push token 3", // requerido. Token de notificación push para el dispositivo.
    "platform": 14,                    // requerido. Plataforma del dispositivo.
    "tags": {                          // opcional. Valores para establecer para las etiquetas especificadas.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Respuesta

El método responde con un ID de operación, que se puede utilizar para rastrear el estado y los resultados del proceso de registro masivo.

{
  "request_id": "request_id para usar en el método GET para obtener el estado del trabajo",
  "status": "Pending"
}

Estado de bulkRegisterDevice

Puede verificar el estado de un proceso de registro masivo realizando la siguiente solicitud GET:

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

Parámetro	Tipo	Requerido	Descripción
request_id	string	Sí	El ID de solicitud devuelto por la solicitud POST.
detailed	boolean	No	Si se establece en `true`, la respuesta incluye resultados detallados para cada dispositivo registrado.

Ejemplo de respuesta

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

Desregistra múltiples dispositivos de Pushwoosh en una sola solicitud.

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

Parámetros del cuerpo de la solicitud

Parámetro	Tipo	Requerido	Descripción
application	string	Sí	Código de aplicación de Pushwoosh
auth	string	Sí	Token de acceso a la API
devices	array	Sí	Un array de objetos de dispositivo. Cada objeto representa un dispositivo y sus datos asociados. Ver detalles en la tabla Parámetros del objeto de dispositivo a continuación.

Parámetros del objeto de dispositivo

Parámetro	Tipo	Requerido	Descripción
hwid	string	Sí	El hardware ID o identificador único para el dispositivo. Más información

Ejemplo de solicitud

{
  "application": "application code",   // requerido. Código de aplicación de Pushwoosh
  "auth": "Pushwoosh auth token",      // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh
  "devices": [{                        // requerido. Array de dispositivos
    "hwid": "device hwid",             // requerido. Identificador único para el dispositivo (puede ser un email).
  },
  {
    "hwid": "device hwid 2",           // requerido. Identificador único para el segundo dispositivo.
  },
  {
    "hwid": "device hwid 3",           // requerido. Identificador único para el tercer dispositivo.
  }]
}

Respuesta

El método responde con un ID de operación, que se puede utilizar para rastrear el estado y los resultados del proceso masivo.

{
  "request_id": "request_id para usar en el método GET para obtener el estado del trabajo",
  "status": "Pending"
}

Estado de bulkUnregisterDevice

Puede verificar el estado de un proceso de desregistro masivo realizando la siguiente solicitud GET:

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

Parámetro	Tipo	Requerido	Descripción
request_id	string	Sí	El ID de solicitud devuelto por la solicitud POST.
detailed	boolean	No	Si se establece en `true`, la respuesta incluye resultados detallados para cada dispositivo desregistrado.

Ejemplo de respuesta

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