Í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 tocreateMessage | Cria uma nova notificação push. |
deleteMessage | Exclui uma mensagem agendada. |
getMessageDetails | Recupera os detalhes da mensagem. |
createTargetedMessage | Cria uma nova notificação push direcionada para segmentação avançada em vários aplicativos. |
getPushHistory | Obtém o histórico de mensagens com detalhes de push. |
cancelMessage | Cancela uma mensagem agendada. |
API de Predefinições
Anchor link tocreatePreset | 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
Anchor link toregisterDevice | Registra um dispositivo para o aplicativo. |
unregisterDevice | Remove o token de push do dispositivo. |
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
Anchor link tobulkSetTags | Define valores de 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
Anchor link toaddTag | Cria uma tag na 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)
Anchor link tocreateFilter | 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
Anchor link toregisterUser | Associa um ID de usuário externo a um dispositivo especificado. |
postEvent | Chama o evento dentro do aplicativo. |
API de Eventos
Anchor link tocreateEvent | Cria um evento para o aplicativo. |
API de Aplicativos
Anchor link tocreateApplication | 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
Anchor link tocreateCampaign | 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
Anchor link toconfigureApplication 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
Anchor link tocreateEmailMessage | Cria uma mensagem de e-mail. |
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 dispositivos de teste
Anchor link tocreateTestDevice | 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
Anchor link togetInboxMessages | 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
Anchor link toEstatísticas de mensagens
Anchor link tomessages: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
Anchor link togetApplicationSubscribersStats | 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 campanha
Anchor link togetCampaignStats | Recupera as estatísticas da campanha para um período de tempo específico. |
Estatísticas de eventos e tags
Anchor link togetEventStatistics | 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
Anchor link tostartLiveActivity | Cria uma nova Atividade ao Vivo do iOS. |
updateLiveActivity | Atualiza uma Atividade ao Vivo do iOS existente. |
API da Jornada do Cliente
Anchor link toGet Journey stats | Obtém estatísticas para uma jornada específica pelo seu ID. |
Remove users from journeys | Remove um ou mais usuários de todas ou de jornadas ativas selecionadas. |
API de solicitações agendadas
Anchor link togetResults | Recupera o resultado de uma solicitação agendada. |
API de SMS
Anchor link tocreateSMSMessage | Cria uma nova mensagem SMS. |
API do WhatsApp
Anchor link tocreateWhatsAppMessage | Cria uma nova mensagem do WhatsApp. |
API do LINE
Anchor link tocreateLineMessage | Cria uma nova mensagem do LINE. |
API do Kakao
Anchor link tocreateKakaoMessage | Envia uma mensagem do Kakao usando um modelo aprovado. |
API de Geozonas
Anchor link togetNearestZone | 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. |