AWS SDK for JavaScript Pinpoint Sms Voice V2 Client for Node.js, Browser and React Native
npm install @aws-sdk/client-pinpoint-sms-voice-v2AWS SDK for JavaScript PinpointSMSVoiceV2 Client for Node.js, Browser and React Native.
Welcome to the End User Messaging SMS, version 2 API Reference. This guide provides information about End User Messaging SMS, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The End User Messaging SMS, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. End User Messaging SMS, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
If you're new to End User Messaging SMS, it's also helpful to review the End User Messaging SMS User Guide, where you'll find tutorials, code samples, and procedures that demonstrate how to use End User Messaging SMS features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as End User Messaging SMS integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The End User Messaging SMS version 2 API Reference is available in several Amazon Web Services 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 Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services 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 Amazon Web Services Global Infrastructure.
npm install @aws-sdk/client-pinpoint-sms-voice-v2yarn add @aws-sdk/client-pinpoint-sms-voice-v2pnpm add @aws-sdk/client-pinpoint-sms-voice-v2The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the PinpointSMSVoiceV2Client and
the commands you need, for example ListTagsForResourceCommand:
``js`
// ES5 example
const { PinpointSMSVoiceV2Client, ListTagsForResourceCommand } = require("@aws-sdk/client-pinpoint-sms-voice-v2");
`ts`
// ES6+ example
import { PinpointSMSVoiceV2Client, ListTagsForResourceCommand } from "@aws-sdk/client-pinpoint-sms-voice-v2";
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new PinpointSMSVoiceV2Client({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListTagsForResourceCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
#### Promises
You can also use Promise chaining
to execute send operation.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
#### v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
`ts
import * as AWS from "@aws-sdk/client-pinpoint-sms-voice-v2";
const client = new AWS.PinpointSMSVoiceV2({ region: "REGION" });
// async/await.
try {
const data = await client.listTagsForResource(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listTagsForResource(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listTagsForResource(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-pinpoint-sms-voice-v2` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
AssociateOriginationIdentity
Command API Reference / Input / Output
AssociateProtectConfiguration
Command API Reference / Input / Output
CarrierLookup
Command API Reference / Input / Output
CreateConfigurationSet
Command API Reference / Input / Output
CreateEventDestination
Command API Reference / Input / Output
CreateOptOutList
Command API Reference / Input / Output
CreatePool
Command API Reference / Input / Output
CreateProtectConfiguration
Command API Reference / Input / Output
CreateRegistration
Command API Reference / Input / Output
CreateRegistrationAssociation
Command API Reference / Input / Output
CreateRegistrationAttachment
Command API Reference / Input / Output
CreateRegistrationVersion
Command API Reference / Input / Output
CreateVerifiedDestinationNumber
Command API Reference / Input / Output
DeleteAccountDefaultProtectConfiguration
Command API Reference / Input / Output
DeleteConfigurationSet
Command API Reference / Input / Output
DeleteDefaultMessageType
Command API Reference / Input / Output
DeleteDefaultSenderId
Command API Reference / Input / Output
DeleteEventDestination
Command API Reference / Input / Output
DeleteKeyword
Command API Reference / Input / Output
DeleteMediaMessageSpendLimitOverride
Command API Reference / Input / Output
DeleteOptedOutNumber
Command API Reference / Input / Output
DeleteOptOutList
Command API Reference / Input / Output
DeletePool
Command API Reference / Input / Output
DeleteProtectConfiguration
Command API Reference / Input / Output
DeleteProtectConfigurationRuleSetNumberOverride
Command API Reference / Input / Output
DeleteRegistration
Command API Reference / Input / Output
DeleteRegistrationAttachment
Command API Reference / Input / Output
DeleteRegistrationFieldValue
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeleteTextMessageSpendLimitOverride
Command API Reference / Input / Output
DeleteVerifiedDestinationNumber
Command API Reference / Input / Output
DeleteVoiceMessageSpendLimitOverride
Command API Reference / Input / Output
DescribeAccountAttributes
Command API Reference / Input / Output
DescribeAccountLimits
Command API Reference / Input / Output
DescribeConfigurationSets
Command API Reference / Input / Output
DescribeKeywords
Command API Reference / Input / Output
DescribeOptedOutNumbers
Command API Reference / Input / Output
DescribeOptOutLists
Command API Reference / Input / Output
DescribePhoneNumbers
Command API Reference / Input / Output
DescribePools
Command API Reference / Input / Output
DescribeProtectConfigurations
Command API Reference / Input / Output
DescribeRegistrationAttachments
Command API Reference / Input / Output
DescribeRegistrationFieldDefinitions
Command API Reference / Input / Output
DescribeRegistrationFieldValues
Command API Reference / Input / Output
DescribeRegistrations
Command API Reference / Input / Output
DescribeRegistrationSectionDefinitions
Command API Reference / Input / Output
DescribeRegistrationTypeDefinitions
Command API Reference / Input / Output
DescribeRegistrationVersions
Command API Reference / Input / Output
DescribeSenderIds
Command API Reference / Input / Output
DescribeSpendLimits
Command API Reference / Input / Output
DescribeVerifiedDestinationNumbers
Command API Reference / Input / Output
DisassociateOriginationIdentity
Command API Reference / Input / Output
DisassociateProtectConfiguration
Command API Reference / Input / Output
DiscardRegistrationVersion
Command API Reference / Input / Output
GetProtectConfigurationCountryRuleSet
Command API Reference / Input / Output
GetResourcePolicy
Command API Reference / Input / Output
ListPoolOriginationIdentities
Command API Reference / Input / Output
ListProtectConfigurationRuleSetNumberOverrides
Command API Reference / Input / Output
ListRegistrationAssociations
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
PutKeyword
Command API Reference / Input / Output
PutMessageFeedback
Command API Reference / Input / Output
PutOptedOutNumber
Command API Reference / Input / Output
PutProtectConfigurationRuleSetNumberOverride
Command API Reference / Input / Output
PutRegistrationFieldValue
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
ReleasePhoneNumber
Command API Reference / Input / Output
ReleaseSenderId
Command API Reference / Input / Output
RequestPhoneNumber
Command API Reference / Input / Output
RequestSenderId
Command API Reference / Input / Output
SendDestinationNumberVerificationCode
Command API Reference / Input / Output
SendMediaMessage
Command API Reference / Input / Output
SendTextMessage
Command API Reference / Input / Output
SendVoiceMessage
Command API Reference / Input / Output
SetAccountDefaultProtectConfiguration
Command API Reference / Input / Output
SetDefaultMessageFeedbackEnabled
Command API Reference / Input / Output
SetDefaultMessageType
Command API Reference / Input / Output
SetDefaultSenderId
Command API Reference / Input / Output
SetMediaMessageSpendLimitOverride
Command API Reference / Input / Output
SetTextMessageSpendLimitOverride
Command API Reference / Input / Output
SetVoiceMessageSpendLimitOverride
Command API Reference / Input / Output
SubmitRegistrationVersion
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateEventDestination
Command API Reference / Input / Output
UpdatePhoneNumber
Command API Reference / Input / Output
UpdatePool
Command API Reference / Input / Output
UpdateProtectConfiguration
Command API Reference / Input / Output
UpdateProtectConfigurationCountryRuleSet
Command API Reference / Input / Output
UpdateSenderId
Command API Reference / Input / Output
VerifyDestinationNumber