- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SocialMessagingClient
Amazon Web Services End User Messaging Social, also referred to as Social messaging, is a messaging service that enables application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.
The Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.
If you're new to the Amazon Web Services End User Messaging Social API, it's also helpful to review What is Amazon Web Services End User Messaging Social in the Amazon Web Services End User Messaging Social User Guide. The Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications. The guide also provides key information, such as integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated 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 Web Services End User Messaging 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.
Installation
npm install @aws-sdk/client-socialmessagingyarn add @aws-sdk/client-socialmessagingpnpm add @aws-sdk/client-socialmessagingSocialMessagingClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| AssociateWhatsAppBusinessAccountCommand | This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account. |
| DeleteWhatsAppMessageMediaCommand | Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too. |
| DisassociateWhatsAppBusinessAccountCommand | Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account. |
| GetLinkedWhatsAppBusinessAccountCommand | Get the details of your linked WhatsApp Business Account. |
| GetLinkedWhatsAppBusinessAccountPhoneNumberCommand | Use your WhatsApp phone number id to get the WABA account id and phone number details. |
| GetWhatsAppMessageMediaCommand | Get a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use either |
| ListLinkedWhatsAppBusinessAccountsCommand | List all WhatsApp Business Accounts linked to your Amazon Web Services account. |
| ListTagsForResourceCommand | List all tags associated with a resource, such as a phone number or WABA. |
| PostWhatsAppMessageMediaCommand | Upload a media file to the WhatsApp service. Only the specified |
| PutWhatsAppBusinessAccountEventDestinationsCommand | Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination. |
| SendWhatsAppMessageCommand | Send a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messages in the Amazon Web Services End User Messaging Social User Guide . |
| TagResourceCommand | Adds 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. |
| UntagResourceCommand | Removes the specified tags from a resource. |
SocialMessagingClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SocialMessagingClientConfig