socialmessaging/aws.sdk.kotlin.services.socialmessaging

Package-level declarations

Types

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

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateWhatsAppBusinessAccount

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.

deleteWhatsAppMessageMedia

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.

disassociateWhatsAppBusinessAccount

inline suspend fun SocialMessagingClient.disassociateWhatsAppBusinessAccount(crossinline block: DisassociateWhatsAppBusinessAccountRequest.Builder.() -> Unit): DisassociateWhatsAppBusinessAccountResponse

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

getLinkedWhatsAppBusinessAccount

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

Get the details of your linked WhatsApp Business Account.

getLinkedWhatsAppBusinessAccountPhoneNumber

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.

getWhatsAppMessageMedia

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.

listLinkedWhatsAppBusinessAccounts

inline suspend fun SocialMessagingClient.listLinkedWhatsAppBusinessAccounts(crossinline block: ListLinkedWhatsAppBusinessAccountsRequest.Builder.() -> Unit): ListLinkedWhatsAppBusinessAccountsResponse

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

listTagsForResource

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.

postWhatsAppMessageMedia

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.

putWhatsAppBusinessAccountEventDestinations

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.

sendWhatsAppMessage

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.

tagResource

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.

untagResource

inline suspend fun SocialMessagingClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from a resource.

withConfig

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.