Amazon Pinpoint SMS and Voice

(1)

Amazon Pinpoint SMS and Voice

REST API Reference

(2)

Amazon Pinpoint SMS and Voice: REST API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

Welcome to the Amazon Pinpoint SMS and Voice API Reference. This guide provides information about Amazon Pinpoint SMS and Voice API resources, including supported HTTP methods, parameters, and schemas.

Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send SMS text messages and voice messages, in addition to push notiﬁcations and email. The Amazon Pinpoint SMS and Voice API provides programmatic access to options that are unique to the SMS and voice channels and supplement the resources provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, you might ﬁnd it helpful to also review the Amazon Pinpoint

Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides

information about key topics such as Amazon Pinpoint integration with other AWS services and the quotas that apply to using the service.

Regional Availability

The Amazon Pinpoint SMS and Voice API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.

(5)

Conﬁguration Set

Resources

The Amazon Pinpoint SMS and Voice REST API includes the following resources.

Topics

• Conﬁguration Set (p. 2)

• Conﬁguration Sets (p. 5)

• Event Destination (p. 10)

• Event Destinations (p. 18)

• Voice Message (p. 28)

Conﬁguration Set

A configuration set is a set of rules that you apply to the voice messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice messages. For example, when a message is successfully delivered, you can log that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

When you send a voice message, you have to specify one (and only one) conﬁguration set.

URI

/v1/sms-voice/configuration-sets/ConfigurationSetName

HTTP methods

DELETE

Operation ID: DeleteConfigurationSet Deletes an existing conﬁguration set.

Path parameters

Name Type Required Description

ConfigurationSetNameString True The name of the conﬁguration set that you want to delete.

Responses

Status code Response model Description

200 DeleteConfigurationSetResponse (p. 3)An empty object that indicates that the conﬁguration set was deleted successfully.

400 BadRequestException (p. 3)The request contained syntax that the API couldn't interpret.

Modify the request and try again.

(6)

Schemas

404 NotFoundException (p. 3) The requested resource wasn't found.

429 TooManyRequestsException (p. 3)You've issued too many requests to the resource. Wait a few minutes, and then try again.

500 InternalServiceErrorException (p. 4)The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

OPTIONS

Responses

200 None 200 response

Schemas

Response bodies

DeleteConﬁgurationSetResponse schema

{}

BadRequestException schema

{ "Message": "string"

}

NotFoundException schema

}

TooManyRequestsException schema

{

"Message": "string"

}

(7)

Properties

InternalServiceErrorException schema

}

Properties

BadRequestException

The input that you provided to the API is invalid.

Message

A description of the error that the API encountered.

Type: string Required: False

DeleteConﬁgurationSetResponse

An empty object that indicates that the conﬁguration set was deleted successfully.

InternalServiceErrorException

This error occurs when there is an unexpected issue with the Amazon Pinpoint SMS and Voice API service.

Message

NotFoundException

The resource you attempted to access doesn't exist.

Message

TooManyRequestsException

Message

(8)

See also

DeleteConﬁgurationSet

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

Conﬁguration Sets

A configuration set is a set of rules that you apply to the voice messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice messages. For example, when a message is successfully delivered, you can log that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

When you send a voice message, you have to specify one (and only one) conﬁguration set.

URI

/v1/sms-voice/configuration-sets

HTTP methods

GET

Operation ID: ListConfigurationSets

Retrieves a list of conﬁguration sets that are associated with your account in the current AWS Region.

Query parameters

PageSize String False Used to specify the

number of items that should be returned in the response.

NextToken String False A token returned from

a previous call to the API that indicates the position in the list of results.

(9)

HTTP methods

Responses

200 ListConfigurationSetsResponse (p. 7)An object that contains information about the conﬁguration sets for your account in the current AWS Region.

POST

Operation ID: CreateConfigurationSet

Creates a new conﬁguration set. After you create the conﬁguration set, you can add one or more event destinations to it.

Responses

200 CreateConfigurationSetResponse (p. 7)An empty object that indicates that the conﬁguration set was successfully created.

409 AlreadyExistsException (p. 8)The resource you tried to create already exists.

412 LimitExceededException (p. 8)You've tried to create a number of resources that exceeds the maximum number of resources for your account. For more information, see Amazon Pinpoint Quotas in the Amazon Pinpoint Developer Guide.

(10)

Schemas

OPTIONS

Responses

200 None Indicates that the API

successfully received the request.

Schemas

Request bodies

POST schema

{

"ConfigurationSetName": "string"

}

Response bodies

ListConﬁgurationSetsResponse schema

{ "NextToken": "string", "ConfigurationSets": [ "string"

]}

CreateConﬁgurationSetResponse schema

{}

BadRequestException schema

{

"Message": "string"

}

(11)

Properties

AlreadyExistsException schema

}

LimitExceededException schema

{

"Message": "string"

}

TooManyRequestsException schema

}

InternalServiceErrorException schema

}

Properties

AlreadyExistsException

The resource that you speciﬁed in your request already exists.

Message

BadRequestException

Message

CreateConﬁgurationSetRequest

A request to create a new conﬁguration set.

(12)

Properties

ConﬁgurationSetName

The name that you want to give the conﬁguration set.

Type: string Required: True

CreateConﬁgurationSetResponse

An empty object that indicates that the conﬁguration set was successfully created.

InternalServiceErrorException

Message

LimitExceededException

There are too many instances of the speciﬁed resource type.

Message

ListConﬁgurationSetsResponse

An object that contains information about conﬁguration sets.

NextToken

A token returned from a previous call to ListConﬁgurationSets to indicate the position in the list of conﬁguration sets.

ConﬁgurationSets

An object that contains a list of conﬁguration sets for your account in the current AWS Region.

Type: Array of type string Required: False

TooManyRequestsException

(13)

See also

Message

ListConﬁgurationSets

• AWS SDK for C++

• AWS SDK for Go

CreateConﬁgurationSet

• AWS SDK for C++

• AWS SDK for Go

Event Destination

A configuration set is a set of rules that you apply to the voice messages that you send. In a configuration set, you can specify an event destination for specific types of events related to voice messages. An event destination is a location that you publish information about your voice calls to. For example, when a message is successfully delivered, you can log that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

Each conﬁguration set can contain between 0 and 10 event destinations. Each event destination can contain a reference to one (and only one) destination, such as an Amazon CloudWatch log or Amazon Kinesis Data Firehose destination.

(14)

URI

/v1/sms-voice/configuration-sets/ConfigurationSetName/eventdestinations/EventDestinationName

HTTP methods

PUT

Operation ID: UpdateConfigurationSetEventDestination Updates an event destination in a conﬁguration set.

Path parameters

EventDestinationNameString True The name of the event destination that you want to update.

ConfigurationSetNameString True The name of the conﬁguration set that contains the event destination that you want to update.

Responses

200 UpdateConfigurationSetEventDestinationResponse (p. 13)An empty object that indicates that the event destination was updated successfully.

429 TooManyRequestsException (p. 13)You've made too many PUT requests in one second. Requests are limited to 1 per second.

DELETE

Operation ID: DeleteConfigurationSetEventDestination

(15)

Schemas

Deletes an event destination from a conﬁguration set.

Path parameters

EventDestinationNameString True The name of the event destination that you want to delete.

ConfigurationSetNameString True The name of the conﬁguration set that you want to delete.

Responses

200 DeleteConfigurationSetEventDestinationResponse (p. 13)An empty object that indicates that the event destination was deleted successfully.

429 TooManyRequestsException (p. 13)You've made too many DELETE requests in one second. Requests are limited to 1 per second.

OPTIONS

Responses

Schemas

Request bodies

PUT schema

{

(16)

Schemas

"EventDestination": { "SnsDestination": { "TopicArn": "string"

},

"Enabled": boolean, "MatchingEventTypes": [ enum

],

"CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string"

},

"KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string"

} }}

Response bodies

UpdateConﬁgurationSetEventDestinationResponse schema

{}

DeleteConﬁgurationSetEventDestinationResponse schema

{}

BadRequestException schema

}

NotFoundException schema

}

TooManyRequestsException schema

{

"Message": "string"

}

InternalServiceErrorException schema

(17)

Properties

}

Properties

BadRequestException

Message

CloudWatchLogsDestination

An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.

IamRoleArn

The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.

LogGroupArn

The name of the Amazon CloudWatch Log Group that you want to record events in.

DeleteConﬁgurationSetEventDestinationResponse

An empty object that indicates that the event destination was deleted successfully.

EventDestinationDeﬁnition

An object that deﬁnes a single event destination.

SnsDestination

An object that contains information about an event destination that sends data to Amazon SNS.

Type: SnsDestination (p. 16) Required: False

Enabled

Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the speciﬁed event destination.

(18)

Properties

Type: boolean Required: False

MatchingEventTypes

The types of events that you want to send to the event destination. Possible values:

• INITIATED_CALL - Amazon Pinpoint started trying to deliver the message to the recipient.

• RINGING - Amazon Pinpoint initiated the phone call, and the recipient's phone is ringing.

• ANSWERED - Amazon Pinpoint established a connection with the recipient.

Note

This status doesn't necessarily mean that Amazon Pinpoint made a connection with a human recipient. For example, it could indicate that Amazon Pinpoint established a connection with a voicemail system.

• COMPLETED_CALL - Amazon Pinpoint played the audio message to the recipient.

Note

This status doesn't necessarily mean that the message was delivered to a human recipient. For example, it could indicate that the audio message was delivered to a voicemail system.

• BUSY - Amazon Pinpoint attempted to deliver the voice message, but received a busy signal.

• FAILED - Amazon Pinpoint wasn't able to deliver the message.

• NO_ANSWER - Amazon Pinpoint attempted to deliver the message, but the recipient didn't answer.

Type: Array of type EventType (p. 15) Required: True

CloudWatchLogsDestination

Type: CloudWatchLogsDestination (p. 14) Required: False

KinesisFirehoseDestination

An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.

Type: KinesisFirehoseDestination (p. 16) Required: False

EventType

The types of events that are sent to the event destination. Possible values are:

INITIATED_CALL RINGING

ANSWERED COMPLETED_CALL BUSYFAILED

NO_ANSWER

(19)

Properties

InternalServiceErrorException

Message

KinesisFirehoseDestination

DeliveryStreamArn

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination.

IamRoleArn

The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream.

NotFoundException

Message

SnsDestination

TopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

(20)

See also

TooManyRequestsException

Message

UpdateConﬁgurationSetEventDestinationRequest

An object that deﬁnes a request to update an existing event destination.

EventDestination

Type: EventDestinationDeﬁnition (p. 14) Required: True

UpdateConﬁgurationSetEventDestinationResponse

An empty object that indicates that the event destination was updated successfully.

UpdateConﬁgurationSetEventDestination

• AWS SDK for C++

• AWS SDK for Go

DeleteConﬁgurationSetEventDestination

• AWS SDK for C++

• AWS SDK for Go

(21)

Event Destinations

An event destination is a location where you send response information about the voice messages that you send. For example, when a voice message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination.

Each conﬁguration set can contain between 0 and 10 event destinations. Each event destination can contain a reference to one (and only one) destination, such as an Amazon CloudWatch log or Amazon Kinesis Data Firehose destination.

URI

/v1/sms-voice/configuration-sets/ConfigurationSetName/event-destinations

HTTP methods

GET

Operation ID: GetConfigurationSetEventDestinations

Retrieves information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

Path parameters

ConfigurationSetNameString True The name of the conﬁguration set that contains the event destination that you want to obtain information about.

Responses

200 GetConfigurationSetEventDestinationsResponse (p. 20)An object that contains information about an event destination.

(22)

HTTP methods

429 TooManyRequestsException (p. 21)You've made too many GET requests in one second. Requests are limited to 1 per second.

POST

Operation ID: CreateConfigurationSetEventDestination Creates a new event destination in a conﬁguration set.

Path parameters

ConfigurationSetNameString True The name of the conﬁguration set that you want to create the event destination in.

Responses

200 CreateConfigurationSetEventDestinationResponse (p. 21)An empty object that indicates that the event destination was created successfully.

409 AlreadyExistsException (p. 21)The resource you tried to create already exists.

412 LimitExceededException (p. 21)You've tried to create a number of resources that exceeds the maximum number of resources for your account. For more information, see Amazon Pinpoint Quotas in the Amazon Pinpoint Developer Guide.

(23)

Schemas

OPTIONS

Responses

Schemas

Request bodies

POST schema

{ "EventDestinationName": "string", "EventDestination": {

"SnsDestination": { "TopicArn": "string"

},

"Enabled": boolean, "MatchingEventTypes": [ enum

],

},

} }}

Response bodies

GetConﬁgurationSetEventDestinationsResponse schema

{

"EventDestinations": [ {

"SnsDestination": { "TopicArn": "string"

},

"Enabled": boolean, "MatchingEventTypes": [

(24)

Schemas

enum ],

},

"Name": "string"

} ]}

CreateConﬁgurationSetEventDestinationResponse schema

{}

BadRequestException schema

}

NotFoundException schema

{

"Message": "string"

}

AlreadyExistsException schema

{

"Message": "string"

}

LimitExceededException schema

}

TooManyRequestsException schema

}

(25)

Properties

InternalServiceErrorException schema

}

Properties

AlreadyExistsException

The resource that you speciﬁed in your request already exists.

Message

BadRequestException

Message

CloudWatchLogsDestination

IamRoleArn

The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.

LogGroupArn

The name of the Amazon CloudWatch Log Group that you want to record events in.

CreateConﬁgurationSetEventDestinationRequest

An object that is used to deﬁne an event destination.

(26)

Properties

EventDestinationName

A name that identiﬁes the event destination.

EventDestination

An EventDestinationDefinition object that includes information about the event destination itself.

Type: EventDestinationDeﬁnition (p. 24) Required: True

CreateConﬁgurationSetEventDestinationResponse

An empty object that indicates that the event destination was created successfully.

EventDestination

An object that deﬁnes an event destination.

SnsDestination

Enabled

MatchingEventTypes

Note

(27)

Properties

Type: Array of type EventType (p. 25) Required: False

CloudWatchLogsDestination

KinesisFirehoseDestination

Name

A name that identiﬁes the event destination conﬁguration.

EventDestinationDeﬁnition

SnsDestination

Enabled

MatchingEventTypes

(28)

Properties

Note

Type: Array of type EventType (p. 25) Required: True

CloudWatchLogsDestination

KinesisFirehoseDestination

EventType

The types of events that are sent to the event destination. Possible values are:

INITIATED_CALL RINGING

ANSWERED COMPLETED_CALL BUSYFAILED

NO_ANSWER

GetConﬁgurationSetEventDestinationsResponse

An object that contains information about an event destination.

EventDestinations

An array of EventDestination objects. Each EventDestination object includes ARNs and other information that deﬁne an event destination.

(29)

Properties

Type: Array of type EventDestination (p. 23) Required: False

InternalServiceErrorException

Message

KinesisFirehoseDestination

DeliveryStreamArn

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination.

IamRoleArn

The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream.

LimitExceededException

There are too many instances of the speciﬁed resource type.

Message

NotFoundException

Message

(30)

See also

SnsDestination

TopicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

TooManyRequestsException

Message

GetConﬁgurationSetEventDestinations

• AWS SDK for C++

• AWS SDK for Go

CreateConﬁgurationSetEventDestination

• AWS SDK for C++

• AWS SDK for Go

(31)

Voice Message

The Amazon Pinpoint SMS and Voice API lets you create voice messages from a text script, and then deliver those messages to your customers over the phone.

URI

/v1/sms-voice/voice/message

HTTP methods

POST

Operation ID: SendVoiceMessage

Creates a new voice message and sends it to a recipient's phone number.

Responses

200 SendVoiceMessageResponse (p. 29)An object that contains the Message ID of a voice message that was sent successfully.

400 BadRequestException (p. 29)The destination number is blocked by AWS because it has a high risk of being used for fraudulent activities, or because of regulatory reasons.

OPTIONS

Responses

(32)

Schemas

Request bodies

POST schema

{ "Content": {

"CallInstructionsMessage": { "Text": "string"

},

"PlainTextMessage": { "LanguageCode": "string", "Text": "string",

"VoiceId": "string"

},

"SSMLMessage": {

"LanguageCode": "string", "Text": "string",

"VoiceId": "string"

}

}, "OriginationPhoneNumber": "string", "ConfigurationSetName": "string", "DestinationPhoneNumber": "string", "CallerId": "string"

}

Response bodies

SendVoiceMessageResponse schema

{ "MessageId": "string"

}

BadRequestException schema

{

"Message": "string"

}

TooManyRequestsException schema

{

"Message": "string"

}

InternalServiceErrorException schema

}

(33)

Properties

BadRequestException

Message

CallInstructionsMessageType

An object that deﬁnes a message that contains text formatted using Amazon Pinpoint Call Instructions markup.

Note

The ability to send messages using Amazon Pinpoint Call Instructions is currently a pre- production feature. It isn't currently available to all customers.

Text

The text, in Amazon Pinpoint Call Instructions markup, to deliver to the recipient.

InternalServiceErrorException

Message

PlainTextMessageType

An object that deﬁnes a message that contains unformatted text.

LanguageCode

The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.

Text

The plain (not SSML-formatted) text to deliver to the recipient.

(34)

Properties

VoiceId

The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide.

SSMLMessageType

An object that deﬁnes a message that contains SSML-formatted text.

LanguageCode

The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.

Text

The SSML-formatted text to deliver to the recipient.

VoiceId

The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide.

SendVoiceMessageRequest

A request to create and send a new voice message.

Content

An object that contains a voice message and information about the recipient that you want to send it to.

Type: VoiceMessageContent (p. 33) Required: False

OriginationPhoneNumber

The long code to send the message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of your message.

(35)

Properties

This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify the CallerId property in the request.

ConﬁgurationSetName

The name of the conﬁguration set that you want to use to send the message.

DestinationPhoneNumber

The phone number that you want to send the voice message to.

Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery. You can use the Phone Number Validate resource in the Amazon Pinpoint API to convert phone numbers to E.164 format.

CallerId

The phone number that appears on recipients' devices when they receive the message.

Note

You can't specify a CallerId parameter if your account is in the sandbox.

SendVoiceMessageResponse

An object that contains the Message ID of a voice message that was sent successfully.

MessageId

A unique identiﬁer for the voice message.

TooManyRequestsException

Message

(36)

See also

VoiceMessageContent

An object that contains the voice message that you want to send.

CallInstructionsMessage

An object that deﬁnes a message formatted using Amazon Pinpoint Call Instructions markup.

Type: CallInstructionsMessageType (p. 30) Required: False

PlainTextMessage

An object that deﬁnes a message that contains unformatted text.

Type: PlainTextMessageType (p. 30) Required: False

SSMLMessage

An object that deﬁnes a message that contains SSML-formatted text.

Type: SSMLMessageType (p. 31) Required: False

SendVoiceMessage

• AWS SDK for C++

• AWS SDK for Go

(37)

Operations

The Amazon Pinpoint SMS and Voice REST API includes the following operations.

• CreateConﬁgurationSet (p. 6)

Creates a new conﬁguration set. After you create the conﬁguration set, you can add one or more event destinations to it.

• CreateConﬁgurationSetEventDestination (p. 19) Creates a new event destination in a conﬁguration set.

• DeleteConﬁgurationSet (p. 2) Deletes an existing conﬁguration set.

• DeleteConﬁgurationSetEventDestination (p. 11) Deletes an event destination from a conﬁguration set.

• GetConﬁgurationSetEventDestinations (p. 18)

Retrieves information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

• ListConﬁgurationSets (p. 5)

Retrieves a list of conﬁguration sets that are associated with your account in the current AWS Region.

• SendVoiceMessage (p. 28)

Creates a new voice message and sends it to a recipient's phone number.

• UpdateConﬁgurationSetEventDestination (p. 11) Updates an event destination in a conﬁguration set.

(38)

AWS glossary

For the latest AWS terminology, see the AWS glossary in the AWS General Reference.

(39)

Document History

The following table describes the important changes to the documentation since the last release of the Amazon Pinpoint SMS and Voice API.

• API version: 2018-09-05 (latest)

• Latest documentation update: April 25, 2019

Change Description Date

Regional availability The Amazon Pinpoint SMS and Voice API is now available in the AWS Asia Paciﬁc (Mumbai) and Asia Paciﬁc (Sydney) Regions.

April 25, 2019

New operation Added the

ListConfigurationSets operation, which returns a list of the conﬁguration sets that are associated with your account.

January 24, 2019

New feature Conﬁguration sets can now use

Amazon Simple Notiﬁcation Service (Amazon SNS) as an event destination.

December 21, 2018

Regional availability The Amazon Pinpoint SMS and Voice API is now available in the AWS US West (Oregon) and Europe (Frankfurt) Regions.

December 21, 2018

Initial release This release introduces the Amazon Pinpoint SMS and Voice API.

November 15, 2018

Amazon Pinpoint SMS and Voice

Amazon Pinpoint SMS and Voice

REST API Reference

Amazon Pinpoint SMS and Voice: REST API Reference

Table of Contents

Welcome

Regional Availability

Resources

Conﬁguration Set

URI

HTTP methods

DELETE

Path parameters

Responses

OPTIONS

Responses

Schemas

Response bodies

DeleteConﬁgurationSetResponse schema

BadRequestException schema

NotFoundException schema

TooManyRequestsException schema

InternalServiceErrorException schema

Properties

BadRequestException

Message

DeleteConﬁgurationSetResponse

InternalServiceErrorException

Message

NotFoundException

Message

TooManyRequestsException

Message

See also

DeleteConﬁgurationSet

Conﬁguration Sets

URI

HTTP methods

GET

Query parameters

Responses

POST

Responses

OPTIONS

Responses

Schemas

Request bodies

POST schema

Response bodies

ListConﬁgurationSetsResponse schema

CreateConﬁgurationSetResponse schema

BadRequestException schema

AlreadyExistsException schema

LimitExceededException schema

TooManyRequestsException schema

InternalServiceErrorException schema

Properties

AlreadyExistsException

Message

BadRequestException

Message

CreateConﬁgurationSetRequest

ConﬁgurationSetName

CreateConﬁgurationSetResponse

InternalServiceErrorException

Message

LimitExceededException

Message

ListConﬁgurationSetsResponse

NextToken

ConﬁgurationSets

TooManyRequestsException

Message

See also

ListConﬁgurationSets

CreateConﬁgurationSet

Event Destination

URI

HTTP methods

PUT