View Source AWS.SocialMessaging (aws-elixir v1.0.4)

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

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.

Link to this section Summary

Functions

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.

Delete a media object from the WhatsApp service.

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

Get the details of your linked WhatsApp Business Account.

Use your WhatsApp phone number id to get the WABA account id and phone number details.

Get a media file from the WhatsApp service.

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

List all tags associated with a resource, such as a phone number or WABA.

Upload a media file to the WhatsApp service.

Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA).

Adds or overwrites only the specified tags for the specified resource.

Removes the specified tags from a resource.

Link to this section Functions

Link to this function

associate_whats_app_business_account(client, input, options \\ [])

View Source

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.

Link to this function

delete_whats_app_message_media(client, input, options \\ [])

View Source

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.

Link to this function

disassociate_whats_app_business_account(client, input, options \\ [])

View Source

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

Link to this function

get_linked_whats_app_business_account(client, id, options \\ [])

View Source

Get the details of your linked WhatsApp Business Account.

Link to this function

get_linked_whats_app_business_account_phone_number(client, id, options \\ [])

View Source

Use your WhatsApp phone number id to get the WABA account id and phone number details.

Link to this function

get_whats_app_message_media(client, input, options \\ [])

View Source

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 destinationS3File or destinationS3PresignedUrl for the destination. If both are used then an InvalidParameterException is returned.

Link to this function

list_linked_whats_app_business_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

List all tags associated with a resource, such as a phone number or WABA.

Link to this function

post_whats_app_message_media(client, input, options \\ [])

View Source

Upload a media file to the WhatsApp service.

Only the specified originationPhoneNumberId has the permissions to send the media file when using SendWhatsAppMessage. You must use either sourceS3File or sourceS3PresignedUrl for the source. If both or neither are specified then an InvalidParameterException is returned.

Link to this function

put_whats_app_business_account_event_destinations(client, input, options \\ [])

View Source

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.

Link to this function

send_whats_app_message(client, input, options \\ [])

View Source

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 .

Link to this function

tag_resource(client, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes the specified tags from a resource.