@aws-sdk/client-pinpoint

What is @aws-sdk/client-pinpoint?

@aws-sdk/client-pinpoint is an AWS SDK for JavaScript package that allows developers to interact with the Amazon Pinpoint service. Amazon Pinpoint is a flexible and scalable outbound and inbound marketing communications service. It enables you to engage with your customers by sending them targeted messages through multiple channels, such as email, SMS, push notifications, and voice messages.

What are @aws-sdk/client-pinpoint's main functionalities?

Send Email

This feature allows you to send an email using Amazon Pinpoint. The code sample demonstrates how to configure and send an email message to a recipient.

const { PinpointClient, SendMessagesCommand } = require('@aws-sdk/client-pinpoint');

const client = new PinpointClient({ region: 'us-west-2' });

const params = {
  ApplicationId: 'your-application-id',
  MessageRequest: {
    Addresses: {
      '[e-mail]': {
        ChannelType: 'EMAIL'
      }
    },
    MessageConfiguration: {
      EmailMessage: {
        SimpleEmail: {
          Subject: { Data: 'Test Email' },
          HtmlPart: { Data: '<h1>Hello</h1><p>This is a test email.</p>' },
          TextPart: { Data: 'Hello, This is a test email.' }
        }
      }
    }
  }
};

const run = async () => {
  try {
    const data = await client.send(new SendMessagesCommand(params));
    console.log('Success', data);
  } catch (err) {
    console.error('Error', err);
  }
};

run();

Send SMS

This feature allows you to send an SMS message using Amazon Pinpoint. The code sample demonstrates how to configure and send an SMS message to a recipient.

const { PinpointClient, SendMessagesCommand } = require('@aws-sdk/client-pinpoint');

const client = new PinpointClient({ region: 'us-west-2' });

const params = {
  ApplicationId: 'your-application-id',
  MessageRequest: {
    Addresses: {
      '[phone]': {
        ChannelType: 'SMS'
      }
    },
    MessageConfiguration: {
      SMSMessage: {
        Body: 'This is a test SMS message.',
        MessageType: 'TRANSACTIONAL'
      }
    }
  }
};

const run = async () => {
  try {
    const data = await client.send(new SendMessagesCommand(params));
    console.log('Success', data);
  } catch (err) {
    console.error('Error', err);
  }
};

run();

Create Segment

This feature allows you to create a segment in Amazon Pinpoint. The code sample demonstrates how to define and create a segment based on specific criteria.

const { PinpointClient, CreateSegmentCommand } = require('@aws-sdk/client-pinpoint');

const client = new PinpointClient({ region: 'us-west-2' });

const params = {
  ApplicationId: 'your-application-id',
  WriteSegmentRequest: {
    Name: 'TestSegment',
    Dimensions: {
      Demographic: {
        Channel: {
          Values: ['EMAIL'],
          DimensionType: 'INCLUSIVE'
        }
      }
    }
  }
};

const run = async () => {
  try {
    const data = await client.send(new CreateSegmentCommand(params));
    console.log('Success', data);
  } catch (err) {
    console.error('Error', err);
  }
};

run();

Other packages similar to @aws-sdk/client-pinpoint

sendgrid

SendGrid is a cloud-based service that provides email delivery and marketing campaigns. It offers similar functionalities to Amazon Pinpoint's email capabilities, including sending transactional and marketing emails, managing lists, and tracking email performance. However, SendGrid is focused solely on email, whereas Amazon Pinpoint supports multiple communication channels.

twilio

Twilio is a cloud communications platform that allows developers to build and manage communication channels such as SMS, voice, and video. Twilio offers similar functionalities to Amazon Pinpoint's SMS and voice capabilities. Twilio is known for its ease of use and extensive API documentation, but it does not provide the same level of integration with other AWS services as Amazon Pinpoint.

mailchimp

Mailchimp is a marketing automation platform and email marketing service. It offers functionalities similar to Amazon Pinpoint's email and campaign management features. Mailchimp provides tools for creating email campaigns, managing subscriber lists, and analyzing campaign performance. Unlike Amazon Pinpoint, Mailchimp is primarily focused on email marketing and does not support other communication channels like SMS or push notifications.

README

@aws-sdk/client-pinpoint

For SDK usage, please step to SDK reademe.