Índice de referência de métodos da API

A Pushwoosh oferece uma vasta biblioteca com mais de 100 métodos de API, categorizados para diversas funcionalidades, como envio de notificações, gerenciamento de usuários e acompanhamento de análises.

API de Mensagens v2

API unificada que substitui toda a família /create*Message (push, e-mail, SMS, Kakao). Consulte a visão geral e o guia de migração.

Notify	Cria e envia uma única mensagem por qualquer canal. Substitui /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage.
Cancel	Cancela uma mensagem criada anteriormente antes de ser entregue. Use com o message_code de Notify.
Update	Substitui uma mensagem ainda agendada por uma nova definição (substituição completa). Use com o message_code de Notify.

Gateway SMTP

Envie e-mails transacionais por SMTP padrão em vez de chamar a API diretamente. O gateway se autentica com o código do seu aplicativo e o token da API e, em seguida, encaminha cada mensagem para Notify. Consulte a referência do gateway SMTP.

API de Mensagens

createMessage Obsoleto	Cria uma nova notificação push. Use Notify em vez disso.
deleteMessage	Exclui uma mensagem (enviada ou agendada) e a remove do Histórico de Mensagens.
getMessageDetails	Recupera os detalhes da mensagem.
createTargetedMessage Obsoleto	Cria uma nova notificação push direcionada. Use Notify com o tipo transactional em vez disso.
getPushHistory Obsoleto	Use /messages:list para recuperar o histórico de mensagens com dados detalhados.
cancelMessage	Cancela uma mensagem agendada, mantendo-a no Histórico de Mensagens.

API de Predefinições

Create	Cria uma nova predefinição de push.
List	Lista as predefinições de push de um aplicativo.
Get	Recupera uma única predefinição de push por código.
Update	Sobrescreve uma predefinição de push por código.
UpdatePartial	Atualiza apenas os campos fornecidos de uma predefinição de push por código.
Clone	Duplica uma predefinição de push dentro do mesmo aplicativo.
Delete	Exclui uma predefinição de push por código.

API de Dispositivo

registerDevice	Registra um dispositivo para o aplicativo.
unregisterDevice	Remove o token de push do dispositivo.
deleteDevice	Exclui um dispositivo e todos os seus dados associados no aplicativo especificado.
setTags	Define os valores das tags para o dispositivo.
getTags	Recupera as tags com seus valores correspondentes para um dispositivo específico.
setBadge	Envia o valor atual do emblema de um dispositivo para a Pushwoosh.
applicationOpen	Registra um evento de abertura de aplicativo.
pushStat	Registra um evento de abertura de push.
messageDeliveryEvent	Registra um evento de entrega de push para o dispositivo.

API de Público

bulkSetTags	Define os valores das tags para vários dispositivos.
bulkSetTags Status	Retorna o status da operação bulkSetTags.
bulkRegisterDevice	Registra vários dispositivos em uma única solicitação, incluindo valores de tags opcionais para cada dispositivo.
bulkRegisterDevice Status	Recupera o status e os resultados de uma solicitação de registro de dispositivo em massa usando um ID de solicitação.
bulkUnregisterDevice	Cancela o registro de vários dispositivos em uma única solicitação.
bulkUnregisterDevice Status	Recupera o status e os resultados de uma solicitação de cancelamento de registro de dispositivo em massa usando um ID de solicitação.

API de Tags

addTag	Cria uma tag em sua conta.
deleteTag	Remove uma tag com todas as informações associadas.
listTags	Recupera uma lista de tags na conta.

API de Segmentação (Filtros)

createFilter	Cria um novo segmento.
listFilters	Retorna uma lista de segmentos disponíveis com suas condições.
deleteFilter	Exclui um segmento existente.
exportSegment	Agenda uma solicitação para exportar assinantes que correspondem às condições do segmento.
exportSegment Results	Recupera o link CSV para os resultados de exportSegment.

API centrada no usuário

registerUser	Associa um ID de usuário externo a um dispositivo especificado.
deleteUser	Exclui um usuário e todos os dispositivos associados ao ID de usuário especificado.
postEvent	Chama o evento dentro do aplicativo.

API de Eventos

createEvent	Cria um evento para o aplicativo.

API de Aplicativos

createApplication	Cria um novo aplicativo na conta.
updateApplication	Atualiza as configurações do aplicativo.
deleteApplication	Exclui o aplicativo da conta.
getApplication	Obtém detalhes sobre o aplicativo.
getApplications	Recupera uma lista de aplicativos na conta.
getApplicationFile	Recupera os arquivos de configuração relacionados ao aplicativo.
setApplicationPlatformStatus	Altera o status da plataforma do aplicativo.

API de Campanhas

createCampaign	Cria uma nova campanha de push.
deleteCampaign	Exclui uma campanha específica.
getCampaigns	Recupera uma lista de campanhas para o aplicativo.

API de configuração de aplicativo

configureApplication for iOS	Configura a plataforma iOS para o aplicativo.
configureApplication for Android	Configura a plataforma Android para o aplicativo.
configureApplication for Mac OS X	Configura a plataforma macOS para o aplicativo.
configureApplication for Windows	Configura a plataforma Windows para o aplicativo.
configureApplication for Amazon	Configura a plataforma Amazon para o aplicativo.
configureApplication for Chrome	Configura a plataforma Chrome para o aplicativo.
configureApplication for Safari	Configura a plataforma Safari para o aplicativo.
configureApplication for Firefox	Configura a plataforma Firefox para o aplicativo.
configureApplication for Email	Configura a plataforma de E-mail para o aplicativo.

API de E-mail

createEmailMessage Obsoleto	Cria uma mensagem de e-mail. Use Notify com platforms: ["EMAIL"] e um email_payload em vez disso.
registerEmail	Registra um endereço de e-mail para o aplicativo.
deleteEmail	Remove um endereço de e-mail do seu banco de dados.
setEmailTags	Define os valores das tags para o endereço de e-mail especificado.
registerEmailUser	Associa um ID de usuário externo a um endereço de e-mail especificado.

API de Modelos de E-mail

Create	Cria um novo modelo de e-mail em um aplicativo.
List	Lista os modelos de e-mail de um aplicativo.
Get	Retorna um único modelo de e-mail por código.
Update	Atualiza um modelo de e-mail existente por código.
Delete	Exclui um modelo de e-mail e sua predefinição conectada por código.
Clone	Clona um modelo de e-mail em um aplicativo de destino.

API de dispositivos de teste

createTestDevice	Registra um dispositivo de teste para o aplicativo.
listTestDevices	Recupera todos os dispositivos de teste registrados para o aplicativo.

API da caixa de entrada de mensagens

getInboxMessages	Recupera a lista de mensagens da Caixa de Entrada para um HWID especificado.
inboxStatus	Atualiza o status de uma mensagem específica da Caixa de Entrada.

API de Estatísticas

Estatísticas de mensagens

messages:list	Recupera uma lista de mensagens enviadas.
totalsByIntervals	Fornece métricas e dados de conversão agregados por hora.
getDeliveryFunnel	Retorna o funil de entrega para uma única mensagem, com um detalhamento de onde o público é perdido em cada etapa.
getMessageLog	Recupera informações detalhadas sobre as mensagens enviadas.
linksInteractions	Fornece estatísticas sobre cliques em links de e-mail.
linksInteractionsDevices	Lista os usuários que clicaram em links em e-mails.
bouncedEmails	Fornece informações sobre devoluções de e-mail, reclamações e motivos de devolução.

Exportação assíncrona de estatísticas de mensagens

exportMessagesStatistics/export	Coloca na fila uma exportação do histórico de mensagens para um arquivo CSV, sem os limites de linha de messages:list.
exportMessagesStatistics/status	Retorna o progresso de uma tarefa de exportação.
exportMessagesStatistics/result	Retorna o nome do arquivo gerado assim que a tarefa for concluída.
exportMessagesStatistics/lastTasks	Lista as tarefas de exportação recentes para um aplicativo.
exportMessagesStatistics/delete	Exclui uma tarefa e seu arquivo antes que a janela de retenção expire.
exportMessagesStatistics/download	Baixa o arquivo CSV gerado por nome.

Estatísticas de aplicativos e assinantes

getApplicationSubscribersStats	Recupera as estatísticas de assinantes do aplicativo, agrupadas por tipo de dispositivo.
getAppStats	Recupera as estatísticas do aplicativo para um período de tempo específico.
getSubscribersStatistics	Recupera as estatísticas de assinantes para um período de tempo específico.

Estatísticas da campanha

getCampaignStats	Recupera as estatísticas da campanha para um período de tempo específico.

Estatísticas de eventos e tags

getEventStatistics	Recupera o número de vezes que um evento foi acionado durante um período específico.
getTagStats	Recupera estatísticas para uma tag específica.

Estatísticas in-app

inapps:totals	Recupera os totais de impressão, interação e limite de frequência para uma ou mais campanhas in-app durante um período.
inapps:timeline	Recupera os totais do período e uma série temporal de métricas in-app para uma única campanha.

API de Atividades ao Vivo do iOS

startLiveActivity	Cria uma nova Atividade ao Vivo do iOS.
updateLiveActivity	Atualiza uma Atividade ao Vivo do iOS existente.

API Apple Wallet PassKit

API Apple Wallet PassKit	Referência para gerenciar passes da Carteira da Apple e configurações relacionadas na Pushwoosh.

API da Carteira do Google

Criar um passe	Cria o passe na Carteira do Google e retorna um link para salvar.
Validar um passe	Verifica a configuração de um passe sem criá-lo.
Atualizar um passe	Atualiza um passe existente. O Google entrega a alteração aos dispositivos salvos.
Obter um link para salvar	Retorna um link para salvar “Adicionar à Carteira do Google” para um passe existente.
Obter um passe	Retorna um único passe armazenado.
Listar passes	Retorna uma lista paginada de passes para um aplicativo.
Definir estado do passe	Ativa ou invalida um passe.
Excluir um passe	Invalida o passe no Google e remove seu registro da Pushwoosh.
Obter configuração	Retorna o estado da configuração da Carteira do Google para um aplicativo.
Modelos	Lista modelos de passe ou busca um como ponto de partida.

API da Jornada do Cliente

Ciclo de vida	Inicia, pausa, finaliza, rascunha ou arquiva uma jornada pelo seu UUID.
Criar e atualizar	Cria uma nova definição de jornada ou substitui uma existente.
Iniciar por API	Injeta usuários no ponto de entrada da API de uma jornada em execução.
Obter estatísticas da Jornada	Obtém estatísticas para uma jornada específica pelo seu ID.
Remover usuários de jornadas	Remove um ou mais usuários de todas ou de jornadas ativas selecionadas.

API de solicitações agendadas

getResults	Recupera o resultado de uma solicitação agendada.

API de SMS

createSMSMessage Obsoleto	Cria uma nova mensagem SMS. Use Notify com platforms: ["SMS"] em vez disso.

API do WhatsApp

createWhatsAppMessage Obsoleto	Cria uma nova mensagem do WhatsApp. Use Notify com platforms: ["WHATS_APP"] em vez disso.

API do LINE

createLineMessage Obsoleto	Cria uma nova mensagem do LINE. Use Notify com platforms: ["LINE"] em vez disso.

API do Kakao

createKakaoMessage Obsoleto	Envia uma mensagem do Kakao usando um modelo aprovado. Use Notify com platforms: ["KAKAO"] em vez disso.

API de Geozonas

getNearestZone	Recupera os parâmetros da geozona mais próxima e a distância até ela. Também registra a localização do dispositivo para notificações push geográficas.
addGeoZone	Adiciona uma Geozona a um aplicativo específico.
updateGeoZone	Atualiza as propriedades da Geozona, como nome, status, conteúdo e alcance.
deleteGeoZone	Remove Geozonas do aplicativo.
addGeoZoneCluster	Adiciona um Cluster de Geozonas ao aplicativo.
deleteGeoZoneCluster	Remove um Cluster de Geozonas do aplicativo.
listGeoZones	Recupera uma lista de Geozonas para o aplicativo.
listGeoZoneClusters	Recupera uma lista de clusters de Geozonas para o aplicativo.