();
AddressConfiguration addConfig = AddressConfiguration.builder()
.channelType(ChannelType.SMS)
.build();
addressMap.put(destinationNumber, addConfig);
SMSMessage smsMessage = SMSMessage.builder()
.body(message)
.messageType(messageType)
.originationNumber(originationNumber)
.senderId(senderId)
.keyword(registeredKeyword)
.build();
// Create a DirectMessageConfiguration object.
DirectMessageConfiguration direct = DirectMessageConfiguration.builder()
.smsMessage(smsMessage)
.build();
MessageRequest msgReq = MessageRequest.builder()
.addresses(addressMap)
.messageConfiguration(direct)
.build();
// create a SendMessagesRequest object
SendMessagesRequest request = SendMessagesRequest.builder()
.applicationId(appId)
.messageRequest(msgReq)
.build();
SendMessagesResponse response = pinpoint.sendMessages(request);
MessageResponse msg1 = response.messageResponse();
Map map1 = msg1.result();
// Write out the result of sendMessage.
map1.forEach((k, v) -> System.out.println((k + ":" + v)));
} catch (PinpointException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
Send batch SMS messages.
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.pinpoint.PinpointClient;
import software.amazon.awssdk.services.pinpoint.model.DirectMessageConfiguration;
import software.amazon.awssdk.services.pinpoint.model.SMSMessage;
import software.amazon.awssdk.services.pinpoint.model.AddressConfiguration;
import software.amazon.awssdk.services.pinpoint.model.ChannelType;
import software.amazon.awssdk.services.pinpoint.model.MessageRequest;
import software.amazon.awssdk.services.pinpoint.model.SendMessagesRequest;
import software.amazon.awssdk.services.pinpoint.model.SendMessagesResponse;
import software.amazon.awssdk.services.pinpoint.model.MessageResponse;
import software.amazon.awssdk.services.pinpoint.model.PinpointException;
import java.util.HashMap;
import java.util.Map;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class SendMessageBatch {
// The type of SMS message that you want to send. If you plan to send
// time-sensitive content, specify TRANSACTIONAL. If you plan to send
// marketing-related content, specify PROMOTIONAL.
public static String messageType = "TRANSACTIONAL";
// The registered keyword associated with the originating short code.
public static String registeredKeyword = "myKeyword";
// The sender ID to use when sending the message. Support for sender ID
// varies by country or region. For more information, see
// https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html
public static String senderId = "MySenderID";
public static void main(String[] args) {
final String usage = """
Usage: \s
Where:
message - The body of the message to send.
appId - The Amazon Pinpoint project/application ID to use when you send this message.
originationNumber - The phone number or short code that you specify has to be associated with your Amazon Pinpoint account. For best results, specify long codes in E.164 format (for example, +1-555-555-5654).
destinationNumber - The recipient's phone number. For best results, you should specify the phone number in E.164 format (for example, +1-555-555-5654).
destinationNumber1 - The second recipient's phone number. For best results, you should specify the phone number in E.164 format (for example, +1-555-555-5654).\s
""";
if (args.length != 5) {
System.out.println(usage);
System.exit(1);
}
String message = args[0];
String appId = args[1];
String originationNumber = args[2];
String destinationNumber = args[3];
String destinationNumber1 = args[4];
System.out.println("Sending a message");
PinpointClient pinpoint = PinpointClient.builder()
.region(Region.US_EAST_1)
.build();
sendSMSMessage(pinpoint, message, appId, originationNumber, destinationNumber, destinationNumber1);
pinpoint.close();
}
public static void sendSMSMessage(PinpointClient pinpoint, String message, String appId,
String originationNumber,
String destinationNumber, String destinationNumber1) {
try {
Map addressMap = new HashMap();
AddressConfiguration addConfig = AddressConfiguration.builder()
.channelType(ChannelType.SMS)
.build();
// Add an entry to the Map object for each number to whom you want to send a
// message.
addressMap.put(destinationNumber, addConfig);
addressMap.put(destinationNumber1, addConfig);
SMSMessage smsMessage = SMSMessage.builder()
.body(message)
.messageType(messageType)
.originationNumber(originationNumber)
.senderId(senderId)
.keyword(registeredKeyword)
.build();
// Create a DirectMessageConfiguration object.
DirectMessageConfiguration direct = DirectMessageConfiguration.builder()
.smsMessage(smsMessage)
.build();
MessageRequest msgReq = MessageRequest.builder()
.addresses(addressMap)
.messageConfiguration(direct)
.build();
// Create a SendMessagesRequest object.
SendMessagesRequest request = SendMessagesRequest.builder()
.applicationId(appId)
.messageRequest(msgReq)
.build();
SendMessagesResponse response = pinpoint.sendMessages(request);
MessageResponse msg1 = response.messageResponse();
Map map1 = msg1.result();
// Write out the result of sendMessage.
map1.forEach((k, v) -> System.out.println((k + ":" + v)));
} catch (PinpointException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [SendMessages](https://docs.aws.amazon.com/goto/SdkForJavaV2/pinpoint-2016-12-01/SendMessages) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/pinpoint#code-examples).
Create the client in a separate module and export it.
```
import { PinpointClient } from "@aws-sdk/client-pinpoint";
// Set the AWS Region.
const REGION = "us-east-1";
export const pinClient = new PinpointClient({ region: REGION });
```
Send an email message.
```
// Import required AWS SDK clients and commands for Node.js
import { SendMessagesCommand } from "@aws-sdk/client-pinpoint";
import { pinClient } from "./libs/pinClient.js";
// The FromAddress must be verified in SES.
const fromAddress = "FROM_ADDRESS";
const toAddress = "TO_ADDRESS";
const projectId = "PINPOINT_PROJECT_ID";
// The subject line of the email.
const subject = "Amazon Pinpoint Test (AWS SDK for JavaScript in Node.js)";
// The email body for recipients with non-HTML email clients.
const body_text = `Amazon Pinpoint Test (SDK for JavaScript in Node.js)
----------------------------------------------------
This email was sent with Amazon Pinpoint using the AWS SDK for JavaScript in Node.js.
For more information, see https://aws.amazon.com/sdk-for-node-js/`;
// The body of the email for recipients whose email clients support HTML content.
const body_html = `
Amazon Pinpoint Test (SDK for JavaScript in Node.js)
This email was sent with
the Amazon Pinpoint Email API using the
AWS SDK for JavaScript in Node.js.
`;
// The character encoding for the subject line and message body of the email.
const charset = "UTF-8";
const params = {
ApplicationId: projectId,
MessageRequest: {
Addresses: {
[toAddress]: {
ChannelType: "EMAIL",
},
},
MessageConfiguration: {
EmailMessage: {
FromAddress: fromAddress,
SimpleEmail: {
Subject: {
Charset: charset,
Data: subject,
},
HtmlPart: {
Charset: charset,
Data: body_html,
},
TextPart: {
Charset: charset,
Data: body_text,
},
},
},
},
},
};
const run = async () => {
try {
const { MessageResponse } = await pinClient.send(
new SendMessagesCommand(params),
);
if (!MessageResponse) {
throw new Error("No message response.");
}
if (!MessageResponse.Result) {
throw new Error("No message result.");
}
const recipientResult = MessageResponse.Result[toAddress];
if (recipientResult.StatusCode !== 200) {
throw new Error(recipientResult.StatusMessage);
}
console.log(recipientResult.MessageId);
} catch (err) {
console.log(err.message);
}
};
run();
```
Send an SMS message.
```
// Import required AWS SDK clients and commands for Node.js
import { SendMessagesCommand } from "@aws-sdk/client-pinpoint";
import { pinClient } from "./libs/pinClient.js";
/* The phone number or short code to send the message from. The phone number
or short code that you specify has to be associated with your Amazon Pinpoint
account. For best results, specify long codes in E.164 format. */
const originationNumber = "SENDER_NUMBER"; //e.g., +1XXXXXXXXXX
// The recipient's phone number. For best results, you should specify the phone number in E.164 format.
const destinationNumber = "RECEIVER_NUMBER"; //e.g., +1XXXXXXXXXX
// The content of the SMS message.
const message =
"This message was sent through Amazon Pinpoint " +
"using the AWS SDK for JavaScript in Node.js. Reply STOP to " +
"opt out.";
/*The Amazon Pinpoint project/application ID to use when you send this message.
Make sure that the SMS channel is enabled for the project or application
that you choose.*/
const projectId = "PINPOINT_PROJECT_ID"; //e.g., XXXXXXXX66e4e9986478cXXXXXXXXX
/* The type of SMS message that you want to send. If you plan to send
time-sensitive content, specify TRANSACTIONAL. If you plan to send
marketing-related content, specify PROMOTIONAL.*/
const messageType = "TRANSACTIONAL";
// The registered keyword associated with the originating short code.
const registeredKeyword = "myKeyword";
/* The sender ID to use when sending the message. Support for sender ID
// varies by country or region. For more information, see
https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html.*/
const senderId = "MySenderID";
// Specify the parameters to pass to the API.
const params = {
ApplicationId: projectId,
MessageRequest: {
Addresses: {
[destinationNumber]: {
ChannelType: "SMS",
},
},
MessageConfiguration: {
SMSMessage: {
Body: message,
Keyword: registeredKeyword,
MessageType: messageType,
OriginationNumber: originationNumber,
SenderId: senderId,
},
},
},
};
const run = async () => {
try {
const data = await pinClient.send(new SendMessagesCommand(params));
console.log(
`Message sent! ${data.MessageResponse.Result[destinationNumber].StatusMessage}`,
);
} catch (err) {
console.log(err);
}
};
run();
```
+ For API details, see [SendMessages](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/pinpoint/command/SendMessagesCommand) in *AWS SDK for JavaScript API Reference*.
**SDK for JavaScript (v2)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascript/example_code/pinpoint#code-examples).
Send an email message.
```
"use strict";
const AWS = require("aws-sdk");
// The AWS Region that you want to use to send the email. For a list of
// AWS Regions where the Amazon Pinpoint API is available, see
// https://docs.aws.amazon.com/pinpoint/latest/apireference/
const aws_region = "us-west-2";
// The "From" address. This address has to be verified in Amazon Pinpoint
// in the region that you use to send email.
const senderAddress = "sender@example.com";
// The address on the "To" line. If your Amazon Pinpoint account is in
// the sandbox, this address also has to be verified.
var toAddress = "recipient@example.com";
// The Amazon Pinpoint project/application ID to use when you send this message.
// Make sure that the SMS channel is enabled for the project or application
// that you choose.
const appId = "ce796be37f32f178af652b26eexample";
// The subject line of the email.
var subject = "Amazon Pinpoint (AWS SDK for JavaScript in Node.js)";
// The email body for recipients with non-HTML email clients.
var body_text = `Amazon Pinpoint Test (SDK for JavaScript in Node.js)
----------------------------------------------------
This email was sent with Amazon Pinpoint using the AWS SDK for JavaScript in Node.js.
For more information, see https:\/\/aws.amazon.com/sdk-for-node-js/`;
// The body of the email for recipients whose email clients support HTML content.
var body_html = `
Amazon Pinpoint Test (SDK for JavaScript in Node.js)
This email was sent with
the Amazon Pinpoint API using the
AWS SDK for JavaScript in Node.js.
`;
// The character encoding the you want to use for the subject line and
// message body of the email.
var charset = "UTF-8";
// Specify that you're using a shared credentials file.
var credentials = new AWS.SharedIniFileCredentials({ profile: "default" });
AWS.config.credentials = credentials;
// Specify the region.
AWS.config.update({ region: aws_region });
//Create a new Pinpoint object.
var pinpoint = new AWS.Pinpoint();
// Specify the parameters to pass to the API.
var params = {
ApplicationId: appId,
MessageRequest: {
Addresses: {
[toAddress]: {
ChannelType: "EMAIL",
},
},
MessageConfiguration: {
EmailMessage: {
FromAddress: senderAddress,
SimpleEmail: {
Subject: {
Charset: charset,
Data: subject,
},
HtmlPart: {
Charset: charset,
Data: body_html,
},
TextPart: {
Charset: charset,
Data: body_text,
},
},
},
},
},
};
//Try to send the email.
pinpoint.sendMessages(params, function (err, data) {
// If something goes wrong, print an error message.
if (err) {
console.log(err.message);
} else {
console.log(
"Email sent! Message ID: ",
data["MessageResponse"]["Result"][toAddress]["MessageId"]
);
}
});
```
Send an SMS message.
```
"use strict";
var AWS = require("aws-sdk");
// The AWS Region that you want to use to send the message. For a list of
// AWS Regions where the Amazon Pinpoint API is available, see
// https://docs.aws.amazon.com/pinpoint/latest/apireference/.
var aws_region = "us-east-1";
// The phone number or short code to send the message from. The phone number
// or short code that you specify has to be associated with your Amazon Pinpoint
// account. For best results, specify long codes in E.164 format.
var originationNumber = "+12065550199";
// The recipient's phone number. For best results, you should specify the
// phone number in E.164 format.
var destinationNumber = "+14255550142";
// The content of the SMS message.
var message =
"This message was sent through Amazon Pinpoint " +
"using the AWS SDK for JavaScript in Node.js. Reply STOP to " +
"opt out.";
// The Amazon Pinpoint project/application ID to use when you send this message.
// Make sure that the SMS channel is enabled for the project or application
// that you choose.
var applicationId = "ce796be37f32f178af652b26eexample";
// The type of SMS message that you want to send. If you plan to send
// time-sensitive content, specify TRANSACTIONAL. If you plan to send
// marketing-related content, specify PROMOTIONAL.
var messageType = "TRANSACTIONAL";
// The registered keyword associated with the originating short code.
var registeredKeyword = "myKeyword";
// The sender ID to use when sending the message. Support for sender ID
// varies by country or region. For more information, see
// https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html
var senderId = "MySenderID";
// Specify that you're using a shared credentials file, and optionally specify
// the profile that you want to use.
var credentials = new AWS.SharedIniFileCredentials({ profile: "default" });
AWS.config.credentials = credentials;
// Specify the region.
AWS.config.update({ region: aws_region });
//Create a new Pinpoint object.
var pinpoint = new AWS.Pinpoint();
// Specify the parameters to pass to the API.
var params = {
ApplicationId: applicationId,
MessageRequest: {
Addresses: {
[destinationNumber]: {
ChannelType: "SMS",
},
},
MessageConfiguration: {
SMSMessage: {
Body: message,
Keyword: registeredKeyword,
MessageType: messageType,
OriginationNumber: originationNumber,
SenderId: senderId,
},
},
},
};
//Try to send the message.
pinpoint.sendMessages(params, function (err, data) {
// If something goes wrong, print an error message.
if (err) {
console.log(err.message);
// Otherwise, show the unique ID for the message.
} else {
console.log(
"Message sent! " +
data["MessageResponse"]["Result"][destinationNumber]["StatusMessage"]
);
}
});
```
+ For API details, see [SendMessages](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/pinpoint-2016-12-01/SendMessages) in *AWS SDK for JavaScript API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/pinpoint#code-examples).
```
/**
Before running this Kotlin code example, set up your development environment,
including your credentials.
For more information, see the following documentation topic:
https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html
*/
val body: String =
"""
Amazon Pinpoint test (AWS SDK for Kotlin)
This email was sent through the Amazon Pinpoint Email API using the AWS SDK for Kotlin.
""".trimIndent()
suspend fun main(args: Array) {
val usage = """
Usage:
Where:
subject - The email subject to use.
senderAddress - The from address. This address has to be verified in Amazon Pinpoint in the region you're using to send email
toAddress - The to address. This address has to be verified in Amazon Pinpoint in the region you're using to send email
"""
if (args.size != 3) {
println(usage)
exitProcess(0)
}
val subject = args[0]
val senderAddress = args[1]
val toAddress = args[2]
sendEmail(subject, senderAddress, toAddress)
}
suspend fun sendEmail(
subjectVal: String?,
senderAddress: String,
toAddressVal: String,
) {
var content =
Content {
data = body
}
val messageBody =
Body {
text = content
}
val subContent =
Content {
data = subjectVal
}
val message =
Message {
body = messageBody
subject = subContent
}
val destinationOb =
Destination {
toAddresses = listOf(toAddressVal)
}
val emailContent =
EmailContent {
simple = message
}
val sendEmailRequest =
SendEmailRequest {
fromEmailAddress = senderAddress
destination = destinationOb
this.content = emailContent
}
PinpointEmailClient.fromEnvironment { region = "us-east-1" }.use { pinpointemail ->
pinpointemail.sendEmail(sendEmailRequest)
println("Message Sent")
}
}
```
+ For API details, see [SendMessages](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/pinpoint#code-examples).
Send an email message.
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
def send_email_message(
pinpoint_client,
app_id,
sender,
to_addresses,
char_set,
subject,
html_message,
text_message,
):
"""
Sends an email message with HTML and plain text versions.
:param pinpoint_client: A Boto3 Pinpoint client.
:param app_id: The Amazon Pinpoint project ID to use when you send this message.
:param sender: The "From" address. This address must be verified in
Amazon Pinpoint in the AWS Region you're using to send email.
:param to_addresses: The addresses on the "To" line. If your Amazon Pinpoint account
is in the sandbox, these addresses must be verified.
:param char_set: The character encoding to use for the subject line and message
body of the email.
:param subject: The subject line of the email.
:param html_message: The body of the email for recipients whose email clients can
display HTML content.
:param text_message: The body of the email for recipients whose email clients
don't support HTML content.
:return: A dict of to_addresses and their message IDs.
"""
try:
response = pinpoint_client.send_messages(
ApplicationId=app_id,
MessageRequest={
"Addresses": {
to_address: {"ChannelType": "EMAIL"} for to_address in to_addresses
},
"MessageConfiguration": {
"EmailMessage": {
"FromAddress": sender,
"SimpleEmail": {
"Subject": {"Charset": char_set, "Data": subject},
"HtmlPart": {"Charset": char_set, "Data": html_message},
"TextPart": {"Charset": char_set, "Data": text_message},
},
}
},
},
)
except ClientError:
logger.exception("Couldn't send email.")
raise
else:
return {
to_address: message["MessageId"]
for to_address, message in response["MessageResponse"]["Result"].items()
}
def main():
app_id = "ce796be37f32f178af652b26eexample"
sender = "sender@example.com"
to_address = "recipient@example.com"
char_set = "UTF-8"
subject = "Amazon Pinpoint Test (SDK for Python (Boto3))"
text_message = """Amazon Pinpoint Test (SDK for Python)
-------------------------------------
This email was sent with Amazon Pinpoint using the AWS SDK for Python (Boto3).
For more information, see https://aws.amazon.com/sdk-for-python/
"""
html_message = """
Amazon Pinpoint Test (SDK for Python (Boto3)
This email was sent with
Amazon Pinpoint using the
AWS SDK for Python (Boto3).
"""
print("Sending email.")
message_ids = send_email_message(
boto3.client("pinpoint"),
app_id,
sender,
[to_address],
char_set,
subject,
html_message,
text_message,
)
print(f"Message sent! Message IDs: {message_ids}")
if __name__ == "__main__":
main()
```
Send an SMS message.
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
def send_sms_message(
pinpoint_client,
app_id,
origination_number,
destination_number,
message,
message_type,
):
"""
Sends an SMS message with Amazon Pinpoint.
:param pinpoint_client: A Boto3 Pinpoint client.
:param app_id: The Amazon Pinpoint project/application ID to use when you send
this message. The SMS channel must be enabled for the project or
application.
:param destination_number: The recipient's phone number in E.164 format.
:param origination_number: The phone number to send the message from. This phone
number must be associated with your Amazon Pinpoint
account and be in E.164 format.
:param message: The content of the SMS message.
:param message_type: The type of SMS message that you want to send. If you send
time-sensitive content, specify TRANSACTIONAL. If you send
marketing-related content, specify PROMOTIONAL.
:return: The ID of the message.
"""
try:
response = pinpoint_client.send_messages(
ApplicationId=app_id,
MessageRequest={
"Addresses": {destination_number: {"ChannelType": "SMS"}},
"MessageConfiguration": {
"SMSMessage": {
"Body": message,
"MessageType": message_type,
"OriginationNumber": origination_number,
}
},
},
)
except ClientError:
logger.exception("Couldn't send message.")
raise
else:
return response["MessageResponse"]["Result"][destination_number]["MessageId"]
def main():
app_id = "ce796be37f32f178af652b26eexample"
origination_number = "+12065550199"
destination_number = "+14255550142"
message = (
"This is a sample message sent from Amazon Pinpoint by using the AWS SDK for "
"Python (Boto 3)."
)
message_type = "TRANSACTIONAL"
print("Sending SMS message.")
message_id = send_sms_message(
boto3.client("pinpoint"),
app_id,
origination_number,
destination_number,
message,
message_type,
)
print(f"Message sent! Message ID: {message_id}.")
if __name__ == "__main__":
main()
```
Send an email message with an existing email template.
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
def send_templated_email_message(
pinpoint_client, project_id, sender, to_addresses, template_name, template_version
):
"""
Sends an email message with HTML and plain text versions.
:param pinpoint_client: A Boto3 Pinpoint client.
:param project_id: The Amazon Pinpoint project ID to use when you send this message.
:param sender: The "From" address. This address must be verified in
Amazon Pinpoint in the AWS Region you're using to send email.
:param to_addresses: The addresses on the "To" line. If your Amazon Pinpoint
account is in the sandbox, these addresses must be verified.
:param template_name: The name of the email template to use when sending the message.
:param template_version: The version number of the message template.
:return: A dict of to_addresses and their message IDs.
"""
try:
response = pinpoint_client.send_messages(
ApplicationId=project_id,
MessageRequest={
"Addresses": {
to_address: {"ChannelType": "EMAIL"} for to_address in to_addresses
},
"MessageConfiguration": {"EmailMessage": {"FromAddress": sender}},
"TemplateConfiguration": {
"EmailTemplate": {
"Name": template_name,
"Version": template_version,
}
},
},
)
except ClientError:
logger.exception("Couldn't send email.")
raise
else:
return {
to_address: message["MessageId"]
for to_address, message in response["MessageResponse"]["Result"].items()
}
def main():
project_id = "296b04b342374fceb661bf494example"
sender = "sender@example.com"
to_addresses = ["recipient@example.com"]
template_name = "My_Email_Template"
template_version = "1"
print("Sending email.")
message_ids = send_templated_email_message(
boto3.client("pinpoint"),
project_id,
sender,
to_addresses,
template_name,
template_version,
)
print(f"Message sent! Message IDs: {message_ids}")
if __name__ == "__main__":
main()
```
Send a text message with an existing SMS template.
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
def send_templated_sms_message(
pinpoint_client,
project_id,
destination_number,
message_type,
origination_number,
template_name,
template_version,
):
"""
Sends an SMS message to a specific phone number using a pre-defined template.
:param pinpoint_client: A Boto3 Pinpoint client.
:param project_id: An Amazon Pinpoint project (application) ID.
:param destination_number: The phone number to send the message to.
:param message_type: The type of SMS message (promotional or transactional).
:param origination_number: The phone number that the message is sent from.
:param template_name: The name of the SMS template to use when sending the message.
:param template_version: The version number of the message template.
:return The ID of the message.
"""
try:
response = pinpoint_client.send_messages(
ApplicationId=project_id,
MessageRequest={
"Addresses": {destination_number: {"ChannelType": "SMS"}},
"MessageConfiguration": {
"SMSMessage": {
"MessageType": message_type,
"OriginationNumber": origination_number,
}
},
"TemplateConfiguration": {
"SMSTemplate": {"Name": template_name, "Version": template_version}
},
},
)
except ClientError:
logger.exception("Couldn't send message.")
raise
else:
return response["MessageResponse"]["Result"][destination_number]["MessageId"]
def main():
region = "us-east-1"
origination_number = "+18555550001"
destination_number = "+14255550142"
project_id = "7353f53e6885409fa32d07cedexample"
message_type = "TRANSACTIONAL"
template_name = "My_SMS_Template"
template_version = "1"
message_id = send_templated_sms_message(
boto3.client("pinpoint", region_name=region),
project_id,
destination_number,
message_type,
origination_number,
template_name,
template_version,
)
print(f"Message sent! Message ID: {message_id}.")
if __name__ == "__main__":
main()
```
+ For API details, see [SendMessages](https://docs.aws.amazon.com/goto/boto3/pinpoint-2016-12-01/SendMessages) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ppt#code-examples).
Send an email message.
```
" Build the addresses map from the list of to_addresses
DATA lt_addresses TYPE /aws1/cl_pptaddressconf=>tt_mapofaddressconfiguration.
LOOP AT it_to_addresses INTO DATA(lo_address).
INSERT VALUE /aws1/cl_pptaddressconf=>ts_mapofaddressconf_maprow(
key = lo_address->get_value( )
value = NEW /aws1/cl_pptaddressconf( iv_channeltype = 'EMAIL' )
) INTO TABLE lt_addresses.
ENDLOOP.
" Send the email message
DATA(lo_result) = lo_ppt->sendmessages(
iv_applicationid = iv_app_id
io_messagerequest = NEW /aws1/cl_pptmessagerequest(
it_addresses = lt_addresses
io_messageconfiguration = NEW /aws1/cl_pptdirectmessageconf(
io_emailmessage = NEW /aws1/cl_pptemailmessage(
iv_fromaddress = iv_sender
io_simpleemail = NEW /aws1/cl_pptsimpleemail(
io_subject = NEW /aws1/cl_pptsimpleemailpart(
iv_charset = iv_char_set
iv_data = iv_subject
)
io_htmlpart = NEW /aws1/cl_pptsimpleemailpart(
iv_charset = iv_char_set
iv_data = iv_html_message
)
io_textpart = NEW /aws1/cl_pptsimpleemailpart(
iv_charset = iv_char_set
iv_data = iv_text_message
)
)
)
)
)
).
" Extract message IDs from response
DATA(lo_message_response) = lo_result->get_messageresponse( ).
ot_message_ids = lo_message_response->get_result( ).
MESSAGE 'Email message sent successfully.' TYPE 'I'.
```
Send an SMS message.
```
" Build the addresses map for the destination number
DATA lt_addresses TYPE /aws1/cl_pptaddressconf=>tt_mapofaddressconfiguration.
INSERT VALUE /aws1/cl_pptaddressconf=>ts_mapofaddressconf_maprow(
key = iv_destination_number
value = NEW /aws1/cl_pptaddressconf( iv_channeltype = 'SMS' )
) INTO TABLE lt_addresses.
" Send the SMS message
DATA(lo_result) = lo_ppt->sendmessages(
iv_applicationid = iv_app_id
io_messagerequest = NEW /aws1/cl_pptmessagerequest(
it_addresses = lt_addresses
io_messageconfiguration = NEW /aws1/cl_pptdirectmessageconf(
io_smsmessage = NEW /aws1/cl_pptsmsmessage(
iv_body = iv_message
iv_messagetype = iv_message_type
iv_originationnumber = iv_origination_number
)
)
)
).
" Extract message ID from response
DATA(lo_message_response) = lo_result->get_messageresponse( ).
DATA(lt_results) = lo_message_response->get_result( ).
LOOP AT lt_results INTO DATA(ls_result).
IF ls_result-key = iv_destination_number.
ov_message_id = ls_result-value->get_messageid( ).
EXIT.
ENDIF.
ENDLOOP.
MESSAGE 'SMS message sent successfully.' TYPE 'I'.
```
Send an email message with an existing email template.
```
" Build the addresses map from the list of to_addresses
DATA lt_addresses TYPE /aws1/cl_pptaddressconf=>tt_mapofaddressconfiguration.
LOOP AT it_to_addresses INTO DATA(lo_address).
INSERT VALUE /aws1/cl_pptaddressconf=>ts_mapofaddressconf_maprow(
key = lo_address->get_value( )
value = NEW /aws1/cl_pptaddressconf( iv_channeltype = 'EMAIL' )
) INTO TABLE lt_addresses.
ENDLOOP.
" Send the email message using a template
DATA(lo_result) = lo_ppt->sendmessages(
iv_applicationid = iv_app_id
io_messagerequest = NEW /aws1/cl_pptmessagerequest(
it_addresses = lt_addresses
io_messageconfiguration = NEW /aws1/cl_pptdirectmessageconf(
io_emailmessage = NEW /aws1/cl_pptemailmessage(
iv_fromaddress = iv_sender
)
)
io_templateconfiguration = NEW /aws1/cl_ppttemplateconf(
io_emailtemplate = NEW /aws1/cl_ppttemplate(
iv_name = iv_template_name
iv_version = iv_template_version
)
)
)
).
" Extract message IDs from response
DATA(lo_message_response) = lo_result->get_messageresponse( ).
ot_message_ids = lo_message_response->get_result( ).
MESSAGE 'Templated email message sent successfully.' TYPE 'I'.
```
Send a text message with an existing SMS template.
```
" Build the addresses map for the destination number
DATA lt_addresses TYPE /aws1/cl_pptaddressconf=>tt_mapofaddressconfiguration.
INSERT VALUE /aws1/cl_pptaddressconf=>ts_mapofaddressconf_maprow(
key = iv_destination_number
value = NEW /aws1/cl_pptaddressconf( iv_channeltype = 'SMS' )
) INTO TABLE lt_addresses.
" Send the SMS message using a template
DATA(lo_result) = lo_ppt->sendmessages(
iv_applicationid = iv_app_id
io_messagerequest = NEW /aws1/cl_pptmessagerequest(
it_addresses = lt_addresses
io_messageconfiguration = NEW /aws1/cl_pptdirectmessageconf(
io_smsmessage = NEW /aws1/cl_pptsmsmessage(
iv_messagetype = iv_message_type
iv_originationnumber = iv_origination_number
)
)
io_templateconfiguration = NEW /aws1/cl_ppttemplateconf(
io_smstemplate = NEW /aws1/cl_ppttemplate(
iv_name = iv_template_name
iv_version = iv_template_version
)
)
)
).
" Extract message ID from response
DATA(lo_message_response) = lo_result->get_messageresponse( ).
DATA(lt_results) = lo_message_response->get_result( ).
LOOP AT lt_results INTO DATA(ls_result).
IF ls_result-key = iv_destination_number.
ov_message_id = ls_result-value->get_messageid( ).
EXIT.
ENDIF.
ENDLOOP.
MESSAGE 'Templated SMS message sent successfully.' TYPE 'I'.
```
+ For API details, see [SendMessages](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `UpdateEndpoint` with an AWS SDK
The following code example shows how to use `UpdateEndpoint`.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/pinpoint#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.pinpoint.PinpointClient;
import software.amazon.awssdk.services.pinpoint.model.EndpointResponse;
import software.amazon.awssdk.services.pinpoint.model.EndpointRequest;
import software.amazon.awssdk.services.pinpoint.model.UpdateEndpointRequest;
import software.amazon.awssdk.services.pinpoint.model.UpdateEndpointResponse;
import software.amazon.awssdk.services.pinpoint.model.GetEndpointRequest;
import software.amazon.awssdk.services.pinpoint.model.GetEndpointResponse;
import software.amazon.awssdk.services.pinpoint.model.PinpointException;
import software.amazon.awssdk.services.pinpoint.model.EndpointDemographic;
import software.amazon.awssdk.services.pinpoint.model.EndpointLocation;
import software.amazon.awssdk.services.pinpoint.model.EndpointUser;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.List;
import java.util.UUID;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import java.util.Date;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class UpdateEndpoint {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
appId - The ID of the application to create an endpoint for.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String appId = args[0];
PinpointClient pinpoint = PinpointClient.builder()
.region(Region.US_EAST_1)
.build();
EndpointResponse response = createEndpoint(pinpoint, appId);
System.out.println("Got Endpoint: " + response.id());
pinpoint.close();
}
public static EndpointResponse createEndpoint(PinpointClient client, String appId) {
String endpointId = UUID.randomUUID().toString();
System.out.println("Endpoint ID: " + endpointId);
try {
EndpointRequest endpointRequest = createEndpointRequestData();
UpdateEndpointRequest updateEndpointRequest = UpdateEndpointRequest.builder()
.applicationId(appId)
.endpointId(endpointId)
.endpointRequest(endpointRequest)
.build();
UpdateEndpointResponse updateEndpointResponse = client.updateEndpoint(updateEndpointRequest);
System.out.println("Update Endpoint Response: " + updateEndpointResponse.messageBody());
GetEndpointRequest getEndpointRequest = GetEndpointRequest.builder()
.applicationId(appId)
.endpointId(endpointId)
.build();
GetEndpointResponse getEndpointResponse = client.getEndpoint(getEndpointRequest);
System.out.println(getEndpointResponse.endpointResponse().address());
System.out.println(getEndpointResponse.endpointResponse().channelType());
System.out.println(getEndpointResponse.endpointResponse().applicationId());
System.out.println(getEndpointResponse.endpointResponse().endpointStatus());
System.out.println(getEndpointResponse.endpointResponse().requestId());
System.out.println(getEndpointResponse.endpointResponse().user());
return getEndpointResponse.endpointResponse();
} catch (PinpointException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
private static EndpointRequest createEndpointRequestData() {
try {
List favoriteTeams = new ArrayList<>();
favoriteTeams.add("Lakers");
favoriteTeams.add("Warriors");
HashMap> customAttributes = new HashMap<>();
customAttributes.put("team", favoriteTeams);
EndpointDemographic demographic = EndpointDemographic.builder()
.appVersion("1.0")
.make("apple")
.model("iPhone")
.modelVersion("7")
.platform("ios")
.platformVersion("10.1.1")
.timezone("America/Los_Angeles")
.build();
EndpointLocation location = EndpointLocation.builder()
.city("Los Angeles")
.country("US")
.latitude(34.0)
.longitude(-118.2)
.postalCode("90068")
.region("CA")
.build();
Map metrics = new HashMap<>();
metrics.put("health", 100.00);
metrics.put("luck", 75.00);
EndpointUser user = EndpointUser.builder()
.userId(UUID.randomUUID().toString())
.build();
DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm'Z'"); // Quoted "Z" to indicate UTC, no timezone
// offset
String nowAsISO = df.format(new Date());
return EndpointRequest.builder()
.address(UUID.randomUUID().toString())
.attributes(customAttributes)
.channelType("APNS")
.demographic(demographic)
.effectiveDate(nowAsISO)
.location(location)
.metrics(metrics)
.optOut("NONE")
.requestId(UUID.randomUUID().toString())
.user(user)
.build();
} catch (PinpointException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return null;
}
}
```
+ For API details, see [UpdateEndpoint](https://docs.aws.amazon.com/goto/SdkForJavaV2/pinpoint-2016-12-01/UpdateEndpoint) in *AWS SDK for Java 2.x API Reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Scenarios for Amazon Pinpoint using AWS SDKs
The following code examples show you how to implement common scenarios in Amazon Pinpoint with AWS SDKs. These scenarios show you how to accomplish specific tasks by calling multiple functions within Amazon Pinpoint or combined with other AWS services. Each scenario includes a link to the complete source code, where you can find instructions on how to set up and run the code.
Scenarios target an intermediate level of experience to help you understand service actions in context.
**Topics**
+ [Getting started with End User Messaging Push](pinpoint_example_pinpoint_GettingStarted_049_section.md)
# Getting started with End User Messaging Push
The following code example shows how to:
+ Create an application
+ Enable push notification channels
+ Send a push notification
+ Clean up resources
------
#### [ Bash ]
**AWS CLI with Bash script**
There's more on GitHub. Find the complete example and learn how to set up and run in the [Sample developer tutorials](https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/049-aws-end-user-messaging-gs) repository.
```
#!/bin/bash
# AWS End User Messaging Push Getting Started Script
# This script creates an AWS End User Messaging Push application and demonstrates
# how to enable push notification channels and send a test message.
#
# Prerequisites:
# - AWS CLI installed and configured
# - Appropriate IAM permissions for Pinpoint operations
#
# Usage: ./2-cli-script-final-working.sh [--auto-cleanup]
# Check for auto-cleanup flag
AUTO_CLEANUP=false
if [[ "${1:-}" == "--auto-cleanup" ]]; then
AUTO_CLEANUP=true
fi
# Set up logging
LOG_FILE="aws-end-user-messaging-push-script-$(date +%Y%m%d-%H%M%S).log"
exec > >(tee -a "$LOG_FILE") 2>&1
echo "Starting AWS End User Messaging Push setup script..."
echo "Logging to $LOG_FILE"
echo "Timestamp: $(date)"
# Function to check for errors in command output
check_error() {
local output=$1
local cmd=$2
local ignore_error=${3:-false}
if echo "$output" | grep -qi "error\|exception\|fail"; then
echo "ERROR: Command failed: $cmd"
echo "Error details: $output"
if [ "$ignore_error" = "true" ]; then
echo "Ignoring error and continuing..."
return 1
else
cleanup_on_error
exit 1
fi
fi
return 0
}
# Function to clean up resources on error
cleanup_on_error() {
echo "Error encountered. Cleaning up resources..."
if [ -n "${APP_ID:-}" ]; then
echo "Deleting application with ID: $APP_ID"
aws pinpoint delete-app --application-id "$APP_ID" 2>/dev/null || echo "Failed to delete application"
fi
# Clean up any created files
rm -f gcm-message.json apns-message.json
echo "Cleanup completed."
}
# Function to validate AWS CLI is configured
validate_aws_cli() {
echo "Validating AWS CLI configuration..."
# Check if AWS CLI is installed
if ! command -v aws &> /dev/null; then
echo "ERROR: AWS CLI is not installed. Please install it first."
echo "Visit: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html"
exit 1
fi
# Check AWS CLI version
AWS_VERSION=$(aws --version 2>&1 | head -n1)
echo "AWS CLI version: $AWS_VERSION"
# Check if AWS CLI is configured
if ! aws sts get-caller-identity &> /dev/null; then
echo "ERROR: AWS CLI is not configured or credentials are invalid."
echo "Please run 'aws configure' to set up your credentials."
exit 1
fi
# Get current AWS identity and region
CALLER_IDENTITY=$(aws sts get-caller-identity)
CURRENT_REGION=$(aws configure get region 2>/dev/null || echo "us-east-1")
echo "AWS CLI configured for:"
echo "$CALLER_IDENTITY"
echo "Current region: $CURRENT_REGION"
echo ""
}
# Function to check if jq is available for JSON parsing
check_json_tools() {
if command -v jq &> /dev/null; then
USE_JQ=true
echo "jq is available for JSON parsing"
else
USE_JQ=false
echo "jq is not available, using grep for JSON parsing"
echo "Consider installing jq for better JSON handling: https://stedolan.github.io/jq/"
fi
}
# Function to extract JSON values
extract_json_value() {
local json=$1
local key=$2
if [ "$USE_JQ" = "true" ]; then
echo "$json" | jq -r ".$key"
else
# Fallback to grep method
echo "$json" | grep -o "\"$key\": \"[^\"]*" | cut -d'"' -f4 | head -n1
fi
}
# Function to validate required IAM permissions
validate_permissions() {
echo "Validating IAM permissions..."
# Test basic Pinpoint permissions
if ! aws pinpoint get-apps &> /dev/null; then
echo "WARNING: Unable to list Pinpoint applications. Please ensure you have the following IAM permissions:"
echo "- mobiletargeting:GetApps"
echo "- mobiletargeting:CreateApp"
echo "- mobiletargeting:DeleteApp"
echo "- mobiletargeting:UpdateGcmChannel"
echo "- mobiletargeting:UpdateApnsChannel"
echo "- mobiletargeting:SendMessages"
echo ""
echo "Continuing anyway..."
else
echo "Basic Pinpoint permissions validated."
fi
}
# Validate prerequisites
validate_aws_cli
check_json_tools
validate_permissions
# Generate a random suffix for resource names to avoid conflicts
RANDOM_SUFFIX=$(LC_ALL=C tr -dc 'a-z0-9' < /dev/urandom | fold -w 8 | head -n1)
APP_NAME="PushNotificationApp-${RANDOM_SUFFIX}"
echo "Creating application with name: $APP_NAME"
# Step 1: Create an application
echo "Executing: aws pinpoint create-app --create-application-request Name=${APP_NAME}"
CREATE_APP_OUTPUT=$(aws pinpoint create-app --create-application-request "Name=${APP_NAME}" 2>&1)
check_error "$CREATE_APP_OUTPUT" "create-app"
echo "Application created successfully:"
echo "$CREATE_APP_OUTPUT"
# Extract the application ID from the output
if [ "$USE_JQ" = "true" ]; then
APP_ID=$(echo "$CREATE_APP_OUTPUT" | jq -r '.ApplicationResponse.Id')
else
APP_ID=$(echo "$CREATE_APP_OUTPUT" | grep -o '"Id": "[^"]*' | cut -d'"' -f4 | head -n1)
fi
if [ -z "$APP_ID" ] || [ "$APP_ID" = "null" ]; then
echo "ERROR: Failed to extract application ID from output"
echo "Output was: $CREATE_APP_OUTPUT"
exit 1
fi
echo "Application ID: $APP_ID"
# Create a resources list to track what we've created
RESOURCES=("Application: $APP_ID")
# Step 2: Enable FCM (GCM) channel with a sample API key
echo ""
echo "==========================================="
echo "ENABLING FCM (GCM) CHANNEL"
echo "==========================================="
echo "Note: This is using a placeholder API key for demonstration purposes only."
echo "In a production environment, you should use your actual FCM API key from Firebase Console."
echo ""
echo "IMPORTANT: The following command will likely fail because we're using a placeholder API key."
echo "This is expected behavior for this demonstration script."
echo "Executing: aws pinpoint update-gcm-channel --application-id $APP_ID --gcm-channel-request ..."
UPDATE_GCM_OUTPUT=$(aws pinpoint update-gcm-channel \
--application-id "$APP_ID" \
--gcm-channel-request '{"Enabled": true, "ApiKey": "sample-fcm-api-key-for-demo-only"}' 2>&1)
# We'll ignore this specific error since we're using a placeholder API key
if check_error "$UPDATE_GCM_OUTPUT" "update-gcm-channel" "true"; then
echo "FCM channel enabled successfully:"
echo "$UPDATE_GCM_OUTPUT"
RESOURCES+=("GCM Channel for application: $APP_ID")
else
echo "As expected, FCM channel update failed with the placeholder API key."
echo "Error details: $UPDATE_GCM_OUTPUT"
echo ""
echo "To enable FCM in production:"
echo "1. Go to Firebase Console (https://console.firebase.google.com/)"
echo "2. Create or select your project"
echo "3. Go to Project Settings > Cloud Messaging"
echo "4. Copy the Server Key"
echo "5. Replace 'sample-fcm-api-key-for-demo-only' with your actual Server Key"
fi
# Step 3: Try to enable APNS channel (this will also fail without real certificates)
echo ""
echo "==========================================="
echo "ENABLING APNS CHANNEL (OPTIONAL)"
echo "==========================================="
echo "Attempting to enable APNS channel with placeholder certificate..."
echo "This will also fail without real APNS certificates, which is expected."
# Create a placeholder APNS configuration
echo "Executing: aws pinpoint update-apns-channel --application-id $APP_ID --apns-channel-request ..."
UPDATE_APNS_OUTPUT=$(aws pinpoint update-apns-channel \
--application-id "$APP_ID" \
--apns-channel-request '{"Enabled": true, "Certificate": "placeholder-certificate", "PrivateKey": "placeholder-private-key"}' 2>&1)
if check_error "$UPDATE_APNS_OUTPUT" "update-apns-channel" "true"; then
echo "APNS channel enabled successfully:"
echo "$UPDATE_APNS_OUTPUT"
RESOURCES+=("APNS Channel for application: $APP_ID")
else
echo "As expected, APNS channel update failed with placeholder certificates."
echo "Error details: $UPDATE_APNS_OUTPUT"
echo ""
echo "To enable APNS in production:"
echo "1. Generate APNS certificates from Apple Developer Console"
echo "2. Convert certificates to PEM format"
echo "3. Use the actual certificate and private key in the update-apns-channel command"
fi
# Step 4: Create message files for different platforms
echo ""
echo "==========================================="
echo "CREATING MESSAGE FILES"
echo "==========================================="
# Create FCM message file
echo "Creating FCM message file..."
cat > gcm-message.json << 'EOF'
{
"Addresses": {
"SAMPLE-DEVICE-TOKEN-FCM": {
"ChannelType": "GCM"
}
},
"MessageConfiguration": {
"GCMMessage": {
"Action": "OPEN_APP",
"Body": "Hello from AWS End User Messaging Push! This is an FCM notification.",
"Priority": "normal",
"SilentPush": false,
"Title": "My First FCM Push Notification",
"TimeToLive": 30,
"Data": {
"key1": "value1",
"key2": "value2"
}
}
}
}
EOF
# Create APNS message file
echo "Creating APNS message file..."
cat > apns-message.json << 'EOF'
{
"Addresses": {
"SAMPLE-DEVICE-TOKEN-APNS": {
"ChannelType": "APNS"
}
},
"MessageConfiguration": {
"APNSMessage": {
"Action": "OPEN_APP",
"Body": "Hello from AWS End User Messaging Push! This is an APNS notification.",
"Priority": "normal",
"SilentPush": false,
"Title": "My First APNS Push Notification",
"TimeToLive": 30,
"Badge": 1,
"Sound": "default"
}
}
}
EOF
echo "Message files created:"
echo "- gcm-message.json (for FCM/Android)"
echo "- apns-message.json (for APNS/iOS)"
echo ""
echo "Note: These messages use placeholder device tokens and will not actually be delivered."
echo "To send real messages, you would need to replace the sample device tokens with actual ones."
# Step 5: Demonstrate how to send messages (this will fail with placeholder tokens)
echo ""
echo "==========================================="
echo "DEMONSTRATING MESSAGE SENDING"
echo "==========================================="
echo "Attempting to send FCM message (will fail with placeholder token)..."
echo "Executing: aws pinpoint send-messages --application-id $APP_ID --message-request file://gcm-message.json"
SEND_FCM_OUTPUT=$(aws pinpoint send-messages \
--application-id "$APP_ID" \
--message-request file://gcm-message.json 2>&1)
if check_error "$SEND_FCM_OUTPUT" "send-messages (FCM)" "true"; then
echo "FCM message sent successfully:"
echo "$SEND_FCM_OUTPUT"
else
echo "As expected, FCM message sending failed with placeholder token."
echo "Error details: $SEND_FCM_OUTPUT"
fi
echo ""
echo "Attempting to send APNS message (will fail with placeholder token)..."
echo "Executing: aws pinpoint send-messages --application-id $APP_ID --message-request file://apns-message.json"
SEND_APNS_OUTPUT=$(aws pinpoint send-messages \
--application-id "$APP_ID" \
--message-request file://apns-message.json 2>&1)
if check_error "$SEND_APNS_OUTPUT" "send-messages (APNS)" "true"; then
echo "APNS message sent successfully:"
echo "$SEND_APNS_OUTPUT"
else
echo "As expected, APNS message sending failed with placeholder token."
echo "Error details: $SEND_APNS_OUTPUT"
fi
# Step 6: Show application details
echo ""
echo "==========================================="
echo "APPLICATION DETAILS"
echo "==========================================="
echo "Retrieving application details..."
echo "Executing: aws pinpoint get-app --application-id $APP_ID"
GET_APP_OUTPUT=$(aws pinpoint get-app --application-id "$APP_ID" 2>&1)
if check_error "$GET_APP_OUTPUT" "get-app"; then
echo "Application details:"
echo "$GET_APP_OUTPUT"
fi
# Display summary of created resources
echo ""
echo "==========================================="
echo "RESOURCES CREATED"
echo "==========================================="
for resource in "${RESOURCES[@]}"; do
echo "- $resource"
done
echo ""
echo "Files created:"
echo "- gcm-message.json"
echo "- apns-message.json"
echo "- $LOG_FILE"
# Cleanup prompt with proper input handling
echo ""
echo "==========================================="
echo "CLEANUP CONFIRMATION"
echo "==========================================="
echo "This script created AWS resources that may incur charges."
if [ "$AUTO_CLEANUP" = "true" ]; then
echo "Auto-cleanup enabled. Cleaning up resources..."
CLEANUP_CHOICE="y"
else
echo "Do you want to clean up all created resources? (y/n): "
read -r CLEANUP_CHOICE
fi
if [[ "$CLEANUP_CHOICE" =~ ^[Yy]$ ]]; then
echo ""
echo "Cleaning up resources..."
echo "Deleting application with ID: $APP_ID"
echo "Executing: aws pinpoint delete-app --application-id $APP_ID"
DELETE_APP_OUTPUT=$(aws pinpoint delete-app --application-id "$APP_ID" 2>&1)
if check_error "$DELETE_APP_OUTPUT" "delete-app" "true"; then
echo "Application deleted successfully."
else
echo "Failed to delete application. You may need to delete it manually:"
echo "aws pinpoint delete-app --application-id $APP_ID"
fi
echo "Deleting message files..."
rm -f gcm-message.json apns-message.json
echo "Cleanup completed successfully."
echo "Log file ($LOG_FILE) has been preserved for reference."
else
echo ""
echo "Skipping cleanup. Resources will remain in your AWS account."
echo ""
echo "To manually delete the application later, run:"
echo "aws pinpoint delete-app --application-id $APP_ID"
echo ""
echo "To delete the message files, run:"
echo "rm -f gcm-message.json apns-message.json"
fi
echo ""
echo "==========================================="
echo "SCRIPT COMPLETED SUCCESSFULLY"
echo "==========================================="
echo "This script demonstrated:"
echo "1. Creating an AWS End User Messaging Push application"
echo "2. Attempting to enable FCM and APNS channels (with placeholder credentials)"
echo "3. Creating message templates for different platforms"
echo "4. Demonstrating message sending commands (with placeholder tokens)"
echo "5. Retrieving application details"
echo "6. Proper cleanup of resources"
echo ""
echo "For production use:"
echo "- Replace placeholder API keys with real FCM server keys"
echo "- Replace placeholder certificates with real APNS certificates"
echo "- Replace placeholder device tokens with real device tokens"
echo "- Implement proper error handling for your use case"
echo "- Consider using AWS IAM roles instead of long-term credentials"
echo ""
echo "Log file: $LOG_FILE"
echo "Script completed at: $(date)"
```
+ For API details, see the following topics in *AWS CLI Command Reference*.
+ [CreateApp](https://docs.aws.amazon.com/goto/aws-cli/pinpoint-2016-12-01/CreateApp)
+ [DeleteApp](https://docs.aws.amazon.com/goto/aws-cli/pinpoint-2016-12-01/DeleteApp)
+ [GetApp](https://docs.aws.amazon.com/goto/aws-cli/pinpoint-2016-12-01/GetApp)
+ [GetApps](https://docs.aws.amazon.com/goto/aws-cli/pinpoint-2016-12-01/GetApps)
+ [GetCallerIdentity](https://docs.aws.amazon.com/goto/aws-cli/sts-2011-06-15/GetCallerIdentity)
+ [SendMessages](https://docs.aws.amazon.com/goto/aws-cli/pinpoint-2016-12-01/SendMessages)
+ [UpdateApnsChannel](https://docs.aws.amazon.com/goto/aws-cli/pinpoint-2016-12-01/UpdateApnsChannel)
+ [UpdateGcmChannel](https://docs.aws.amazon.com/goto/aws-cli/pinpoint-2016-12-01/UpdateGcmChannel)
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Code examples for Amazon Pinpoint SMS and Voice API using AWS SDKs
The following code examples show how to use Amazon Pinpoint SMS and Voice API with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
**Contents**
+ [Basics](service_code_examples_pinpoint-sms-voice_basics.md)
+ [Actions](service_code_examples_pinpoint-sms-voice_actions.md)
+ [`CreateConfigurationSet`](pinpoint-sms-voice_example_pinpoint-sms-voice_CreateConfigurationSet_section.md)
+ [`CreateConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_CreateConfigurationSetEventDestination_section.md)
+ [`DeleteConfigurationSet`](pinpoint-sms-voice_example_pinpoint-sms-voice_DeleteConfigurationSet_section.md)
+ [`DeleteConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_DeleteConfigurationSetEventDestination_section.md)
+ [`GetConfigurationSetEventDestinations`](pinpoint-sms-voice_example_pinpoint-sms-voice_GetConfigurationSetEventDestinations_section.md)
+ [`ListConfigurationSets`](pinpoint-sms-voice_example_pinpoint-sms-voice_ListConfigurationSets_section.md)
+ [`SendVoiceMessage`](pinpoint-sms-voice_example_pinpoint-sms-voice_SendVoiceMessage_section.md)
+ [`UpdateConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_UpdateConfigurationSetEventDestination_section.md)
# Basic examples for Amazon Pinpoint SMS and Voice API using AWS SDKs
The following code examples show how to use the basics of Amazon Pinpoint SMS and Voice API with AWS SDKs.
**Contents**
+ [Actions](service_code_examples_pinpoint-sms-voice_actions.md)
+ [`CreateConfigurationSet`](pinpoint-sms-voice_example_pinpoint-sms-voice_CreateConfigurationSet_section.md)
+ [`CreateConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_CreateConfigurationSetEventDestination_section.md)
+ [`DeleteConfigurationSet`](pinpoint-sms-voice_example_pinpoint-sms-voice_DeleteConfigurationSet_section.md)
+ [`DeleteConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_DeleteConfigurationSetEventDestination_section.md)
+ [`GetConfigurationSetEventDestinations`](pinpoint-sms-voice_example_pinpoint-sms-voice_GetConfigurationSetEventDestinations_section.md)
+ [`ListConfigurationSets`](pinpoint-sms-voice_example_pinpoint-sms-voice_ListConfigurationSets_section.md)
+ [`SendVoiceMessage`](pinpoint-sms-voice_example_pinpoint-sms-voice_SendVoiceMessage_section.md)
+ [`UpdateConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_UpdateConfigurationSetEventDestination_section.md)
# Actions for Amazon Pinpoint SMS and Voice API using AWS SDKs
The following code examples demonstrate how to perform individual Amazon Pinpoint SMS and Voice API actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
The following examples include only the most commonly used actions. For a complete list, see the [Amazon Pinpoint SMS and Voice API API Reference](https://docs.aws.amazon.com/pinpoint-sms-voice/latest/APIReference/welcome.html).
**Topics**
+ [`CreateConfigurationSet`](pinpoint-sms-voice_example_pinpoint-sms-voice_CreateConfigurationSet_section.md)
+ [`CreateConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_CreateConfigurationSetEventDestination_section.md)
+ [`DeleteConfigurationSet`](pinpoint-sms-voice_example_pinpoint-sms-voice_DeleteConfigurationSet_section.md)
+ [`DeleteConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_DeleteConfigurationSetEventDestination_section.md)
+ [`GetConfigurationSetEventDestinations`](pinpoint-sms-voice_example_pinpoint-sms-voice_GetConfigurationSetEventDestinations_section.md)
+ [`ListConfigurationSets`](pinpoint-sms-voice_example_pinpoint-sms-voice_ListConfigurationSets_section.md)
+ [`SendVoiceMessage`](pinpoint-sms-voice_example_pinpoint-sms-voice_SendVoiceMessage_section.md)
+ [`UpdateConfigurationSetEventDestination`](pinpoint-sms-voice_example_pinpoint-sms-voice_UpdateConfigurationSetEventDestination_section.md)
# Use `CreateConfigurationSet` with an AWS SDK
The following code example shows how to use `CreateConfigurationSet`.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/pps#code-examples).
```
TRY.
" Create a new configuration set
lo_pps->createconfigurationset(
iv_configurationsetname = iv_configuration_set_name " e.g., 'my-config-set'
).
MESSAGE 'Configuration set created successfully.' TYPE 'I'.
CATCH /aws1/cx_ppsalreadyexistsex INTO DATA(lo_already_exists_ex).
MESSAGE lo_already_exists_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_already_exists_ex.
CATCH /aws1/cx_ppsbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_ppsinternalsvcerrorex INTO DATA(lo_internal_error_ex).
MESSAGE lo_internal_error_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_internal_error_ex.
CATCH /aws1/cx_ppslimitexceededex INTO DATA(lo_limit_exceeded_ex).
MESSAGE lo_limit_exceeded_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_limit_exceeded_ex.
CATCH /aws1/cx_ppstoomanyrequestsex INTO DATA(lo_too_many_requests_ex).
MESSAGE lo_too_many_requests_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many_requests_ex.
ENDTRY.
```
+ For API details, see [CreateConfigurationSet](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `CreateConfigurationSetEventDestination` with an AWS SDK
The following code example shows how to use `CreateConfigurationSetEventDestination`.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/pps#code-examples).
```
TRY.
" Create event destination for the configuration set
lo_pps->createconfseteventdst(
iv_configurationsetname = iv_configuration_set_name " e.g., 'my-config-set'
iv_eventdestinationname = iv_event_destination_name " e.g., 'my-event-dest'
io_eventdestination = io_event_destination
).
MESSAGE 'Event destination created successfully.' TYPE 'I'.
CATCH /aws1/cx_ppsalreadyexistsex INTO DATA(lo_already_exists_ex).
MESSAGE lo_already_exists_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_already_exists_ex.
CATCH /aws1/cx_ppsnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found_ex.
CATCH /aws1/cx_ppsbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_ppsinternalsvcerrorex INTO DATA(lo_internal_error_ex).
MESSAGE lo_internal_error_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_internal_error_ex.
CATCH /aws1/cx_ppslimitexceededex INTO DATA(lo_limit_exceeded_ex).
MESSAGE lo_limit_exceeded_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_limit_exceeded_ex.
CATCH /aws1/cx_ppstoomanyrequestsex INTO DATA(lo_too_many_requests_ex).
MESSAGE lo_too_many_requests_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many_requests_ex.
ENDTRY.
```
+ For API details, see [CreateConfigurationSetEventDestination](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `DeleteConfigurationSet` with an AWS SDK
The following code example shows how to use `DeleteConfigurationSet`.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/pps#code-examples).
```
TRY.
" Delete the configuration set
lo_pps->deleteconfigurationset(
iv_configurationsetname = iv_configuration_set_name " e.g., 'my-config-set'
).
MESSAGE 'Configuration set deleted successfully.' TYPE 'I'.
CATCH /aws1/cx_ppsnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found_ex.
CATCH /aws1/cx_ppsbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_ppsinternalsvcerrorex INTO DATA(lo_internal_error_ex).
MESSAGE lo_internal_error_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_internal_error_ex.
CATCH /aws1/cx_ppstoomanyrequestsex INTO DATA(lo_too_many_requests_ex).
MESSAGE lo_too_many_requests_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many_requests_ex.
ENDTRY.
```
+ For API details, see [DeleteConfigurationSet](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `DeleteConfigurationSetEventDestination` with an AWS SDK
The following code example shows how to use `DeleteConfigurationSetEventDestination`.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/pps#code-examples).
```
TRY.
" Delete the event destination
lo_pps->deleteconfseteventdst(
iv_configurationsetname = iv_configuration_set_name " e.g., 'my-config-set'
iv_eventdestinationname = iv_event_destination_name " e.g., 'my-event-dest'
).
MESSAGE 'Event destination deleted successfully.' TYPE 'I'.
CATCH /aws1/cx_ppsnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found_ex.
CATCH /aws1/cx_ppsbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_ppsinternalsvcerrorex INTO DATA(lo_internal_error_ex).
MESSAGE lo_internal_error_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_internal_error_ex.
CATCH /aws1/cx_ppstoomanyrequestsex INTO DATA(lo_too_many_requests_ex).
MESSAGE lo_too_many_requests_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many_requests_ex.
ENDTRY.
```
+ For API details, see [DeleteConfigurationSetEventDestination](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `GetConfigurationSetEventDestinations` with an AWS SDK
The following code example shows how to use `GetConfigurationSetEventDestinations`.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/pps#code-examples).
```
TRY.
" Get event destinations for the configuration set
oo_result = lo_pps->getconfseteventdestinations(
iv_configurationsetname = iv_configuration_set_name " e.g., 'my-config-set'
).
" Process the event destinations
LOOP AT oo_result->get_eventdestinations( ) INTO DATA(lo_event_dest).
DATA(lv_dest_name) = lo_event_dest->get_name( ).
DATA(lv_enabled) = lo_event_dest->get_enabled( ).
MESSAGE |Event destination: { lv_dest_name }, Enabled: { lv_enabled }| TYPE 'I'.
" Check for CloudWatch Logs destination
DATA(lo_cloudwatch_dest) = lo_event_dest->get_cloudwatchlogsdst( ).
IF lo_cloudwatch_dest IS NOT INITIAL.
DATA(lv_log_group_arn) = lo_cloudwatch_dest->get_loggrouparn( ).
MESSAGE | CloudWatch Logs destination: { lv_log_group_arn }| TYPE 'I'.
ENDIF.
" Check for Kinesis Firehose destination
DATA(lo_firehose_dest) = lo_event_dest->get_kinesisfirehosedst( ).
IF lo_firehose_dest IS NOT INITIAL.
DATA(lv_delivery_stream) = lo_firehose_dest->get_deliverystreamarn( ).
MESSAGE | Kinesis Firehose destination: { lv_delivery_stream }| TYPE 'I'.
ENDIF.
" Check for SNS destination
DATA(lo_sns_dest) = lo_event_dest->get_snsdestination( ).
IF lo_sns_dest IS NOT INITIAL.
DATA(lv_topic_arn) = lo_sns_dest->get_topicarn( ).
MESSAGE | SNS destination: { lv_topic_arn }| TYPE 'I'.
ENDIF.
ENDLOOP.
CATCH /aws1/cx_ppsnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found_ex.
CATCH /aws1/cx_ppsbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_ppsinternalsvcerrorex INTO DATA(lo_internal_error_ex).
MESSAGE lo_internal_error_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_internal_error_ex.
CATCH /aws1/cx_ppstoomanyrequestsex INTO DATA(lo_too_many_requests_ex).
MESSAGE lo_too_many_requests_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many_requests_ex.
ENDTRY.
```
+ For API details, see [GetConfigurationSetEventDestinations](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `ListConfigurationSets` with an AWS SDK
The following code example shows how to use `ListConfigurationSets`.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/pps#code-examples).
```
TRY.
" List all configuration sets
oo_result = lo_pps->listconfigurationsets(
iv_nexttoken = iv_next_token " Optional: Token for pagination
iv_pagesize = iv_page_size " Optional: Number of results per page, e.g., '10'
).
" Process the configuration sets
LOOP AT oo_result->get_configurationsets( ) INTO DATA(lo_config_set).
DATA(lv_config_set_name) = lo_config_set->get_value( ).
MESSAGE |Configuration set: { lv_config_set_name }| TYPE 'I'.
ENDLOOP.
" Check if there are more results
DATA(lv_next_token) = oo_result->get_nexttoken( ).
IF lv_next_token IS NOT INITIAL.
MESSAGE |More results available. Next token: { lv_next_token }| TYPE 'I'.
ENDIF.
CATCH /aws1/cx_ppsbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_ppsinternalsvcerrorex INTO DATA(lo_internal_error_ex).
MESSAGE lo_internal_error_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_internal_error_ex.
CATCH /aws1/cx_ppstoomanyrequestsex INTO DATA(lo_too_many_requests_ex).
MESSAGE lo_too_many_requests_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many_requests_ex.
ENDTRY.
```
+ For API details, see [ListConfigurationSets](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `SendVoiceMessage` with an AWS SDK
The following code examples show how to use `SendVoiceMessage`.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/pinpoint#code-examples).
```
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.pinpointsmsvoice.PinpointSmsVoiceClient;
import software.amazon.awssdk.services.pinpointsmsvoice.model.SSMLMessageType;
import software.amazon.awssdk.services.pinpointsmsvoice.model.VoiceMessageContent;
import software.amazon.awssdk.services.pinpointsmsvoice.model.SendVoiceMessageRequest;
import software.amazon.awssdk.services.pinpointsmsvoice.model.PinpointSmsVoiceException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class SendVoiceMessage {
// The Amazon Polly voice that you want to use to send the message. For a list
// of voices, see https://docs.aws.amazon.com/polly/latest/dg/voicelist.html
static final String voiceName = "Matthew";
// The language to use when sending the message. For a list of supported
// languages, see
// https://docs.aws.amazon.com/polly/latest/dg/SupportedLanguage.html
static final String languageCode = "en-US";
// The content of the message. This example uses SSML to customize and control
// certain aspects of the message, such as by adding pauses and changing
// phonation. The message can't contain any line breaks.
static final String ssmlMessage = "This is a test message sent from "
+ "Amazon Pinpoint "
+ "using the AWS "
+ "SDK for Java. "
+ "Thank "
+ "you for listening.";
public static void main(String[] args) {
final String usage = """
Usage: \s
Where:
originationNumber - The phone number or short code that you specify has to be associated with your Amazon Pinpoint account. For best results, specify long codes in E.164 format (for example, +1-555-555-5654).
destinationNumber - The recipient's phone number. For best results, you should specify the phone number in E.164 format (for example, +1-555-555-5654).\s
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String originationNumber = args[0];
String destinationNumber = args[1];
System.out.println("Sending a voice message");
// Set the content type to application/json.
List listVal = new ArrayList<>();
listVal.add("application/json");
Map> values = new HashMap<>();
values.put("Content-Type", listVal);
ClientOverrideConfiguration config2 = ClientOverrideConfiguration.builder()
.headers(values)
.build();
PinpointSmsVoiceClient client = PinpointSmsVoiceClient.builder()
.overrideConfiguration(config2)
.region(Region.US_EAST_1)
.build();
sendVoiceMsg(client, originationNumber, destinationNumber);
client.close();
}
public static void sendVoiceMsg(PinpointSmsVoiceClient client, String originationNumber,
String destinationNumber) {
try {
SSMLMessageType ssmlMessageType = SSMLMessageType.builder()
.languageCode(languageCode)
.text(ssmlMessage)
.voiceId(voiceName)
.build();
VoiceMessageContent content = VoiceMessageContent.builder()
.ssmlMessage(ssmlMessageType)
.build();
SendVoiceMessageRequest voiceMessageRequest = SendVoiceMessageRequest.builder()
.destinationPhoneNumber(destinationNumber)
.originationPhoneNumber(originationNumber)
.content(content)
.build();
client.sendVoiceMessage(voiceMessageRequest);
System.out.println("The message was sent successfully.");
} catch (PinpointSmsVoiceException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [SendVoiceMessage](https://docs.aws.amazon.com/goto/SdkForJavaV2/pinpoint-sms-voice-2018-09-05/SendVoiceMessage) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v2)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascript/example_code/pinpoint-sms-voice#code-examples).
```
"use strict";
var AWS = require("aws-sdk");
// The AWS Region that you want to use to send the voice message. For a list of
// AWS Regions where the Amazon Pinpoint SMS and Voice API is available, see
// https://docs.aws.amazon.com/pinpoint-sms-voice/latest/APIReference/
var aws_region = "us-east-1";
// The phone number that the message is sent from. The phone number that you
// specify has to be associated with your Amazon Pinpoint account. For best results, you
// should specify the phone number in E.164 format.
var originationNumber = "+12065550110";
// The recipient's phone number. For best results, you should specify the phone
// number in E.164 format.
var destinationNumber = "+12065550142";
// The language to use when sending the message. For a list of supported
// languages, see https://docs.aws.amazon.com/polly/latest/dg/SupportedLanguage.html
var languageCode = "en-US";
// The Amazon Polly voice that you want to use to send the message. For a list
// of voices, see https://docs.aws.amazon.com/polly/latest/dg/voicelist.html
var voiceId = "Matthew";
// The content of the message. This example uses SSML to customize and control
// certain aspects of the message, such as the volume or the speech rate.
// The message can't contain any line breaks.
var ssmlMessage =
"" +
"This is a test message sent from Amazon Pinpoint " +
"using the AWS SDK for JavaScript in Node.js. " +
"Thank you for listening." +
"" +
"";
// The phone number that you want to appear on the recipient's device. The phone
// number that you specify has to be associated with your Amazon Pinpoint account.
var callerId = "+12065550199";
// The configuration set that you want to use to send the message.
var configurationSet = "ConfigSet";
// Specify that you're using a shared credentials file, and optionally specify
// the profile that you want to use.
var credentials = new AWS.SharedIniFileCredentials({ profile: "default" });
AWS.config.credentials = credentials;
// Specify the region.
AWS.config.update({ region: aws_region });
//Create a new Pinpoint object.
var pinpointsmsvoice = new AWS.PinpointSMSVoice();
var params = {
CallerId: callerId,
ConfigurationSetName: configurationSet,
Content: {
SSMLMessage: {
LanguageCode: languageCode,
Text: ssmlMessage,
VoiceId: voiceId,
},
},
DestinationPhoneNumber: destinationNumber,
OriginationPhoneNumber: originationNumber,
};
//Try to send the message.
pinpointsmsvoice.sendVoiceMessage(params, function (err, data) {
// If something goes wrong, print an error message.
if (err) {
console.log(err.message);
// Otherwise, show the unique ID for the message.
} else {
console.log("Message sent! Message ID: " + data["MessageId"]);
}
});
```
+ For API details, see [SendVoiceMessage](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/pinpoint-sms-voice-2018-09-05/SendVoiceMessage) in *AWS SDK for JavaScript API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/pinpoint-sms-voice#code-examples).
```
import logging
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
def send_voice_message(
sms_voice_client,
origination_number,
caller_id,
destination_number,
language_code,
voice_id,
ssml_message,
):
"""
Sends a voice message using speech synthesis provided by Amazon Polly.
:param sms_voice_client: A Boto3 PinpointSMSVoice client.
:param origination_number: The phone number that the message is sent from.
The phone number must be associated with your Amazon
Pinpoint account and be in E.164 format.
:param caller_id: The phone number that you want to appear on the recipient's
device. The phone number must be associated with your Amazon
Pinpoint account and be in E.164 format.
:param destination_number: The recipient's phone number. Specify the phone
number in E.164 format.
:param language_code: The language to use when sending the message.
:param voice_id: The Amazon Polly voice that you want to use to send the message.
:param ssml_message: The content of the message. This example uses SSML to control
certain aspects of the message, such as the volume and the
speech rate. The message must not contain line breaks.
:return: The ID of the message.
"""
try:
response = sms_voice_client.send_voice_message(
DestinationPhoneNumber=destination_number,
OriginationPhoneNumber=origination_number,
CallerId=caller_id,
Content={
"SSMLMessage": {
"LanguageCode": language_code,
"VoiceId": voice_id,
"Text": ssml_message,
}
},
)
except ClientError:
logger.exception(
"Couldn't send message from %s to %s.",
origination_number,
destination_number,
)
raise
else:
return response["MessageId"]
def main():
origination_number = "+12065550110"
caller_id = "+12065550199"
destination_number = "+12065550142"
language_code = "en-US"
voice_id = "Matthew"
ssml_message = (
""
"This is a test message sent from Amazon Pinpoint "
"using the AWS SDK for Python (Boto3). "
"Thank you for listening."
""
""
)
print(f"Sending voice message from {origination_number} to {destination_number}.")
message_id = send_voice_message(
boto3.client("pinpoint-sms-voice"),
origination_number,
caller_id,
destination_number,
language_code,
voice_id,
ssml_message,
)
print(f"Message sent!\nMessage ID: {message_id}")
if __name__ == "__main__":
main()
```
+ For API details, see [SendVoiceMessage](https://docs.aws.amazon.com/goto/boto3/pinpoint-sms-voice-2018-09-05/SendVoiceMessage) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/pps#code-examples).
```
TRY.
" Create SSML message type object with voice parameters
DATA(lo_ssml_message) = NEW /aws1/cl_ppsssmlmessagetype(
iv_languagecode = iv_language_code " e.g., 'en-US'
iv_voiceid = iv_voice_id " e.g., 'Matthew'
iv_text = iv_ssml_message " SSML formatted message text
).
" Create voice message content with the SSML message
DATA(lo_content) = NEW /aws1/cl_ppsvoicemessagecont(
io_ssmlmessage = lo_ssml_message
).
" Send the voice message
DATA(lo_result) = lo_pps->sendvoicemessage(
iv_originationphonenumber = iv_origination_number " e.g., '+12065550110'
iv_callerid = iv_caller_id " e.g., '+12065550199'
iv_destinationphonenumber = iv_destination_number " e.g., '+12065550142'
io_content = lo_content
).
" Retrieve the message ID from the response
ov_message_id = lo_result->get_messageid( ).
MESSAGE 'Voice message sent successfully.' TYPE 'I'.
CATCH /aws1/cx_ppsbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_ppsinternalsvcerrorex INTO DATA(lo_internal_error_ex).
MESSAGE lo_internal_error_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_internal_error_ex.
CATCH /aws1/cx_ppstoomanyrequestsex INTO DATA(lo_too_many_requests_ex).
MESSAGE lo_too_many_requests_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many_requests_ex.
ENDTRY.
```
+ For API details, see [SendVoiceMessage](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.
# Use `UpdateConfigurationSetEventDestination` with an AWS SDK
The following code example shows how to use `UpdateConfigurationSetEventDestination`.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/pps#code-examples).
```
TRY.
" Update the event destination
lo_pps->updateconfseteventdst(
iv_configurationsetname = iv_configuration_set_name " e.g., 'my-config-set'
iv_eventdestinationname = iv_event_destination_name " e.g., 'my-event-dest'
io_eventdestination = io_event_destination
).
MESSAGE 'Event destination updated successfully.' TYPE 'I'.
CATCH /aws1/cx_ppsnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_not_found_ex.
CATCH /aws1/cx_ppsbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_ppsinternalsvcerrorex INTO DATA(lo_internal_error_ex).
MESSAGE lo_internal_error_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_internal_error_ex.
CATCH /aws1/cx_ppstoomanyrequestsex INTO DATA(lo_too_many_requests_ex).
MESSAGE lo_too_many_requests_ex->get_text( ) TYPE 'I'.
RAISE EXCEPTION lo_too_many_requests_ex.
ENDTRY.
```
+ For API details, see [UpdateConfigurationSetEventDestination](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
For a complete list of AWS SDK developer guides and code examples, see [Using Amazon Pinpoint with an AWS SDK](sdk-general-information-section.md). This topic also includes information about getting started and details about previous SDK versions.