Í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.

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 então 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 agendada.
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.

API de Predefinições

createPreset	Cria uma nova predefinição.
getPreset	Recupera os parâmetros da predefinição de push especificada.
listPresets	Recupera uma lista de predefinições criadas para o aplicativo.
deletePreset	Exclui uma predefinição da sua conta.

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 User ID externo a um dispositivo especificado.
deleteUser	Exclui um usuário e todos os dispositivos associados ao User ID 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 User ID externo a um endereço de e-mail especificado.

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.
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 nos e-mails.
bouncedEmails	Fornece informações sobre bounces de e-mail, reclamações e motivos de bounce.

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 de campanhas

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.

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 do Apple Wallet PassKit

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

API da Carteira Google

Create a pass	Cria o passe na Carteira Google e retorna um link para salvar.
Validate a pass	Verifica a configuração de um passe sem criá-lo.
Update a pass	Atualiza um passe existente. O Google entrega a alteração aos dispositivos salvos.
Get a save link	Retorna um link “Adicionar à Carteira Google” para um passe existente.
Get a pass	Retorna um único passe armazenado.
List passes	Retorna uma lista paginada de passes para um aplicativo.
Set pass state	Ativa ou invalida um passe.
Delete a pass	Invalida o passe no Google e remove seu registro na Pushwoosh.
Get configuration	Retorna o estado da configuração da Carteira Google para um aplicativo.
Templates	Lista modelos de passe ou busca um como ponto de partida.

API da Customer Journey

Lifecycle	Inicia, pausa, finaliza, rascunha ou arquiva uma journey pelo seu UUID.
Create and update	Cria uma nova definição de journey ou substitui uma existente.
Start by API	Injeta usuários no ponto de entrada da API de uma journey em execução.
Get Journey stats	Obtém estatísticas para uma journey específica pelo seu ID.
Remove users from journeys	Remove um ou mais usuários de todas ou de journeys 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 Geozones

getNearestZone	Recupera os parâmetros da geozone 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 Geozone a um aplicativo específico.
updateGeoZone	Atualiza as propriedades da Geozone, como nome, status, conteúdo e alcance.
deleteGeoZone	Remove Geozones do aplicativo.
addGeoZoneCluster	Adiciona um Cluster de Geozone ao aplicativo.
deleteGeoZoneCluster	Remove um Cluster de Geozone do aplicativo.
listGeoZones	Recupera uma lista de Geozones para o aplicativo.
listGeoZoneClusters	Recupera uma lista de clusters de Geozone para o aplicativo.