socialmessaging/aws.sdk.kotlin.services.socialmessaging

Package-level declarations

Types

Link copied to clipboard
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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

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
inline suspend fun SocialMessagingClient.createWhatsAppFlow(crossinline block: CreateWhatsAppFlowRequest.Builder.() -> Unit): CreateWhatsAppFlowResponse

Creates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences that users can complete without leaving WhatsApp. The Flow is created in DRAFT status. If publish is set to true and a valid flowJson is provided, the Flow is published immediately.

Link copied to clipboard
inline suspend fun SocialMessagingClient.createWhatsAppMessageTemplate(crossinline block: CreateWhatsAppMessageTemplateRequest.Builder.() -> Unit): CreateWhatsAppMessageTemplateResponse

Creates a new WhatsApp message template from a custom definition.

Link copied to clipboard
inline suspend fun SocialMessagingClient.createWhatsAppMessageTemplateFromLibrary(crossinline block: CreateWhatsAppMessageTemplateFromLibraryRequest.Builder.() -> Unit): CreateWhatsAppMessageTemplateFromLibraryResponse

Creates a new WhatsApp message template using a template from Meta's template library.

Link copied to clipboard
inline suspend fun SocialMessagingClient.createWhatsAppMessageTemplateMedia(crossinline block: CreateWhatsAppMessageTemplateMediaRequest.Builder.() -> Unit): CreateWhatsAppMessageTemplateMediaResponse

Uploads media for use in a WhatsApp message template.

Link copied to clipboard
inline suspend fun SocialMessagingClient.deleteWhatsAppFlow(crossinline block: DeleteWhatsAppFlowRequest.Builder.() -> Unit): DeleteWhatsAppFlowResponse

Deletes a WhatsApp Flow permanently. Only Flows in DRAFT status can be deleted. Published or deprecated Flows cannot be deleted.

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
Link copied to clipboard
inline suspend fun SocialMessagingClient.deprecateWhatsAppFlow(crossinline block: DeprecateWhatsAppFlowRequest.Builder.() -> Unit): DeprecateWhatsAppFlowResponse

Deprecates a published WhatsApp Flow, marking it as no longer recommended for use. The Flow must be in PUBLISHED status. This is an irreversible operation.

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

Retrieve the WABA account id and phone number details of a WhatsApp business account phone number.

Link copied to clipboard
inline suspend fun SocialMessagingClient.getWhatsAppFlow(crossinline block: GetWhatsAppFlowRequest.Builder.() -> Unit): GetWhatsAppFlowResponse

Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.

Link copied to clipboard
inline suspend fun SocialMessagingClient.getWhatsAppFlowPreview(crossinline block: GetWhatsAppFlowPreviewRequest.Builder.() -> Unit): GetWhatsAppFlowPreviewResponse

Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review.

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.getWhatsAppMessageTemplate(crossinline block: GetWhatsAppMessageTemplateRequest.Builder.() -> Unit): GetWhatsAppMessageTemplateResponse

Retrieves a specific WhatsApp message template.

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.listWhatsAppFlowAssets(crossinline block: ListWhatsAppFlowAssetsRequest.Builder.() -> Unit): ListWhatsAppFlowAssetsResponse

Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs. Download URLs are generated by Meta and expire after a short period.

Link copied to clipboard
inline suspend fun SocialMessagingClient.listWhatsAppFlows(crossinline block: ListWhatsAppFlowsRequest.Builder.() -> Unit): ListWhatsAppFlowsResponse

Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.

Link copied to clipboard
inline suspend fun SocialMessagingClient.listWhatsAppMessageTemplates(crossinline block: ListWhatsAppMessageTemplatesRequest.Builder.() -> Unit): ListWhatsAppMessageTemplatesResponse

Lists WhatsApp message templates for a specific WhatsApp Business Account.

Link copied to clipboard
inline suspend fun SocialMessagingClient.listWhatsAppTemplateLibrary(crossinline block: ListWhatsAppTemplateLibraryRequest.Builder.() -> Unit): ListWhatsAppTemplateLibraryResponse

Lists templates available in Meta's template library for WhatsApp messaging.

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.

Link copied to clipboard
inline suspend fun SocialMessagingClient.publishWhatsAppFlow(crossinline block: PublishWhatsAppFlowRequest.Builder.() -> Unit): PublishWhatsAppFlowResponse

Publishes a WhatsApp Flow, making it available for use in template messages. The Flow must be in DRAFT status with valid Flow JSON that passes Meta's validation. This is an irreversible operation.

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
inline suspend fun SocialMessagingClient.updateWhatsAppFlow(crossinline block: UpdateWhatsAppFlowRequest.Builder.() -> Unit): UpdateWhatsAppFlowResponse

Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update the Flow JSON.

Link copied to clipboard
inline suspend fun SocialMessagingClient.updateWhatsAppFlowAssets(crossinline block: UpdateWhatsAppFlowAssetsRequest.Builder.() -> Unit): UpdateWhatsAppFlowAssetsResponse

Updates the Flow JSON definition (assets) of a WhatsApp Flow. Updating a published Flow's assets reverts it to DRAFT status, requiring re-publishing.

Link copied to clipboard
inline suspend fun SocialMessagingClient.updateWhatsAppMessageTemplate(crossinline block: UpdateWhatsAppMessageTemplateRequest.Builder.() -> Unit): UpdateWhatsAppMessageTemplateResponse

Updates an existing WhatsApp message template.

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.

Generated by Dokka
© 2026, Amazon Web Services, Inc. or its affiliates. All rights reserved.