Pular para o conteúdo

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

A Pushwoosh oferece uma vasta biblioteca de 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

Anchor link to
createMessageCria uma nova notificação push.
deleteMessageExclui uma mensagem agendada.
getMessageDetailsRecupera os detalhes da mensagem.
createTargetedMessageCria uma nova notificação push direcionada para segmentação avançada em vários aplicativos.
getPushHistoryObtém o histórico de mensagens com detalhes de push.
cancelMessageCancela uma mensagem agendada.

API de Presets

Anchor link to
createPresetCria um novo preset.
getPresetRecupera os parâmetros do preset de push especificado.
listPresetsRecupera uma lista de presets criados para o aplicativo.
deletePresetExclui um preset da sua conta.

API de Dispositivo

Anchor link to
registerDeviceRegistra um dispositivo para o aplicativo.
unregisterDeviceRemove o token de push do dispositivo.
setTagsDefine os valores das tags para o dispositivo.
getTagsRecupera as tags com seus valores correspondentes para um dispositivo específico.
setBadgeEnvia o valor atual do badge de um dispositivo para a Pushwoosh.
applicationOpenRegistra um evento de abertura de aplicativo.
pushStatRegistra um evento de abertura de push.
messageDeliveryEventRegistra um evento de entrega de push para o dispositivo.

API de Público

Anchor link to
bulkSetTagsDefine valores de tags para múltiplos dispositivos.
bulkSetTags StatusRetorna o status da operação bulkSetTags.
bulkRegisterDeviceRegistra múltiplos dispositivos em uma única solicitação, incluindo valores de tags opcionais para cada dispositivo.
bulkRegisterDevice StatusRecupera o status e os resultados de uma solicitação de registro de dispositivo em massa usando um ID de solicitação.
bulkUnregisterDeviceCancela o registro de múltiplos dispositivos em uma única solicitação.
bulkUnregisterDevice StatusRecupera 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

Anchor link to
addTagCria uma tag em sua conta.
deleteTagRemove uma tag com todas as informações associadas.
listTagsRecupera uma lista de tags na conta.

API de Segmentação (Filtros)

Anchor link to
createFilterCria um novo segmento.
listFiltersRetorna uma lista de segmentos disponíveis com suas condições.
deleteFilterExclui um segmento existente.
exportSegmentAgenda uma solicitação para exportar assinantes que correspondem às condições do segmento.
exportSegment ResultsRecupera o link CSV para os resultados de exportSegment.

API Centrada no Usuário

Anchor link to
registerUserAssocia um ID de Usuário externo a um dispositivo especificado.
postEventChama o evento dentro do aplicativo.

API de Eventos

Anchor link to
createEventCria um evento para o aplicativo.

API de Aplicativos

Anchor link to
createApplicationCria um novo aplicativo na conta.
updateApplicationAtualiza as configurações do aplicativo.
deleteApplicationExclui o aplicativo da conta.
getApplicationObtém detalhes sobre o aplicativo.
getApplicationsRecupera uma lista de aplicativos na conta.
getApplicationFileRecupera os arquivos de configuração relacionados ao aplicativo.
setApplicationPlatformStatusAltera o status da plataforma do aplicativo.

API de Campanhas

Anchor link to
createCampaignCria uma nova campanha de push.
deleteCampaignExclui uma campanha específica.
getCampaignsRecupera uma lista de campanhas para o aplicativo.

API de Configuração de Aplicativo

Anchor link to
configureApplication for iOSConfigura a plataforma iOS para o aplicativo.
configureApplication for AndroidConfigura a plataforma Android para o aplicativo.
configureApplication for Mac OS XConfigura a plataforma macOS para o aplicativo.
configureApplication for WindowsConfigura a plataforma Windows para o aplicativo.
configureApplication for AmazonConfigura a plataforma Amazon para o aplicativo.
configureApplication for ChromeConfigura a plataforma Chrome para o aplicativo.
configureApplication for SafariConfigura a plataforma Safari para o aplicativo.
configureApplication for FirefoxConfigura a plataforma Firefox para o aplicativo.
configureApplication for EmailConfigura a plataforma de E-mail para o aplicativo.

API de E-mail

Anchor link to
createEmailMessageCria uma mensagem de e-mail.
registerEmailRegistra um endereço de e-mail para o aplicativo.
deleteEmailRemove um endereço de e-mail do seu banco de dados.
setEmailTagsDefine os valores das tags para o endereço de e-mail especificado.
registerEmailUserAssocia um ID de Usuário externo a um endereço de e-mail especificado.

API de Dispositivos de Teste

Anchor link to
createTestDeviceRegistra um dispositivo de teste para o aplicativo.
listTestDevicesRecupera todos os dispositivos de teste registrados para o aplicativo.

API de Caixa de Entrada de Mensagens

Anchor link to
getInboxMessagesRecupera a lista de mensagens da Caixa de Entrada para um HWID especificado.
inboxStatusAtualiza o status de uma mensagem específica da Caixa de Entrada.

API de Estatísticas

Anchor link to

Estatísticas de mensagens

Anchor link to
messages:listRecupera uma lista de mensagens enviadas.
totalsByIntervalsFornece métricas e dados de conversão agregados por hora.
getMessageLogRecupera informações detalhadas sobre as mensagens enviadas.
linksInteractionsFornece estatísticas sobre cliques em links de e-mail.
linksInteractionsDevicesLista os usuários que clicaram em links nos e-mails.
bouncedEmailsFornece informações sobre bounces de e-mail, reclamações e motivos de bounce.

Estatísticas de aplicativos e assinantes

Anchor link to
getApplicationSubscribersStatsRecupera as estatísticas de assinantes do aplicativo, agrupadas por tipo de dispositivo.
getAppStatsRecupera as estatísticas do aplicativo para um período de tempo específico.
getSubscribersStatisticsRecupera as estatísticas de assinantes para um período de tempo específico.

Estatísticas de campanhas

Anchor link to
getCampaignStatsRecupera as estatísticas da campanha para um período de tempo específico.

Estatísticas de eventos e tags

Anchor link to
getEventStatisticsRecupera o número de vezes que um evento foi acionado durante um período específico.
getTagStatsRecupera estatísticas para uma tag específica.

API de Atividades ao Vivo do iOS

Anchor link to
startLiveActivityCria uma nova Atividade ao Vivo do iOS.
updateLiveActivityAtualiza uma Atividade ao Vivo do iOS existente.

API de Customer Journey

Anchor link to
Get Journey statsObtém estatísticas para uma jornada específica pelo seu ID.
Remove users from journeysRemove um ou mais usuários de todas ou de jornadas ativas selecionadas.

API de Solicitações Agendadas

Anchor link to
getResultsRecupera o resultado de uma solicitação agendada.

API de SMS

Anchor link to
createSMSMessageCria uma nova mensagem de SMS.

API do WhatsApp

Anchor link to
createWhatsAppMessageCria uma nova mensagem do WhatsApp.

API do LINE

Anchor link to
createLineMessageCria uma nova mensagem do LINE.

API de Geozones

Anchor link to
getNearestZoneRecupera 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.
addGeoZoneAdiciona uma Geozone a um aplicativo específico.
updateGeoZoneAtualiza as propriedades da Geozone, como nome, status, conteúdo e alcance.
deleteGeoZoneRemove Geozones do aplicativo.
addGeoZoneClusterAdiciona um Cluster de Geozone ao aplicativo.
deleteGeoZoneClusterRemove um Cluster de Geozone do aplicativo.
listGeoZonesRecupera uma lista de Geozones para o aplicativo.
listGeoZoneClustersRecupera uma lista de clusters de Geozone para o aplicativo.