AWS SDK for PHP 3.x

Client: Aws\SocialMessaging\SocialMessagingClient

Service ID: socialmessaging

Version: 2024-01-01

This page describes the parameters and results for the operations of the AWS End User Messaging Social (2024-01-01), and shows how to use the Aws\SocialMessaging\SocialMessagingClient object to call the described operations. This documentation is specific to the 2024-01-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateWhatsAppBusinessAccount ( array $params = [] ): 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 ( array $params = [] ): Delete a media object from the WhatsApp service.
DisassociateWhatsAppBusinessAccount ( array $params = [] ): Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.
GetLinkedWhatsAppBusinessAccount ( array $params = [] ): Get the details of your linked WhatsApp Business Account.
GetLinkedWhatsAppBusinessAccountPhoneNumber ( array $params = [] ): Use your WhatsApp phone number id to get the WABA account id and phone number details.
GetWhatsAppMessageMedia ( array $params = [] ): Get a media file from the WhatsApp service.
ListLinkedWhatsAppBusinessAccounts ( array $params = [] ): List all WhatsApp Business Accounts linked to your Amazon Web Services account.
ListTagsForResource ( array $params = [] ): List all tags associated with a resource, such as a phone number or WABA.
PostWhatsAppMessageMedia ( array $params = [] ): Upload a media file to the WhatsApp service.
PutWhatsAppBusinessAccountEventDestinations ( array $params = [] ): Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA).
SendWhatsAppMessage ( array $params = [] ): Send a WhatsApp message.
TagResource ( array $params = [] ): Adds or overwrites only the specified tags for the specified resource.
UntagResource ( array $params = [] ): Removes the specified tags from a resource.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListLinkedWhatsAppBusinessAccounts

Operations

AssociateWhatsAppBusinessAccount

$result = $client->associateWhatsAppBusinessAccount([/* ... */]);
$promise = $client->associateWhatsAppBusinessAccountAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateWhatsAppBusinessAccount([
    'setupFinalization' => [
        'associateInProgressToken' => '<string>', // REQUIRED
        'phoneNumberParent' => '<string>',
        'phoneNumbers' => [ // REQUIRED
            [
                'dataLocalizationRegion' => '<string>',
                'id' => '<string>', // REQUIRED
                'tags' => [
                    [
                        'key' => '<string>', // REQUIRED
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'twoFactorPin' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'waba' => [
            'eventDestinations' => [
                [
                    'eventDestinationArn' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'id' => '<string>',
            'tags' => [
                [
                    'key' => '<string>', // REQUIRED
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'signupCallback' => [
        'accessToken' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

setupFinalization

: Type: WhatsAppSetupFinalization structure

A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.

signupCallback

: Type: WhatsAppSignupCallback structure

Contains the callback access token.

Result Syntax

[
    'signupCallbackResult' => [
        'associateInProgressToken' => '<string>',
        'linkedAccountsWithIncompleteSetup' => [
            '<WhatsAppBusinessAccountId>' => [
                'accountName' => '<string>',
                'registrationStatus' => 'COMPLETE|INCOMPLETE',
                'unregisteredWhatsAppPhoneNumbers' => [
                    [
                        'arn' => '<string>',
                        'displayPhoneNumber' => '<string>',
                        'displayPhoneNumberName' => '<string>',
                        'metaPhoneNumberId' => '<string>',
                        'phoneNumber' => '<string>',
                        'phoneNumberId' => '<string>',
                        'qualityRating' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'statusCode' => <integer>,
]

Result Details

Members

signupCallbackResult

: Type: WhatsAppSignupCallbackResult structure

Contains your WhatsApp registration status.

statusCode

: Type: int

The status code for the response.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
DependencyException:: Thrown when performing an action because a dependency would be broken.

DeleteWhatsAppMessageMedia

$result = $client->deleteWhatsAppMessageMedia([/* ... */]);
$promise = $client->deleteWhatsAppMessageMediaAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteWhatsAppMessageMedia([
    'mediaId' => '<string>', // REQUIRED
    'originationPhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members

mediaId

: Required: Yes
: Type: string

The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.

originationPhoneNumberId

: Required: Yes
: Type: string

The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

Result Syntax

[
    'success' => true || false,
]

Result Details

Members

success

: Type: boolean

Success indicator for deleting the media file.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource was not found.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
AccessDeniedByMetaException:: You do not have sufficient access to perform this action.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.
DependencyException:: Thrown when performing an action because a dependency would be broken.

DisassociateWhatsAppBusinessAccount

$result = $client->disassociateWhatsAppBusinessAccount([/* ... */]);
$promise = $client->disassociateWhatsAppBusinessAccountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateWhatsAppBusinessAccount([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource was not found.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
DependencyException:: Thrown when performing an action because a dependency would be broken.

GetLinkedWhatsAppBusinessAccount

$result = $client->getLinkedWhatsAppBusinessAccount([/* ... */]);
$promise = $client->getLinkedWhatsAppBusinessAccountAsync([/* ... */]);

Get the details of your linked WhatsApp Business Account.

Parameter Syntax

$result = $client->getLinkedWhatsAppBusinessAccount([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

Result Syntax

[
    'account' => [
        'arn' => '<string>',
        'eventDestinations' => [
            [
                'eventDestinationArn' => '<string>',
            ],
            // ...
        ],
        'id' => '<string>',
        'linkDate' => <DateTime>,
        'phoneNumbers' => [
            [
                'arn' => '<string>',
                'displayPhoneNumber' => '<string>',
                'displayPhoneNumberName' => '<string>',
                'metaPhoneNumberId' => '<string>',
                'phoneNumber' => '<string>',
                'phoneNumberId' => '<string>',
                'qualityRating' => '<string>',
            ],
            // ...
        ],
        'registrationStatus' => 'COMPLETE|INCOMPLETE',
        'wabaId' => '<string>',
        'wabaName' => '<string>',
    ],
]

Result Details

Members

account

: Type: LinkedWhatsAppBusinessAccount structure

The details of the linked WhatsApp Business Account.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource was not found.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.
DependencyException:: Thrown when performing an action because a dependency would be broken.

GetLinkedWhatsAppBusinessAccountPhoneNumber

$result = $client->getLinkedWhatsAppBusinessAccountPhoneNumber([/* ... */]);
$promise = $client->getLinkedWhatsAppBusinessAccountPhoneNumberAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getLinkedWhatsAppBusinessAccountPhoneNumber([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

The unique identifier of the phone number. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

Result Syntax

[
    'linkedWhatsAppBusinessAccountId' => '<string>',
    'phoneNumber' => [
        'arn' => '<string>',
        'displayPhoneNumber' => '<string>',
        'displayPhoneNumberName' => '<string>',
        'metaPhoneNumberId' => '<string>',
        'phoneNumber' => '<string>',
        'phoneNumberId' => '<string>',
        'qualityRating' => '<string>',
    ],
]

Result Details

Members

linkedWhatsAppBusinessAccountId

: Type: string

The WABA identifier linked to the phone number, formatted as waba-01234567890123456789012345678901.

phoneNumber

: Type: WhatsAppPhoneNumberDetail structure

The details of your WhatsApp phone number.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource was not found.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.
DependencyException:: Thrown when performing an action because a dependency would be broken.

GetWhatsAppMessageMedia

$result = $client->getWhatsAppMessageMedia([/* ... */]);
$promise = $client->getWhatsAppMessageMediaAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getWhatsAppMessageMedia([
    'destinationS3File' => [
        'bucketName' => '<string>', // REQUIRED
        'key' => '<string>', // REQUIRED
    ],
    'destinationS3PresignedUrl' => [
        'headers' => ['<string>', ...], // REQUIRED
        'url' => '<string>', // REQUIRED
    ],
    'mediaId' => '<string>', // REQUIRED
    'metadataOnly' => true || false,
    'originationPhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members

destinationS3File

: Type: S3File structure

The bucketName and key of the S3 media file.

destinationS3PresignedUrl

: Type: S3PresignedUrl structure

The presign url of the media file.

mediaId

: Required: Yes
: Type: string

The unique identifier for the media file.

metadataOnly

: Type: boolean

Set to True to get only the metadata for the file.

originationPhoneNumberId

: Required: Yes
: Type: string

The unique identifier of the originating phone number for the WhatsApp message media. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

Result Syntax

[
    'fileSize' => <integer>,
    'mimeType' => '<string>',
]

Result Details

Members

fileSize

: Type: long (int|float)

The file size of the media, in KB.

mimeType

: Type: string

The MIME type of the media.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource was not found.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
AccessDeniedByMetaException:: You do not have sufficient access to perform this action.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.
DependencyException:: Thrown when performing an action because a dependency would be broken.

ListLinkedWhatsAppBusinessAccounts

$result = $client->listLinkedWhatsAppBusinessAccounts([/* ... */]);
$promise = $client->listLinkedWhatsAppBusinessAccountsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listLinkedWhatsAppBusinessAccounts([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to return.

nextToken

: Type: string

The next token for pagination.

Result Syntax

[
    'linkedAccounts' => [
        [
            'arn' => '<string>',
            'eventDestinations' => [
                [
                    'eventDestinationArn' => '<string>',
                ],
                // ...
            ],
            'id' => '<string>',
            'linkDate' => <DateTime>,
            'registrationStatus' => 'COMPLETE|INCOMPLETE',
            'wabaId' => '<string>',
            'wabaName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

linkedAccounts

: Type: Array of LinkedWhatsAppBusinessAccountSummary structures

A list of WhatsApp Business Accounts linked to your Amazon Web Services account.

nextToken

: Type: string

The next token for pagination.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource was not found.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to retrieve the tags from.

Result Syntax

[
    'statusCode' => <integer>,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

statusCode

: Type: int

The status code of the response.

tags

: Type: Array of Tag structures

The tags for the resource.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.

PostWhatsAppMessageMedia

$result = $client->postWhatsAppMessageMedia([/* ... */]);
$promise = $client->postWhatsAppMessageMediaAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->postWhatsAppMessageMedia([
    'originationPhoneNumberId' => '<string>', // REQUIRED
    'sourceS3File' => [
        'bucketName' => '<string>', // REQUIRED
        'key' => '<string>', // REQUIRED
    ],
    'sourceS3PresignedUrl' => [
        'headers' => ['<string>', ...], // REQUIRED
        'url' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

originationPhoneNumberId

: Required: Yes
: Type: string

The ID of the phone number to associate with the WhatsApp media file. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

sourceS3File

: Type: S3File structure

The source S3 url for the media file.

sourceS3PresignedUrl

: Type: S3PresignedUrl structure

The source presign url of the media file.

Result Syntax

[
    'mediaId' => '<string>',
]

Result Details

Members

mediaId

: Type: string

The unique identifier of the posted WhatsApp message.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource was not found.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
AccessDeniedByMetaException:: You do not have sufficient access to perform this action.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.
DependencyException:: Thrown when performing an action because a dependency would be broken.

PutWhatsAppBusinessAccountEventDestinations

$result = $client->putWhatsAppBusinessAccountEventDestinations([/* ... */]);
$promise = $client->putWhatsAppBusinessAccountEventDestinationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putWhatsAppBusinessAccountEventDestinations([
    'eventDestinations' => [ // REQUIRED
        [
            'eventDestinationArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

eventDestinations

: Required: Yes
: Type: Array of WhatsAppBusinessAccountEventDestination structures

An array of WhatsAppBusinessAccountEventDestination event destinations.

id

: Required: Yes
: Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.

SendWhatsAppMessage

$result = $client->sendWhatsAppMessage([/* ... */]);
$promise = $client->sendWhatsAppMessageAsync([/* ... */]);

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 .

Parameter Syntax

$result = $client->sendWhatsAppMessage([
    'message' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'metaApiVersion' => '<string>', // REQUIRED
    'originationPhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Members

message

: Required: Yes
: Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp Message object, see Messages in the WhatsApp Business Platform Cloud API Reference.

metaApiVersion

: Required: Yes
: Type: string

The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.

originationPhoneNumberId

: Required: Yes
: Type: string

The ID of the phone number used to send the WhatsApp message. If you are sending a media file only the originationPhoneNumberId used to upload the file can be used. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

Result Syntax

[
    'messageId' => '<string>',
]

Result Details

Members

messageId

: Type: string

The unique identifier of the message.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource was not found.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.
DependencyException:: Thrown when performing an action because a dependency would be broken.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to tag.

tags

: Required: Yes
: Type: Array of Tag structures

The tags to add to the resource.

Result Syntax

[
    'statusCode' => <integer>,
]

Result Details

Members

statusCode

: Type: int

The status code of the tag resource operation.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to remove tags from.

tagKeys

: Required: Yes
: Type: Array of strings

The keys of the tags to remove from the resource.

Result Syntax

[
    'statusCode' => <integer>,
]

Result Details

Members

statusCode

: Type: int

The status code of the untag resource operation.

Errors

ValidationException:: The request contains an invalid parameter value.
AccessDeniedException:: You do not have sufficient access to perform this action.
InvalidParametersException:: One or more parameters provided to the action are not valid.
ThrottledRequestException:: The request was denied due to request throttling.
InternalServiceException:: The request processing has failed because of an unknown error, exception, or failure.

: Required: Yes
: Type: string

The ARN of the linked WhatsApp Business Account.

eventDestinations

: Required: Yes
: Type: Array of WhatsAppBusinessAccountEventDestination structures

The event destinations for the linked WhatsApp Business Account.

id

: Required: Yes
: Type: string

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

linkDate

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the WhatsApp Business Account was linked.

phoneNumbers

: Required: Yes
: Type: Array of WhatsAppPhoneNumberSummary structures

The phone numbers associated with the Linked WhatsApp Business Account.

registrationStatus

: Required: Yes
: Type: string

The registration status of the linked WhatsApp Business Account.

wabaId

: Required: Yes
: Type: string

The WhatsApp Business Account ID from meta.

wabaName

: Required: Yes
: Type: string

The name of the linked WhatsApp Business Account.

LinkedWhatsAppBusinessAccountIdMetaData

Description

Contains your WhatsApp registration status and details of any unregistered WhatsApp phone number.

Members

accountName

: Type: string

The name of your account.

registrationStatus

: Type: string

The registration status of the linked WhatsApp Business Account.

unregisteredWhatsAppPhoneNumbers

: Type: Array of WhatsAppPhoneNumberDetail structures

The details for unregistered WhatsApp phone numbers.

LinkedWhatsAppBusinessAccountSummary

Description

The details of a linked WhatsApp Business Account.

Members

arn

: Required: Yes
: Type: string

The ARN of the linked WhatsApp Business Account.

eventDestinations

: Required: Yes
: Type: Array of WhatsAppBusinessAccountEventDestination structures

The event destinations for the linked WhatsApp Business Account.

id

: Required: Yes
: Type: string

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

linkDate

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the WhatsApp Business Account was linked.

registrationStatus

: Required: Yes
: Type: string

The registration status of the linked WhatsApp Business Account.

wabaId

: Required: Yes
: Type: string

The WhatsApp Business Account ID provided by Meta.

wabaName

: Required: Yes
: Type: string

The name of the linked WhatsApp Business Account.

ResourceNotFoundException

Description

The resource was not found.

Members

message

: Type: string

S3File

Description

Contains information for the S3 bucket that contains media files.

Members

bucketName

: Required: Yes
: Type: string

The bucket name.

key

: Required: Yes
: Type: string

The object key of the media file.

S3PresignedUrl

Description

You can use presigned URLs to grant time-limited access to objects in Amazon S3 without updating your bucket policy. For more information, see Working with presigned URLs in the Amazon S3 User Guide.

Members

headers

: Required: Yes
: Type: Associative array of custom strings keys (String) to strings

A map of headers and their values. You must specify the Content-Type header when using PostWhatsAppMessageMedia. For a list of common headers, see Common Request Headers in the Amazon S3 API Reference

url

: Required: Yes
: Type: string

: Type: string

The two letter ISO region for the location of where Meta will store data.

Asia–Pacific (APAC)

Australia AU
Indonesia ID
India IN
Japan JP
Singapore SG
South Korea KR

Europe

Germany DE
Switzerland CH
United Kingdom GB

Latin America (LATAM)

Brazil BR

Middle East and Africa (MEA)

Bahrain BH
South Africa ZA
United Arab Emirates AE

North America (NORAM)

Canada CA

id

: Required: Yes
: Type: string

tags

: Type: Array of Tag structures

An array of key and value pair tags.

twoFactorPin

: Required: Yes
: Type: string

The PIN to use for two-step verification. To reset your PIN follow the directions in Updating PIN in the WhatsApp Business Platform Cloud API Reference.

WabaSetupFinalization

Description

The registration details for a linked WhatsApp Business Account.

Members

eventDestinations

: Type: Array of WhatsAppBusinessAccountEventDestination structures

The event destinations for the linked WhatsApp Business Account.

id

: Type: string

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

tags

: Type: Array of Tag structures

An array of key and value pair tags.

WhatsAppBusinessAccountEventDestination

Description

Contains information on the event destination.

Members

eventDestinationArn

: Required: Yes
: Type: string

The ARN of the event destination.

WhatsAppPhoneNumberDetail

Description

The details of your WhatsApp phone number.

Members

arn

: Required: Yes
: Type: string

The ARN of the WhatsApp phone number.

displayPhoneNumber

: Required: Yes
: Type: string

The phone number that appears in the recipients display.

displayPhoneNumberName

: Required: Yes
: Type: string

The display name for this phone number.

metaPhoneNumberId

: Required: Yes
: Type: string

The phone number ID from Meta.

phoneNumber

: Required: Yes
: Type: string

The phone number for sending WhatsApp.

phoneNumberId

: Required: Yes
: Type: string

The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.

qualityRating

: Required: Yes
: Type: string

The quality rating of the phone number.

WhatsAppPhoneNumberSummary

Description

The details of a linked phone number.

Members

arn

: Required: Yes
: Type: string

The full Amazon Resource Name (ARN) for the phone number.

displayPhoneNumber

: Required: Yes
: Type: string

The phone number that appears in the recipients display.

displayPhoneNumberName

: Required: Yes
: Type: string

The display name for this phone number.

metaPhoneNumberId

: Required: Yes
: Type: string

The phone number ID from Meta.

phoneNumber

: Required: Yes
: Type: string

The phone number associated with the Linked WhatsApp Business Account.

phoneNumberId

: Required: Yes
: Type: string

The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.

qualityRating

: Required: Yes
: Type: string

The quality rating of the phone number. This is from Meta.

WhatsAppSetupFinalization

Description

The details of linking a WhatsApp Business Account to your Amazon Web Services account.

Members

associateInProgressToken

: Required: Yes
: Type: string

An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.

phoneNumberParent

: Type: string

Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the waba field is present.

phoneNumbers

: Required: Yes
: Type: Array of WabaPhoneNumberSetupFinalization structures

An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.

waba

: Type: WabaSetupFinalization structure

Used to create a new WhatsApp Business Account and add a phone number. This field can't be used when the phoneNumberParent field is present.

WhatsAppSignupCallback

Description

Contains the accessToken provided by Meta during signup.

Members

accessToken

: Required: Yes
: Type: string

The access token for your WhatsApp Business Account. The accessToken value is provided by Meta.

WhatsAppSignupCallbackResult

Description

Contains the results of WhatsAppSignupCallback.

Members

associateInProgressToken

: Type: string

An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.

linkedAccountsWithIncompleteSetup

: Type: Associative array of custom strings keys (WhatsAppBusinessAccountId) to LinkedWhatsAppBusinessAccountIdMetaData structures

A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.

AWS End User Messaging Social 2024-01-01

Operation Summary

Paginators

Operations

AssociateWhatsAppBusinessAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteWhatsAppMessageMedia

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisassociateWhatsAppBusinessAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetLinkedWhatsAppBusinessAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetLinkedWhatsAppBusinessAccountPhoneNumber

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetWhatsAppMessageMedia

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListLinkedWhatsAppBusinessAccounts

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

PostWhatsAppMessageMedia

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

PutWhatsAppBusinessAccountEventDestinations

Parameter Syntax

Parameter Details

Members

Result Syntax