This email was sent using the " + "\n Amazon Pinpoint API " + "\n using the AWS SDK for .NET" + "\n
" + "\n" + "\n"; // The character encoding the you want to use for the subject line and // message body of the email. string charset = "UTF-8"; var sendRequest = new SendMessagesRequest { ApplicationId = appId, MessageRequest = new MessageRequest { Addresses = new DictionaryThis 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"] ); } }); ``` ------ #### [ Python ] Utilice este ejemplo para enviar un correo electrónico mediante [AWS SDK para Python (Boto3)](https://aws.amazon.com/sdk-for-python/). En este ejemplo se presupone que ya ha instalado y configurado el SDK para Python (Boto3). Para obtener más información, consulte [Quickstart](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html) en la *Referencia de la API del AWS SDK para Python (Boto3)*. ``` 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 = """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() ``` También puede usar plantillas de mensajes para enviar mensajes de correo electrónico, como se muestra en el siguiente ejemplo: ``` 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() ``` En estos ejemplos se supone que está utilizando un archivo de credenciales compartidas para especificar la clave de acceso y la clave de acceso secreta para un usuario existente. Para obtener más información, consulte [Credenciales](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html) en la *Referencia de la API del AWS SDK para Python (Boto3)*. ------ # Agregar encabezados de cancelación de suscripción al correo electrónico mediante Amazon Pinpoint **nota** Antes de poder usar encabezados de correo electrónico, debe configurar un rol de envío de orquestación de correo electrónico si va a enviar correos electrónicos desde una campaña o un recorrido. Para correos electrónicos de envío directo, debe tener permisos para `ses:SendEmail` y `ses:SendRawEmail`. Para obtener más información, consulte [Creating an email orchestration sending role](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-orchestration-sending-role.html) en la [Guía del usuario de Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/). Incluir un enlace para cancelar la suscripción en el correo electrónico es una práctica recomendada y, en algunos países, es un requisito legal. Para agregar un enlace para cancelar la suscripción con un solo clic, añada los siguientes encabezados: 1. Establezca el **Nombre** del encabezado como `List-Unsubscribe` y en **Valor** ingrese el enlace para cancelar la suscripción. El enlace debe admitir solicitudes HTTP POST para procesar la solicitud de cancelación de suscripción de los destinatarios. 1. Establezca el **nombre** del encabezado como `List-Unsubscribe-Post` y **el valor** en `List-Unsubscribe=One-Click`. Puede agregar hasta 15 encabezados a un mensaje de correo electrónico. Para obtener una lista de los encabezados compatibles, consulte [Amazon SES header fields](https://docs.aws.amazon.com/ses/latest/dg/header-fields.html) en la [Guía para desarrolladores de Amazon Simple Email Service](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). En el siguiente ejemplo se muestra cómo enviar un mensaje de correo electrónico con encabezados de cancelación de suscripción mediante la AWS Command Line Interface. Para obtener más información sobre la configuración de AWS CLI, consulte [Configurar el AWS CLI en la](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) [Guía del AWS Command Line Interface usuario](https://docs.aws.amazon.com/cli/latest/userguide/). En el siguiente comando, haga esto: + *AppId*Sustitúyalo por el identificador de la aplicación. + *richard\$1roe@example.com*Sustitúyalo por la dirección de correo electrónico del destinatario. + *https://example.com/unsub*Sustitúyelo por el enlace para cancelar la suscripción. + *example123456*Sustitúyalo por un identificador único para el destinatario. ``` aws pinpoint send-messages --application-id AppId --message-request '{ "Addresses": { "richard_roe@example.com": { "ChannelType": "EMAIL" } }, "MessageConfiguration": { "EmailMessage": { "Substitutions": { "url": [ "https://example.com/unsub" ], "id1": [ "/example123456" ] }, "SimpleEmail": { "TextPart": { "Data": "Sample email message with an subscribe header", "Charset": "UTF-8" }, "Subject": { "Data": "Hello", "Charset": "UTF-8" }, "Headers": [ { "Name": "List-Unsubscribe", "Value": "{{url}}{{id1}}" }, { "Name": "List-Unsubscribe-Post", "Value": "List-Unsubscribe=One-Click" } ] } } } }' ``` # Envío de mensajes SMS transaccionales mediante Amazon Pinpoint Puede utilizar la API de Amazon Pinpoint para enviar mensajes SMS (mensajes de texto) a determinados números de teléfono o ID de punto de conexión. En esta sección se incluyen ejemplos de código completos que puede utilizar para enviar mensajes SMS a través de la API de Amazon Pinpoint mediante un AWS SDK. Su cuenta debe estar en producción y usted debe tener una identidad de origen activa que pueda enviar mensajes SMS. Para obtener más ejemplos de código sobre puntos de conexión, segmentos y canales, consulte [Ejemplos de código](https://docs.aws.amazon.com/pinpoint/latest/developerguide/service_code_examples.html). ------ #### [ C\$1 ] Utilice este ejemplo para enviar un mensaje SMS mediante el [AWS SDK para .NET](https://aws.amazon.com/sdk-for-net/). En este ejemplo se presupone que ya ha instalado y configurado el SDK para .NET. Para obtener más información, consulte [Introducción](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/net-dg-config.html) en la *Guía para desarrolladores de AWS SDK para .NET*. En este ejemplo se supone que está utilizando un archivo de credenciales compartidas para especificar la clave de acceso y la clave de acceso secreta para un usuario de IAM existente. Para obtener más información, consulte [Configuración de credenciales de AWS](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/creds-idc.html) en la *Guía para desarrolladores de AWS SDK para .NET*. ``` using Amazon; using Amazon.Pinpoint; using Amazon.Pinpoint.Model; using Microsoft.Extensions.Configuration; namespace SendSmsMessage; public class SendSmsMessageMainClass { public static async Task Main(string[] args) { var configuration = new ConfigurationBuilder() .SetBasePath(Directory.GetCurrentDirectory()) .AddJsonFile("settings.json") // Load test settings from .json file. .AddJsonFile("settings.local.json", true) // Optionally load local settings. .Build(); // 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/ string 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. string originationNumber = configuration["OriginationNumber"]!; // The recipient's phone number. For best results, you should specify the // phone number in E.164 format. string destinationNumber = configuration["DestinationNumber"]!; // The 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. string appId = configuration["AppId"]!; // 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. MessageType messageType = MessageType.TRANSACTIONAL; // The registered keyword associated with the originating short code. string? registeredKeyword = configuration["RegisteredKeyword"]; // 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 string? senderId = configuration["SenderId"]; try { var response = await SendSmsMessage(region, appId, destinationNumber, originationNumber, registeredKeyword, senderId, messageType); Console.WriteLine($"Message sent to {response.MessageResponse.Result.Count} recipient(s)."); foreach (var messageResultValue in response.MessageResponse.Result.Select(r => r.Value)) { Console.WriteLine($"{messageResultValue.MessageId} Status: {messageResultValue.DeliveryStatus}"); } } catch (Exception ex) { Console.WriteLine("The message wasn't sent. Error message: " + ex.Message); } } public static async Task* 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 = "