Audience API

bulkSetTags

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

Define valores de tag para a lista de dispositivos.

Corpo da Solicitação

Nome	Tipo	Descrição
application*	String	Código da aplicação Pushwoosh
auth*	String	Token de acesso à API do Painel de Controle Pushwoosh.
create_missing_tags	Boolean	Se verdadeiro, tags ausentes são criadas automaticamente.
devices*	Object	Array de dispositivos.
devices.hwid	String	Pode ser usado para identificar um dispositivo em vez de user_id ou push_token. Saiba mais
devices.user_id	String	Pode ser usado para identificar um usuário em vez de hwid ou push_token. Saiba mais
devices.push_token	String	Pode ser usado para identificar um dispositivo em vez de hwid ou user_id. Saiba mais
devices.list_operator	String	Define como definir valores para tags do tipo lista: set (definir), append (anexar) ou remove (remover)
devices.tags*	Object	Valores a serem definidos para as tags especificadas.

OK
Erro

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

{
  "message": "invalid request"
}

{
  "application": "application code",   // obrigatório. Código da aplicação Pushwoosh
  "auth": "Pushwoosh auth token",      // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
  "create_missing_tags": false,        // opcional. Deve criar automaticamente tags ausentes
  "devices": [{                        // obrigatório. Array de dispositivos
    "hwid": "device hwid",             // opcional. Pode ser usado para identificar um dispositivo em vez de
                                       //           "user_id" ou "push_token".
    "user_id": "user ID",              // opcional. Pode ser usado para identificar um usuário em vez de "hwid" ou "push_token".
    "push_token": "device push token", // opcional. Pode ser usado para identificar um dispositivo em vez de "hwid" ou "user_id".
    "list_operator": "set",            // obrigatório. Para tags de lista. Define como definir valores para
                                       //           tags do tipo lista: set, append ou remove
    "tags": {                          // obrigatório. Valores a serem definidos para as tags especificadas.
      "tag_name": "tagvalue",          //           use o tipo de valor correto
      "tag_name2": "tagvalue2"
    }
  }]
}

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

bulkSetTags status

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

Retorna o status da operação /bulkSetTags

Parâmetros de Caminho

Nome	Tipo	Descrição
request_id	String	id da solicitação da chamada `/bulkSetTags` anterior

Parâmetros de Consulta

Nome	Tipo	Descrição
detailed	Boolean	(true/false) se deve retornar informações detalhadas por dispositivo

{
  "request_id": "id of the request",
  "status": "Completed",          // também "Pending", "Failed"
  "progress": 100,                // progresso dos trabalhos 0-100
  "devices_success": 100,         // dispositivos bem-sucedidos
  "devices_not_found": 0,         // dispositivos não encontrados no Pushwoosh
  "devices_failed": 0,            // com erro
  "devices": [{                   // relatório do dispositivo (apenas em detailed = true)
    "hwid": "device hwid",
    "status": "done",             // também "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "tag not found",
      "tagName3": "wrong value. expect :string"
    }
  }]
}

bulkRegisterDevice

Registra múltiplos dispositivos no Pushwoosh em uma única solicitação. Também permite especificar várias tags para cada dispositivo.

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

Parâmetros do corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
application	string	Sim	Código da aplicação Pushwoosh
auth	string	Sim	Token de acesso à API.
devices	array	Sim	Um array de objetos de dispositivo. Cada objeto representa um dispositivo e seus dados associados. Veja detalhes na tabela Parâmetros do objeto Device abaixo.

Parâmetros do objeto Device

Parâmetro	Tipo	Obrigatório	Descrição
hwid	string	Sim	O ID de hardware ou identificador único para o dispositivo.
push_token	string	Sim	Push token para o dispositivo.
platform	integer	Sim	O identificador da plataforma. Saiba mais
list_operator	string	Não	Determina a ação para tags do tipo lista: - “append”: Adiciona o valor especificado à lista de tags. - “remove”: Remove o valor especificado da lista de tags. Nota: Se o parâmetro `list_operator` não for especificado, todos os valores existentes na lista de tags serão substituídos pelos valores fornecidos.
tags	object	Não	Tags personalizadas atribuídas ao dispositivo. Tags são pares chave-valor usados para segmentação.

Exemplo de solicitação

{
  "application": "application code",   // obrigatório. Código da aplicação Pushwoosh
  "auth": "Pushwoosh auth token",      // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
  "devices": [{                        // obrigatório. Array de dispositivos
    "hwid": "device hwid",             // obrigatório. Identificador único para o dispositivo (pode ser um e-mail).
    "push_token": "device push token", // obrigatório. Token de notificação push para o dispositivo.
    "platform": 14,                    // obrigatório. Plataforma do dispositivo (ex: 14 para e-mail).
    "list_operator": "append",         // opcional. Para tags de lista. Adiciona ou remove o(s) valor(es) especificado(s) da tag do tipo lista.
    "tags": {                          // opcional. Valores a serem definidos para as tags especificadas.
      "language": "en",                //           use o tipo de valor correto.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // obrigatório. Identificador único para o segundo dispositivo.
    "push_token": "device push token 2", // obrigatório. Token de notificação push para o dispositivo.
    "platform": 14,                    // obrigatório. Plataforma do dispositivo.
    "list_operator": "remove",         // opcional. Adiciona ou remove valores de tags do tipo lista.
    "tags": {                          // opcional. Valores a serem removidos das tags especificadas.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // obrigatório. Identificador único para o terceiro dispositivo.
    "push_token": "device push token 3", // obrigatório. Token de notificação push para o dispositivo.
    "platform": 14,                    // obrigatório. Plataforma do dispositivo.
    "tags": {                          // opcional. Valores a serem definidos para as tags especificadas.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Resposta

O método responde com um ID de operação, que pode ser usado para rastrear o status e os resultados do processo de registro em massa.

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

bulkRegisterDevice status

Você pode verificar o status de um processo de registro em massa fazendo a seguinte solicitação GET:

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

Parâmetro	Tipo	Obrigatório	Descrição
request_id	string	Sim	O ID da solicitação retornado pela solicitação POST.
detailed	boolean	Não	Se definido como `true`, a resposta inclui resultados detalhados para cada dispositivo registrado.

Exemplo de resposta

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

Remove o registro de múltiplos dispositivos do Pushwoosh em uma única solicitação.

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

Parâmetros do corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
application	string	Sim	Código da aplicação Pushwoosh
auth	string	Sim	Token de acesso à API
devices	array	Sim	Um array de objetos de dispositivo. Cada objeto representa um dispositivo e seus dados associados. Veja detalhes na tabela Parâmetros do objeto Device abaixo.

Parâmetros do objeto Device

Parâmetro	Tipo	Obrigatório	Descrição
hwid	string	Sim	O ID de hardware ou identificador único para o dispositivo. Saiba mais

Exemplo de solicitação

{
  "application": "application code",   // obrigatório. Código da aplicação Pushwoosh
  "auth": "Pushwoosh auth token",      // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
  "devices": [{                        // obrigatório. Array de dispositivos
    "hwid": "device hwid",             // obrigatório. Identificador único para o dispositivo (pode ser um e-mail).
  },
  {
    "hwid": "device hwid 2",           // obrigatório. Identificador único para o segundo dispositivo.
  },
  {
    "hwid": "device hwid 3",           // obrigatório. Identificador único para o terceiro dispositivo.
  }]
}

Resposta

O método responde com um ID de operação, que pode ser usado para rastrear o status e os resultados do processo em massa.

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

bulkUnregisterDevice status

Você pode verificar o status de um processo de cancelamento de registro em massa fazendo a seguinte solicitação GET:

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

Parâmetro	Tipo	Obrigatório	Descrição
request_id	string	Sim	O ID da solicitação retornado pela solicitação POST.
detailed	boolean	Não	Se definido como `true`, a resposta inclui resultados detalhados para cada dispositivo com registro cancelado.

Exemplo de resposta

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