Amazon Web Services, Inc.

Amazon Pinpoint SMS Voice V2

Welcome to the End User Messaging SMS, version 2 API Reference . This guide provides information about End User Messaging SMS, version 2 API resources,…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 110

  • POSTAssociate origination identity/#X-Amz-Target=PinpointSMSVoiceV2.AssociateOriginationIdentityAssociates the specified origination identity with a pool. If the origination identity is a phone number and is already associated with another pool, an error…
  • POSTAssociate protect configuration/#X-Amz-Target=PinpointSMSVoiceV2.AssociateProtectConfigurationAssociate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only…
  • POSTCarrier lookup/#X-Amz-Target=PinpointSMSVoiceV2.CarrierLookupReturns information about a destination phone number, including whether the number type and whether it is valid, the carrier, and more.
  • POSTCreate configuration set/#X-Amz-Target=PinpointSMSVoiceV2.CreateConfigurationSetCreates a new configuration set. After you create the configuration set, you can add one or more event destinations to it. A configuration set is a set of…
  • POSTCreate event destination/#X-Amz-Target=PinpointSMSVoiceV2.CreateEventDestinationCreates a new event destination in a configuration set. An event destination is a location where you send message events. The event options are Amazon…
  • POSTCreate notify configuration/#X-Amz-Target=PinpointSMSVoiceV2.CreateNotifyConfigurationCreates a new notify configuration for managed messaging. A notify configuration defines the settings for sending templated messages, including the display…
  • POSTCreate opt out list/#X-Amz-Target=PinpointSMSVoiceV2.CreateOptOutListCreates a new opt-out list. If the opt-out list name already exists, an error is returned. An opt-out list is a list of phone numbers that are opted out,…
  • POSTCreate pool/#X-Amz-Target=PinpointSMSVoiceV2.CreatePoolCreates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are…
  • POSTCreate protect configuration/#X-Amz-Target=PinpointSMSVoiceV2.CreateProtectConfigurationCreate a new protect configuration. By default all country rule sets for each capability are set to ALLOW . Update the country rule sets using…
  • POSTCreate rcs agent/#X-Amz-Target=PinpointSMSVoiceV2.CreateRcsAgentCreates a new RCS agent for sending rich messages through the RCS channel. The RCS agent serves as an origination identity for sending RCS messages to your…
  • POSTCreate registration/#X-Amz-Target=PinpointSMSVoiceV2.CreateRegistrationCreates a new registration based on the RegistrationType field.
  • POSTCreate registration association/#X-Amz-Target=PinpointSMSVoiceV2.CreateRegistrationAssociationAssociate the registration with an origination identity such as a phone number or sender ID.
  • POSTCreate registration attachment/#X-Amz-Target=PinpointSMSVoiceV2.CreateRegistrationAttachmentCreate a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 5MB and valid file extensions are PDF, JPEG and…
  • POSTCreate registration version/#X-Amz-Target=PinpointSMSVoiceV2.CreateRegistrationVersionCreate a new version of the registration and increase the VersionNumber . The previous version of the registration becomes read-only.
  • POSTCreate verified destination number/#X-Amz-Target=PinpointSMSVoiceV2.CreateVerifiedDestinationNumberYou can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
  • POSTDelete account default protect configuration/#X-Amz-Target=PinpointSMSVoiceV2.DeleteAccountDefaultProtectConfigurationRemoves the current account default protect configuration.
  • POSTDelete configuration set/#X-Amz-Target=PinpointSMSVoiceV2.DeleteConfigurationSetDeletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set,…
  • POSTDelete default message type/#X-Amz-Target=PinpointSMSVoiceV2.DeleteDefaultMessageTypeDeletes an existing default message type on a configuration set. A message type is a type of messages that you plan to send. If you send account-related…
  • POSTDelete default sender id/#X-Amz-Target=PinpointSMSVoiceV2.DeleteDefaultSenderIdDeletes an existing default sender ID on a configuration set. A default sender ID is the identity that appears on recipients' devices when they receive SMS…
  • POSTDelete event destination/#X-Amz-Target=PinpointSMSVoiceV2.DeleteEventDestinationDeletes an existing event destination. An event destination is a location where you send response information about the messages that you send. For example,…
  • POSTDelete keyword/#X-Amz-Target=PinpointSMSVoiceV2.DeleteKeywordDeletes an existing keyword from an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or pool. It is…
  • POSTDelete media message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.DeleteMediaMessageSpendLimitOverrideDeletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to…
  • POSTDelete notify configuration/#X-Amz-Target=PinpointSMSVoiceV2.DeleteNotifyConfigurationDeletes an existing notify configuration. If deletion protection is enabled, an error is returned.
  • POSTDelete notify message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.DeleteNotifyMessageSpendLimitOverrideDeletes an account-level monthly spending limit override for sending notify messages. Deleting a spend limit override will set the EnforcedLimit to equal the…
  • POSTDelete opt out list/#X-Amz-Target=PinpointSMSVoiceV2.DeleteOptOutListDeletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted. If the specified opt-out list name doesn't exist or is in-use…
  • POSTDelete opted out number/#X-Amz-Target=PinpointSMSVoiceV2.DeleteOptedOutNumberDeletes an existing opted out destination phone number from the specified opt-out list. Each destination phone number can only be deleted once every 30 days.…
  • POSTDelete pool/#X-Amz-Target=PinpointSMSVoiceV2.DeletePoolDeletes an existing pool. Deleting a pool disassociates all origination identities from that pool. If the pool status isn't active or if deletion protection…
  • POSTDelete protect configuration/#X-Amz-Target=PinpointSMSVoiceV2.DeleteProtectConfigurationPermanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account…
  • POSTDelete protect configuration rule set number override/#X-Amz-Target=PinpointSMSVoiceV2.DeleteProtectConfigurationRuleSetNumberOverridePermanently delete the protect configuration rule set number override.
  • POSTDelete rcs agent/#X-Amz-Target=PinpointSMSVoiceV2.DeleteRcsAgentDeletes an existing RCS agent. If deletion protection is enabled, an error is returned.
  • POSTDelete rcs message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.DeleteRcsMessageSpendLimitOverrideDeletes an account-level monthly spending limit override for sending RCS messages. Deleting a spend limit override sets the EnforcedLimit to equal the…
  • POSTDelete registration/#X-Amz-Target=PinpointSMSVoiceV2.DeleteRegistrationPermanently delete an existing registration from your account.
  • POSTDelete registration attachment/#X-Amz-Target=PinpointSMSVoiceV2.DeleteRegistrationAttachmentPermanently delete the specified registration attachment.
  • POSTDelete registration field value/#X-Amz-Target=PinpointSMSVoiceV2.DeleteRegistrationFieldValueDelete the value in a registration form field.
  • POSTDelete resource policy/#X-Amz-Target=PinpointSMSVoiceV2.DeleteResourcePolicyDeletes the resource-based policy document attached to the End User Messaging SMS resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone…
  • POSTDelete text message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.DeleteTextMessageSpendLimitOverrideDeletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the…
  • POSTDelete verified destination number/#X-Amz-Target=PinpointSMSVoiceV2.DeleteVerifiedDestinationNumberDelete a verified destination phone number.
  • POSTDelete voice message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.DeleteVoiceMessageSpendLimitOverrideDeletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit…
  • POSTDescribe account attributes/#X-Amz-Target=PinpointSMSVoiceV2.DescribeAccountAttributesDescribes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in…
  • POSTDescribe account limits/#X-Amz-Target=PinpointSMSVoiceV2.DescribeAccountLimitsDescribes the current End User Messaging SMS SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage…
  • POSTDescribe configuration sets/#X-Amz-Target=PinpointSMSVoiceV2.DescribeConfigurationSetsDescribes the specified configuration sets or all in your account. If you specify configuration set names, the output includes information for only the…
  • POSTDescribe keywords/#X-Amz-Target=PinpointSMSVoiceV2.DescribeKeywordsDescribes the specified keywords or all keywords on your origination phone number or pool. A keyword is a word that you can search for on a particular phone…
  • POSTDescribe notify configurations/#X-Amz-Target=PinpointSMSVoiceV2.DescribeNotifyConfigurationsDescribes the specified notify configurations or all notify configurations in your account. If you specify notify configuration IDs, the output includes…
  • POSTDescribe notify templates/#X-Amz-Target=PinpointSMSVoiceV2.DescribeNotifyTemplatesDescribes the specified notify templates or all notify templates in your account. If you specify template IDs, the output includes information for only the…
  • POSTDescribe opt out lists/#X-Amz-Target=PinpointSMSVoiceV2.DescribeOptOutListsDescribes the specified opt-out list or all opt-out lists in your account. If you specify opt-out list names, the output includes information for only the…
  • POSTDescribe opted out numbers/#X-Amz-Target=PinpointSMSVoiceV2.DescribeOptedOutNumbersDescribes the specified opted out destination numbers or all opted out destination numbers in an opt-out list. If you specify opted out numbers, the output…
  • POSTDescribe phone numbers/#X-Amz-Target=PinpointSMSVoiceV2.DescribePhoneNumbersDescribes the specified origination phone number, or all the phone numbers in your account. If you specify phone number IDs, the output includes information…
  • POSTDescribe pools/#X-Amz-Target=PinpointSMSVoiceV2.DescribePoolsRetrieves the specified pools or all pools associated with your Amazon Web Services account. If you specify pool IDs, the output includes information for only…
  • POSTDescribe protect configurations/#X-Amz-Target=PinpointSMSVoiceV2.DescribeProtectConfigurationsRetrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.
  • POSTDescribe rcs agent country launch status/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRcsAgentCountryLaunchStatusRetrieves the per-country launch status of an RCS agent, including carrier-level details for each country.
  • POSTDescribe rcs agents/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRcsAgentsRetrieves the specified RCS agents or all RCS agents associated with your Amazon Web Services account. If you specify RCS agent IDs, the output includes…
  • POSTDescribe registration attachments/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRegistrationAttachmentsRetrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.
  • POSTDescribe registration field definitions/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRegistrationFieldDefinitionsRetrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling…
  • POSTDescribe registration field values/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRegistrationFieldValuesRetrieves the specified registration field values.
  • POSTDescribe registration section definitions/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRegistrationSectionDefinitionsRetrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling…
  • POSTDescribe registration type definitions/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRegistrationTypeDefinitionsRetrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and…
  • POSTDescribe registration versions/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRegistrationVersionsRetrieves the specified registration version.
  • POSTDescribe registrations/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRegistrationsRetrieves the specified registrations.
  • POSTDescribe sender ids/#X-Amz-Target=PinpointSMSVoiceV2.DescribeSenderIdsDescribes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information…
  • POSTDescribe spend limits/#X-Amz-Target=PinpointSMSVoiceV2.DescribeSpendLimitsDescribes the current monthly spend limits for sending voice and text messages. When you establish an Amazon Web Services account, the account has initial…
  • POSTDescribe verified destination numbers/#X-Amz-Target=PinpointSMSVoiceV2.DescribeVerifiedDestinationNumbersRetrieves the specified verified destination numbers.
  • POSTDisassociate origination identity/#X-Amz-Target=PinpointSMSVoiceV2.DisassociateOriginationIdentityRemoves the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an error is returned.
  • POSTDisassociate protect configuration/#X-Amz-Target=PinpointSMSVoiceV2.DisassociateProtectConfigurationDisassociate a protect configuration from a configuration set.
  • POSTDiscard registration version/#X-Amz-Target=PinpointSMSVoiceV2.DiscardRegistrationVersionDiscard the current version of the registration.
  • POSTGet protect configuration country rule set/#X-Amz-Target=PinpointSMSVoiceV2.GetProtectConfigurationCountryRuleSetRetrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.
  • POSTGet resource policy/#X-Amz-Target=PinpointSMSVoiceV2.GetResourcePolicyRetrieves the JSON text of the resource-based policy document attached to the End User Messaging SMS resource. A shared resource can be a Pool, Opt-out list,…
  • POSTList available phone numbers/#X-Amz-Target=PinpointSMSVoiceV2.ListAvailablePhoneNumbersRetrieves a list of phone numbers that are available to request, based on the country, capabilities, and number type that you specify. You can optionally…
  • POSTList notify countries/#X-Amz-Target=PinpointSMSVoiceV2.ListNotifyCountriesLists countries that support notify messaging. You can optionally filter by channel, use case, or tier.
  • POSTList pool origination identities/#X-Amz-Target=PinpointSMSVoiceV2.ListPoolOriginationIdentitiesLists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that…
  • POSTList protect configuration rule set number overrides/#X-Amz-Target=PinpointSMSVoiceV2.ListProtectConfigurationRuleSetNumberOverridesRetrieve all of the protect configuration rule set number overrides that match the filters.
  • POSTList registration associations/#X-Amz-Target=PinpointSMSVoiceV2.ListRegistrationAssociationsRetrieve all of the origination identities that are associated with a registration.
  • POSTList tags for resource/#X-Amz-Target=PinpointSMSVoiceV2.ListTagsForResourceList all tags associated with a resource.
  • POSTPut keyword/#X-Amz-Target=PinpointSMSVoiceV2.PutKeywordCreates or updates a keyword configuration on an origination phone number or pool. A keyword is a word that you can search for on a particular phone number or…
  • POSTPut message feedback/#X-Amz-Target=PinpointSMSVoiceV2.PutMessageFeedbackSet the MessageFeedbackStatus as RECEIVED or FAILED for the passed in MessageId. If you use message feedback then you must update message feedback record.…
  • POSTPut opted out number/#X-Amz-Target=PinpointSMSVoiceV2.PutOptedOutNumberCreates an opted out destination phone number in the opt-out list. If the destination phone number isn't valid or if the specified opt-out list doesn't exist,…
  • POSTPut protect configuration rule set number override/#X-Amz-Target=PinpointSMSVoiceV2.PutProtectConfigurationRuleSetNumberOverrideCreate or update a phone number rule override and associate it with a protect configuration.
  • POSTPut registration field value/#X-Amz-Target=PinpointSMSVoiceV2.PutRegistrationFieldValueCreates or updates a field value for a registration.
  • POSTPut resource policy/#X-Amz-Target=PinpointSMSVoiceV2.PutResourcePolicyAttaches a resource-based policy to a End User Messaging SMS resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the…
  • POSTRelease phone number/#X-Amz-Target=PinpointSMSVoiceV2.ReleasePhoneNumberReleases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages. If the origination…
  • POSTRelease sender id/#X-Amz-Target=PinpointSMSVoiceV2.ReleaseSenderIdReleases an existing sender ID in your account.
  • POSTRequest phone number/#X-Amz-Target=PinpointSMSVoiceV2.RequestPhoneNumberRequest an origination phone number for use in your account. For more information on phone number request see Request a phone number in the End User Messaging…
  • POSTRequest sender id/#X-Amz-Target=PinpointSMSVoiceV2.RequestSenderIdRequest a new sender ID that doesn't require registration.
  • POSTSend destination number verification code/#X-Amz-Target=PinpointSMSVoiceV2.SendDestinationNumberVerificationCodeBefore you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message…
  • POSTSend media message/#X-Amz-Target=PinpointSMSVoiceV2.SendMediaMessageCreates a new multimedia message (MMS) and sends it to a recipient's phone number.
  • POSTSend notify text message/#X-Amz-Target=PinpointSMSVoiceV2.SendNotifyTextMessageSends a templated text message through a notify configuration to a recipient's phone number.
  • POSTSend notify voice message/#X-Amz-Target=PinpointSMSVoiceV2.SendNotifyVoiceMessageSends a templated voice message through a notify configuration to a recipient's phone number.
  • POSTSend rcs message/#X-Amz-Target=PinpointSMSVoiceV2.SendRcsMessageCreates a new RCS message and sends it to a recipient's phone number. RCS messages support rich content including text, files, rich cards, and carousels with…
  • POSTSend text message/#X-Amz-Target=PinpointSMSVoiceV2.SendTextMessageCreates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked. SMS…
  • POSTSend voice message/#X-Amz-Target=PinpointSMSVoiceV2.SendVoiceMessageAllows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.
  • POSTSet account default protect configuration/#X-Amz-Target=PinpointSMSVoiceV2.SetAccountDefaultProtectConfigurationSet a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default…
  • POSTSet default message feedback enabled/#X-Amz-Target=PinpointSMSVoiceV2.SetDefaultMessageFeedbackEnabledSets a configuration set's default for message feedback.
  • POSTSet default message type/#X-Amz-Target=PinpointSMSVoiceV2.SetDefaultMessageTypeSets the default message type on a configuration set. Choose the category of SMS messages that you plan to send from this account. If you send account-related…
  • POSTSet default sender id/#X-Amz-Target=PinpointSMSVoiceV2.SetDefaultSenderIdSets default sender ID on a configuration set. When sending a text message to a destination country that supports sender IDs, the default sender ID on the…
  • POSTSet media message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.SetMediaMessageSpendLimitOverrideSets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit , which is…
  • POSTSet notify message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.SetNotifyMessageSpendLimitOverrideSets an account level monthly spend limit override for sending notify messages. The requested spend limit must be less than or equal to the MaxLimit , which…
  • POSTSet rcs message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.SetRcsMessageSpendLimitOverrideSets an account level monthly spend limit override for sending RCS messages. The requested spend limit must be less than or equal to the MaxLimit , which is…
  • POSTSet text message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.SetTextMessageSpendLimitOverrideSets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit , which is…
  • POSTSet voice message spend limit override/#X-Amz-Target=PinpointSMSVoiceV2.SetVoiceMessageSpendLimitOverrideSets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit , which is…
  • POSTSubmit registration version/#X-Amz-Target=PinpointSMSVoiceV2.SubmitRegistrationVersionSubmit the specified registration for review and approval.
  • POSTTag resource/#X-Amz-Target=PinpointSMSVoiceV2.TagResourceAdds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each…
  • POSTUntag resource/#X-Amz-Target=PinpointSMSVoiceV2.UntagResourceRemoves the association of the specified tags from a resource. For more information on tags see Tags in the End User Messaging SMS User Guide .
  • POSTUpdate event destination/#X-Amz-Target=PinpointSMSVoiceV2.UpdateEventDestinationUpdates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable…
  • POSTUpdate notify configuration/#X-Amz-Target=PinpointSMSVoiceV2.UpdateNotifyConfigurationUpdates an existing notify configuration. You can update the default template, pool association, enabled channels, enabled countries, and deletion protection…
  • POSTUpdate phone number/#X-Amz-Target=PinpointSMSVoiceV2.UpdatePhoneNumberUpdates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the…
  • POSTUpdate pool/#X-Amz-Target=PinpointSMSVoiceV2.UpdatePoolUpdates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn , enable or…
  • POSTUpdate protect configuration/#X-Amz-Target=PinpointSMSVoiceV2.UpdateProtectConfigurationUpdate the setting for an existing protect configuration.
  • POSTUpdate protect configuration country rule set/#X-Amz-Target=PinpointSMSVoiceV2.UpdateProtectConfigurationCountryRuleSetUpdate a country rule set to ALLOW , BLOCK , MONITOR , or FILTER messages to be sent to the specified destination counties. You can update one or multiple…
  • POSTUpdate rcs agent/#X-Amz-Target=PinpointSMSVoiceV2.UpdateRcsAgentUpdates the configuration of an existing RCS agent. You can update the opt-out list, deletion protection, two-way messaging settings, and self-managed…
  • POSTUpdate sender id/#X-Amz-Target=PinpointSMSVoiceV2.UpdateSenderIdUpdates the configuration of an existing sender ID.
  • POSTVerify destination number/#X-Amz-Target=PinpointSMSVoiceV2.VerifyDestinationNumberUse the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.

API details

Base URL
https://sms-voice.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
110 operations on 110 pathsPOST 110
Description format
AWS Smithy model, API version 2022-03-31

How to test the Amazon Pinpoint SMS Voice V2 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Pinpoint SMS Voice V2 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate origination identity” (POST /#X-Amz-Target=PinpointSMSVoiceV2.AssociateOriginationIdentity), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Pinpoint SMS Voice V2?

Welcome to the End User Messaging SMS, version 2 API Reference . This guide provides information about End User Messaging SMS, version 2 API resources,… It is listed under Communication and has 110 endpoints.

Who publishes the Amazon Pinpoint SMS Voice V2?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Pinpoint SMS Voice V2?

Requests go to https://sms-voice.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Pinpoint SMS Voice V2?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Pinpoint SMS Voice V2 have?

110 operations on 110 paths (110 POST).

Is forking the Amazon Pinpoint SMS Voice V2 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.