socialmessaging/aws.sdk.kotlin.services.socialmessaging/SocialMessagingClient

SocialMessagingClient

interface SocialMessagingClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: SocialMessagingClient.Config

SocialMessagingClient's configuration

Functions

Link copied to clipboard
abstract suspend fun associateWhatsAppBusinessAccount(input: AssociateWhatsAppBusinessAccountRequest = AssociateWhatsAppBusinessAccountRequest { }): AssociateWhatsAppBusinessAccountResponse

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 copied to clipboard
abstract suspend fun deleteWhatsAppMessageMedia(input: DeleteWhatsAppMessageMediaRequest): DeleteWhatsAppMessageMediaResponse

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 copied to clipboard
abstract suspend fun disassociateWhatsAppBusinessAccount(input: DisassociateWhatsAppBusinessAccountRequest): DisassociateWhatsAppBusinessAccountResponse

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

Link copied to clipboard
abstract suspend fun getLinkedWhatsAppBusinessAccount(input: GetLinkedWhatsAppBusinessAccountRequest): GetLinkedWhatsAppBusinessAccountResponse

Get the details of your linked WhatsApp Business Account.

abstract suspend fun getLinkedWhatsAppBusinessAccountPhoneNumber(input: GetLinkedWhatsAppBusinessAccountPhoneNumberRequest): GetLinkedWhatsAppBusinessAccountPhoneNumberResponse

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

Link copied to clipboard
abstract suspend fun getWhatsAppMessageMedia(input: GetWhatsAppMessageMediaRequest): GetWhatsAppMessageMediaResponse

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 copied to clipboard
abstract suspend fun listLinkedWhatsAppBusinessAccounts(input: ListLinkedWhatsAppBusinessAccountsRequest = ListLinkedWhatsAppBusinessAccountsRequest { }): ListLinkedWhatsAppBusinessAccountsResponse

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

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

Link copied to clipboard
abstract suspend fun postWhatsAppMessageMedia(input: PostWhatsAppMessageMediaRequest): PostWhatsAppMessageMediaResponse

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.

abstract suspend fun putWhatsAppBusinessAccountEventDestinations(input: PutWhatsAppBusinessAccountEventDestinationsRequest): PutWhatsAppBusinessAccountEventDestinationsResponse

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 copied to clipboard
abstract suspend fun sendWhatsAppMessage(input: SendWhatsAppMessageRequest): SendWhatsAppMessageResponse

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 copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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 copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags from a resource.

Inherited functions

Link copied to clipboard
inline suspend fun SocialMessagingClient.associateWhatsAppBusinessAccount(crossinline block: AssociateWhatsAppBusinessAccountRequest.Builder.() -> Unit): AssociateWhatsAppBusinessAccountResponse

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 copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun SocialMessagingClient.deleteWhatsAppMessageMedia(crossinline block: DeleteWhatsAppMessageMediaRequest.Builder.() -> Unit): DeleteWhatsAppMessageMediaResponse

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 copied to clipboard
inline suspend fun SocialMessagingClient.disassociateWhatsAppBusinessAccount(crossinline block: DisassociateWhatsAppBusinessAccountRequest.Builder.() -> Unit): DisassociateWhatsAppBusinessAccountResponse

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

Link copied to clipboard
inline suspend fun SocialMessagingClient.getLinkedWhatsAppBusinessAccount(crossinline block: GetLinkedWhatsAppBusinessAccountRequest.Builder.() -> Unit): GetLinkedWhatsAppBusinessAccountResponse

Get the details of your linked WhatsApp Business Account.

inline suspend fun SocialMessagingClient.getLinkedWhatsAppBusinessAccountPhoneNumber(crossinline block: GetLinkedWhatsAppBusinessAccountPhoneNumberRequest.Builder.() -> Unit): GetLinkedWhatsAppBusinessAccountPhoneNumberResponse

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

Link copied to clipboard
inline suspend fun SocialMessagingClient.getWhatsAppMessageMedia(crossinline block: GetWhatsAppMessageMediaRequest.Builder.() -> Unit): GetWhatsAppMessageMediaResponse

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 copied to clipboard
inline suspend fun SocialMessagingClient.listLinkedWhatsAppBusinessAccounts(crossinline block: ListLinkedWhatsAppBusinessAccountsRequest.Builder.() -> Unit): ListLinkedWhatsAppBusinessAccountsResponse

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

Link copied to clipboard
inline suspend fun SocialMessagingClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

Link copied to clipboard
inline suspend fun SocialMessagingClient.postWhatsAppMessageMedia(crossinline block: PostWhatsAppMessageMediaRequest.Builder.() -> Unit): PostWhatsAppMessageMediaResponse

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.

inline suspend fun SocialMessagingClient.putWhatsAppBusinessAccountEventDestinations(crossinline block: PutWhatsAppBusinessAccountEventDestinationsRequest.Builder.() -> Unit): PutWhatsAppBusinessAccountEventDestinationsResponse

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 copied to clipboard
inline suspend fun SocialMessagingClient.sendWhatsAppMessage(crossinline block: SendWhatsAppMessageRequest.Builder.() -> Unit): SendWhatsAppMessageResponse

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 copied to clipboard
inline suspend fun SocialMessagingClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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 copied to clipboard
inline suspend fun SocialMessagingClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from a resource.

Link copied to clipboard
fun SocialMessagingClient.withConfig(block: SocialMessagingClient.Config.Builder.() -> Unit): SocialMessagingClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.

© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved. Generated by dokka