Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This guide provides information about Amazon Pinpoint SMS and Voice, 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 Amazon Pinpoint SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels and supplements the resources provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, it's also helpful to 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 key information, such as Amazon Pinpoint integration with other Amazon Web Services services, and the quotas that apply to use of the service.
pinpointsmsvoicev2(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.
svc <- pinpointsmsvoicev2(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical"
)
)
| associate_origination_identity | Associates the specified origination identity with a pool |
| create_configuration_set | Creates a new configuration set |
| create_event_destination | Creates a new event destination in a configuration set |
| create_opt_out_list | Creates a new opt-out list |
| create_pool | Creates a new pool and associates the specified origination identity to the pool |
| delete_configuration_set | Deletes an existing configuration set |
| delete_default_message_type | Deletes an existing default message type on a configuration set |
| delete_default_sender_id | Deletes an existing default sender ID on a configuration set |
| delete_event_destination | Deletes an existing event destination |
| delete_keyword | Deletes an existing keyword from an origination phone number or pool |
| delete_opted_out_number | Deletes an existing opted out destination phone number from the specified opt-out list |
| delete_opt_out_list | Deletes an existing opt-out list |
| delete_pool | Deletes an existing pool |
| delete_text_message_spend_limit_override | Deletes an account-level monthly spending limit override for sending text messages |
| delete_voice_message_spend_limit_override | Deletes an account level monthly spend limit override for sending voice messages |
| describe_account_attributes | Describes attributes of your Amazon Web Services account |
| describe_account_limits | Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your account |
| describe_configuration_sets | Describes the specified configuration sets or all in your account |
| describe_keywords | Describes the specified keywords or all keywords on your origination phone number or pool |
| describe_opted_out_numbers | Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list |
| describe_opt_out_lists | Describes the specified opt-out list or all opt-out lists in your account |
| describe_phone_numbers | Describes the specified origination phone number, or all the phone numbers in your account |
| describe_pools | Retrieves the specified pools or all pools associated with your Amazon Web Services account |
| describe_sender_ids | Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account |
| describe_spend_limits | Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages |
| disassociate_origination_identity | Removes the specified origination identity from an existing pool |
| list_pool_origination_identities | Lists all associated origination identities in your pool |
| list_tags_for_resource | List all tags associated with a resource |
| put_keyword | Creates or updates a keyword configuration on an origination phone number or pool |
| put_opted_out_number | Creates an opted out destination phone number in the opt-out list |
| release_phone_number | Releases an existing origination phone number in your account |
| request_phone_number | Request an origination phone number for use in your account |
| send_text_message | Creates a new text message and sends it to a recipient's phone number |
| send_voice_message | Allows you to send a request that sends a text message through Amazon Pinpoint |
| set_default_message_type | Sets the default message type on a configuration set |
| set_default_sender_id | Sets default sender ID on a configuration set |
| set_text_message_spend_limit_override | Sets an account level monthly spend limit override for sending text messages |
| set_voice_message_spend_limit_override | Sets an account level monthly spend limit override for sending voice messages |
| tag_resource | Adds or overwrites only the specified tags for the specified Amazon Pinpoint SMS Voice, version 2 resource |
| untag_resource | Removes the association of the specified tags from an Amazon Pinpoint SMS Voice V2 resource |
| update_event_destination | Updates an existing event destination in a configuration set |
| update_phone_number | Updates the configuration of an existing origination phone number |
| update_pool | Updates the configuration of an existing pool |
if (FALSE) {
svc <- pinpointsmsvoicev2()
svc$associate_origination_identity(
Foo = 123
)
}
Run the code above in your browser using DataLab