Índice de referencia de métodos de la API

Pushwoosh proporciona una amplia biblioteca de más de 100 métodos de API, categorizados para diversas funcionalidades como el envío de notificaciones, la gestión de usuarios y el seguimiento de análisis.

API de mensajería v2

API unificada que reemplaza toda la familia /create*Message (push, email, SMS, Kakao). Consulte la descripción general y la guía de migración.


`Notify`	Crea y envía un único mensaje a través de cualquier canal. Reemplaza a `/createMessage`, `/createTargetedMessage`, `/createEmailMessage`, `/createSMSMessage`, `/createKakaoMessage`.
`Cancel`	Cancela un mensaje creado previamente antes de que se entregue. Úselo con `message_code` de `Notify`.

Pasarela SMTP

Envíe correos electrónicos transaccionales a través de SMTP estándar en lugar de llamar directamente a la API. La pasarela se autentica con su código de aplicación y token de API, y luego reenvía cada mensaje a Notify. Consulte la referencia de la pasarela SMTP.

API de mensajes


`createMessage` Obsoleto	Crea una nueva notificación push. Use `Notify` en su lugar.
`deleteMessage`	Elimina un mensaje programado.
`getMessageDetails`	Recupera los detalles del mensaje.
`createTargetedMessage` Obsoleto	Crea una nueva notificación push dirigida. Use `Notify` con el tipo `transactional` en su lugar.
`getPushHistory` Obsoleto	Use `/messages:list` para recuperar el historial de mensajes con datos detallados.
`cancelMessage`	Cancela un mensaje programado.

API de preajustes


`createPreset`	Crea un nuevo preajuste.
`getPreset`	Recupera los parámetros del preajuste de push especificado.
`listPresets`	Recupera una lista de preajustes creados para la aplicación.
`deletePreset`	Elimina un preajuste de su cuenta.

API de dispositivos


`registerDevice`	Registra un dispositivo para la aplicación.
`unregisterDevice`	Elimina el token de push del dispositivo.
`deleteDevice`	Elimina un dispositivo y todos sus datos asociados en la aplicación especificada.
`setTags`	Establece los valores de las etiquetas para el dispositivo.
`getTags`	Recupera las etiquetas con sus valores correspondientes para un dispositivo específico.
`setBadge`	Envía el valor actual del contador (badge) de un dispositivo a Pushwoosh.
`applicationOpen`	Registra un evento de apertura de la aplicación.
`pushStat`	Registra un evento de apertura de push.
`messageDeliveryEvent`	Registra un evento de entrega de push para el dispositivo.

API de audiencia


`bulkSetTags`	Establece los valores de las etiquetas para múltiples dispositivos.
`bulkSetTags Status`	Devuelve el estado de la operación bulkSetTags.
`bulkRegisterDevice`	Registra múltiples dispositivos en una sola solicitud, incluyendo valores de etiquetas opcionales para cada dispositivo.
`bulkRegisterDevice Status`	Recupera el estado y los resultados de una solicitud de registro masivo de dispositivos utilizando un ID de solicitud.
`bulkUnregisterDevice`	Anula el registro de múltiples dispositivos en una sola solicitud.
`bulkUnregisterDevice Status`	Recupera el estado y los resultados de una solicitud de anulación de registro masivo de dispositivos utilizando un ID de solicitud.

API de etiquetas


`addTag`	Crea una etiqueta en su cuenta.
`deleteTag`	Elimina una etiqueta con toda la información asociada.
`listTags`	Recupera una lista de etiquetas en la cuenta.

API de segmentación (filtros)


`createFilter`	Crea un nuevo segmento.
`listFilters`	Devuelve una lista de los segmentos disponibles con sus condiciones.
`deleteFilter`	Elimina un segmento existente.
`exportSegment`	Programa una solicitud para exportar los suscriptores que coinciden con las condiciones del segmento.
`exportSegment Results`	Recupera el enlace CSV para los resultados de exportSegment.

API centrada en el usuario


`registerUser`	Asocia un ID de usuario externo con un dispositivo especificado.
`deleteUser`	Elimina un usuario y todos los dispositivos asociados con el ID de usuario especificado.
`postEvent`	Llama al evento dentro de la aplicación.

API de eventos


`createEvent`	Crea un evento para la aplicación.

API de aplicaciones


`createApplication`	Crea una nueva aplicación en la cuenta.
`updateApplication`	Actualiza la configuración de la aplicación.
`deleteApplication`	Elimina la aplicación de la cuenta.
`getApplication`	Obtiene detalles sobre la aplicación.
`getApplications`	Recupera una lista de aplicaciones en la cuenta.
`getApplicationFile`	Recupera los archivos de configuración relacionados con la aplicación.
`setApplicationPlatformStatus`	Cambia el estado de la plataforma de la aplicación.

API de campañas


`createCampaign`	Crea una nueva campaña de push.
`deleteCampaign`	Elimina una campaña en particular.
`getCampaigns`	Recupera una lista de campañas para la aplicación.

API de configuración de aplicaciones


`configureApplication for iOS`	Configura la plataforma iOS para la aplicación.
`configureApplication for Android`	Configura la plataforma Android para la aplicación.
`configureApplication for Mac OS X`	Configura la plataforma macOS para la aplicación.
`configureApplication for Windows`	Configura la plataforma Windows para la aplicación.
`configureApplication for Amazon`	Configura la plataforma Amazon para la aplicación.
`configureApplication for Chrome`	Configura la plataforma Chrome para la aplicación.
`configureApplication for Safari`	Configura la plataforma Safari para la aplicación.
`configureApplication for Firefox`	Configura la plataforma Firefox para la aplicación.
`configureApplication for Email`	Configura la plataforma de correo electrónico para la aplicación.

API de correo electrónico


`createEmailMessage` Obsoleto	Crea un mensaje de correo electrónico. Use `Notify` con `platforms: ["EMAIL"]` y un `email_payload` en su lugar.
`registerEmail`	Registra una dirección de correo electrónico para la aplicación.
`deleteEmail`	Elimina una dirección de correo electrónico de su base de datos.
`setEmailTags`	Establece los valores de las etiquetas para la dirección de correo electrónico especificada.
`registerEmailUser`	Asocia un ID de usuario externo con una dirección de correo electrónico especificada.

API de dispositivos de prueba


`createTestDevice`	Registra un dispositivo de prueba para la aplicación.
`listTestDevices`	Recupera todos los dispositivos de prueba registrados para la aplicación.

API de bandeja de entrada de mensajes


`getInboxMessages`	Recupera la lista de mensajes de la bandeja de entrada para un HWID especificado.
`inboxStatus`	Actualiza el estado de un mensaje específico de la bandeja de entrada.

API de estadísticas

Estadísticas de mensajes


`messages:list`	Recupera una lista de los mensajes enviados.
`totalsByIntervals`	Proporciona métricas y datos de conversión agregados por hora.
`getMessageLog`	Recupera información detallada sobre los mensajes enviados.
`linksInteractions`	Proporciona estadísticas sobre los clics en los enlaces de los correos electrónicos.
`linksInteractionsDevices`	Enumera los usuarios que hicieron clic en los enlaces de los correos electrónicos.
`bouncedEmails`	Proporciona información sobre rebotes de correo electrónico, quejas y motivos de rebote.

Estadísticas de aplicaciones y suscriptores


`getApplicationSubscribersStats`	Recupera las estadísticas de suscriptores de la aplicación, agrupadas por tipo de dispositivo.
`getAppStats`	Recupera las estadísticas de la aplicación para un período de tiempo específico.
`getSubscribersStatistics`	Recupera las estadísticas de suscriptores para un período de tiempo específico.

Estadísticas de campañas


`getCampaignStats`	Recupera las estadísticas de la campaña para un período de tiempo específico.

Estadísticas de eventos y etiquetas


`getEventStatistics`	Recupera el número de veces que se activó un evento durante un período específico.
`getTagStats`	Recupera estadísticas para una etiqueta específica.

API de Actividades en Vivo de iOS


`startLiveActivity`	Crea una nueva Actividad en Vivo de iOS.
`updateLiveActivity`	Actualiza una Actividad en Vivo de iOS existente.

API de Apple Wallet PassKit


`Apple Wallet PassKit API`	Referencia para gestionar los pases de Apple Wallet y la configuración relacionada en Pushwoosh.

API de Google Wallet


`Create a pass`	Crea el pase en Google Wallet y devuelve un enlace para guardarlo.
`Validate a pass`	Comprueba la configuración de un pase sin crearlo.
`Update a pass`	Actualiza un pase existente. Google entrega el cambio a los dispositivos guardados.
`Get a save link`	Devuelve un enlace para guardar “Añadir a Google Wallet” para un pase existente.
`Get a pass`	Devuelve un único pase almacenado.
`List passes`	Devuelve una lista paginada de pases para una aplicación.
`Set pass state`	Activa o invalida un pase.
`Delete a pass`	Invalida el pase en Google y elimina su registro de Pushwoosh.
`Get configuration`	Devuelve el estado de configuración de Google Wallet para una aplicación.
`Templates`	Enumera las plantillas de pases o recupera una como punto de partida.

API de Customer Journey


`Lifecycle`	Inicia, pausa, finaliza, guarda como borrador o archiva un journey por su UUID.
`Create and update`	Crea una nueva definición de journey o reemplaza una existente.
`Start by API`	Inyecta usuarios en el punto de entrada de la API de un journey en ejecución.
`Get Journey stats`	Obtiene estadísticas para un journey específico por su ID.
`Remove users from journeys`	Elimina uno o más usuarios de todos o de journeys activos seleccionados.

API de solicitudes programadas


`getResults`	Recupera el resultado de una solicitud programada.

API de SMS


`createSMSMessage` Obsoleto	Crea un nuevo mensaje SMS. Use `Notify` con `platforms: ["SMS"]` en su lugar.

API de WhatsApp


`createWhatsAppMessage` Obsoleto	Crea un nuevo mensaje de WhatsApp. Use `Notify` con `platforms: ["WHATS_APP"]` en su lugar.

API de LINE


`createLineMessage` Obsoleto	Crea un nuevo mensaje de LINE. Use `Notify` con `platforms: ["LINE"]` en su lugar.

API de Kakao


`createKakaoMessage` Obsoleto	Envía un mensaje de Kakao utilizando una plantilla aprobada. Use `Notify` con `platforms: ["KAKAO"]` en su lugar.

API de Geozonas


`getNearestZone`	Recupera los parámetros de la geozona más cercana y la distancia a ella. También registra la ubicación del dispositivo para notificaciones push geolocalizadas.
`addGeoZone`	Añade una Geozona a una aplicación específica.
`updateGeoZone`	Actualiza las propiedades de la Geozona como el nombre, el estado, el contenido y el rango.
`deleteGeoZone`	Elimina Geozonas de la aplicación.
`addGeoZoneCluster`	Añade un Clúster de Geozonas a la aplicación.
`deleteGeoZoneCluster`	Elimina un Clúster de Geozonas de la aplicación.
`listGeoZones`	Recupera una lista de Geozonas para la aplicación.
`listGeoZoneClusters`	Recupera una lista de clústeres de Geozonas para la aplicación.