Adapter - Amazon PinpointSMS
This page describes version 2.0.7 of the adapter.
Overview
This adapter uses the Amazon Pinpoint Service API (Amazon Pinpoint) and SQS Service API (Amazon SQS) to send 2way SMS messages from the Integration platform. This adapter also supports sending SMS text to voice messages to remote clients.
A valid AWS account is needed to use this adapter. Please, refer to Amazon's Documentation for help configuring pinpoint and setting up an SQS queue.
Configuration
All of the Amazon adapters, require a region, accessKey and secretKey. The regions list can be found in Amazon's documentation. The accessKey and secretKey are accessed by logging in to your amazon account.
Accessing Secret Key
The secretKey can only be accessed once, directly after the accessKey and secretKey are generated.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| pinpointRegion | AWS Pinpoint Region | True | The Amazon (AWS) region to run Pinpoint commands. | string | us-east-1 | 1024 | 1 | ||
| queueRegion | AWS SQS Region | True | The Amazon (AWS) region where SQS is configured. | string | us-east-1 | 1024 | 1 | ||
| accessKey | Access Key | True | The Amazon account's Access Key. | password | 1024 | 1 | |||
| secretKey | Secret Key | True | The Amazon account's Secret Key. | password | 1024 | 1 | |||
| queueUrl | Queue URL | True | The Amazon SQS queue URL. | string | 1024 | 1 |
Commands
Send SMS Message (sendSmsMessage)
Sends a 2-way SMS message to an SMS capable device.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| projectId | Project ID | The AWS Pinpoint project ID to use when sending an SMS message. | True | string |
| originationNumber | Origination Number | The phone number or short code to send the message from. (E.164 format) | False | string |
| destinationNumber | Destination Number | The recipient's phone number. (E.164 format) | True | string |
| message | Text Message | The content of the message. | True | string |
| messageType | Message Type | The type of 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. | True | string |
| registeredKeyword | Registered Keyword | The registered keyword associated with the originating short code. | False | string |
| senderId | Sender ID | The sender ID to use when sending the message. Support for sender ID varies by country or region. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| messageResponse | The Response. | string |
Send SMS Voice Message (sendSmsVoiceMessage)
Sends an SMS Voice message to an SMS capable device.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| originationNumber | Origination Number | The phone number or short code to send the message from. (E.164 format) | True | string |
| destinationNumber | Destination Number | The recipient's phone number. (E.164 format) | True | string |
| message | Text Message | The content of the message. | True | string |
| voiceName | Voice Name | The Amazon Polly voice that you want to use to send the message. | True | string |
| languageCode | Language Code | The language to use when sending the message. | False | string |
| callerId | Caller ID | he phone number that you want to appear on the recipient's device. | False | string |
Events
SMS Message Received (twoWaySmsMessageReceived)
A Two Way SMS message was received from a mobile endpoint.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| originationNumber | Origination Number | The phone number or short code to send the message from. | string |
| destinationNumber | Destination Number | The recipient's phone number. | string |
| messageKeyword | Message Keyword | The registered keyword associated with the originating short code. | string |
| message | Message Text | The content of the SMS message. | string |
| inboundMessageId | Inbound Message ID | The inbound message identifier. | string |
| previousPublishedMessageId | Previous Published Message ID | The previously published message ID. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.7 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |