Skip to main content

Instalación y Configuración

Instala el SDK de TypeScript de OneSignal y configúralo para tu aplicación.
npm install @onesignal/node-onesignal
import Onesignal from '@onesignal/node-onesignal';

const configuration = Onesignal.createConfiguration({
    restApiKey: '<YOUR_REST_API_KEY>'
    organizationApiKey: '<YOUR_ORGANIZATION_API_KEY>',
});

const apiInstance = new Onesignal.DefaultApi(configuration);

Enviar mensajes

Envía mensajes push, email y SMS a tus usuarios vía el API de OneSignal. Para más detalles sobre cómo configurar mensajes, consulta la guía Enviar mensajes con el API de OneSignal.

Enviar notificaciones push

Envía notificaciones push a Suscripciones web y móviles.
const notification = new OneSignal.Notification();
notification.app_id = 'YOUR_APP_ID';
notification.contents = {
  en: 'Hello from your app!'
};
notification.headings = {
  en: 'Push Notification'
};
notification.included_segments = ['All'];

const { id } = await client.createNotification(notification);
console.log('Notification sent with ID:', id);

Enviar email

Envía emails a tus Suscripciones de email.
const notification = new OneSignal.Notification();
notification.app_id = 'YOUR_APP_ID';
notification.contents = {
  en: 'This is your email message content'
};
notification.headings = {
  en: 'Email Subject Line'
};
notification.email_subject = 'Important Update';
notification.email_body = '<h1>Hello!</h1><p>This is an HTML email.</p>';
notification.included_segments = ['All'];
notification.channel_for_external_user_ids = 'email';

const { id } = await client.createNotification(notification);
console.log('Email notification sent with ID:', id);

Enviar SMS

Envía mensajes de “texto” SMS a Suscripciones de SMS.
const notification = new OneSignal.Notification();
notification.app_id = 'YOUR_APP_ID';
notification.contents = {
  en: 'Your SMS message content here'
};
notification.included_segments = ['All'];
notification.channel_for_external_user_ids = 'sms';
notification.sms_from = '+1234567890'; // Tu número remitente de SMS

const { id } = await client.createNotification(notification);
console.log('SMS notification sent with ID:', id);
Para conocer los otros endpoints del SDK de Servidor, por favor consulta la referencia completa del API.