AWS API Changes

2026/08/06 - AWS End User Messaging Social - 2 new2 updated api methods

Changes Add support for WhatsApp Conversions APIs.

SendWhatsAppConversionEvent (new)

Link ¶

Sends a conversion event to Meta's Conversions API for the specified WhatsApp Business Account dataset.

Request Syntax

client.send_whats_app_conversion_event(
    id='string',
    datasetId='string',
    eventData=b'bytes'
)

type id:

string

param id:

[REQUIRED]

The ID of the WhatsApp Business Account associated with the dataset, formatted as waba-01234567890123456789012345678901.

type datasetId:

string

param datasetId:

[REQUIRED]

The Meta-generated dataset ID to send the event to.

type eventData:

bytes

param eventData:

[REQUIRED]

The raw Meta Conversions API event payload as a JSON blob. See Meta's server event parameters for the supported format.

rtype:

dict

returns:

Response Syntax

{
    'requestId': 'string'
}

Response Structure

(dict) --
- requestId (string) --
  
  The unique identifier for the conversion event request.

CreateWhatsAppDataset (new)

Link ¶

Creates a Meta Conversions API dataset for a WhatsApp Business Account.

See also: AWS API Documentation

Request Syntax

client.create_whats_app_dataset(
    id='string'
)

type id:

string

param id:

[REQUIRED]

The ID of the WhatsApp Business Account to create a dataset for, formatted as waba-01234567890123456789012345678901.

rtype:

dict

returns:

Response Syntax

{
    'datasetId': 'string'
}

Response Structure

(dict) --
- datasetId (string) --
  
  The Meta-generated dataset ID, a numeric string of 10 to 20 digits.

GetLinkedWhatsAppBusinessAccount (updated)

Link ¶
Changes (response)

{'account': {'datasetId': 'string'}}

Get the details of your linked WhatsApp Business Account.

See also: AWS API Documentation

Request Syntax

client.get_linked_whatsapp_business_account(
    id='string'
)

type id:

string

param id:

[REQUIRED]

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.

rtype:

dict

returns:

Response Syntax

{
    'account': {
        'arn': 'string',
        'id': 'string',
        'wabaId': 'string',
        'registrationStatus': 'COMPLETE'|'INCOMPLETE',
        'linkDate': datetime(2015, 1, 1),
        'wabaName': 'string',
        'eventDestinations': [
            {
                'eventDestinationArn': 'string',
                'roleArn': 'string'
            },
        ],
        'marketingMessagesOnboardingStatus': 'string',
        'datasetId': 'string',
        'phoneNumbers': [
            {
                'arn': 'string',
                'phoneNumber': 'string',
                'phoneNumberId': 'string',
                'metaPhoneNumberId': 'string',
                'displayPhoneNumberName': 'string',
                'displayPhoneNumber': 'string',
                'qualityRating': 'string',
                'dataLocalizationRegion': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- account (dict) --
  
  The details of the linked WhatsApp Business Account.
  - arn (string) --
    
    The ARN of the linked WhatsApp Business Account.
  - id (string) --
    
    The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
  - wabaId (string) --
    
    The WhatsApp Business Account ID from meta.
  - registrationStatus (string) --
    
    The registration status of the linked WhatsApp Business Account.
  - linkDate (datetime) --
    
    The date the WhatsApp Business Account was linked.
  - wabaName (string) --
    
    The name of the linked WhatsApp Business Account.
  - eventDestinations (list) --
    
    The event destinations for the linked WhatsApp Business Account.
    - (dict) --
      
      Contains information on the event destination.
      - eventDestinationArn (string) --
        
        The ARN of the event destination.
      - roleArn (string) --
        
        The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.
  - marketingMessagesOnboardingStatus (string) --
    
    The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.
  - datasetId (string) --
    
    The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account.
  - phoneNumbers (list) --
    
    The phone numbers associated with the Linked WhatsApp Business Account.
    - (dict) --
      
      The details of a linked phone number.
      - arn (string) --
        
        The full Amazon Resource Name (ARN) for the phone number.
      - phoneNumber (string) --
        
        The phone number associated with the Linked WhatsApp Business Account.
      - phoneNumberId (string) --
        
        The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
      - metaPhoneNumberId (string) --
        
        The phone number ID from Meta.
      - displayPhoneNumberName (string) --
        
        The display name for this phone number.
      - displayPhoneNumber (string) --
        
        The phone number that appears in the recipients display.
      - qualityRating (string) --
        
        The quality rating of the phone number. This is from Meta.
      - dataLocalizationRegion (string) --
        
        The geographic region where the WhatsApp phone number's data is stored and processed.

ListLinkedWhatsAppBusinessAccounts (updated)

Link ¶
Changes (response)

{'linkedAccounts': {'datasetId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_linked_whatsapp_business_accounts(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

The next token for pagination.

type maxResults:

integer

param maxResults:

The maximum number of results to return.

rtype:

dict

returns:

Response Syntax

{
    'linkedAccounts': [
        {
            'arn': 'string',
            'id': 'string',
            'wabaId': 'string',
            'registrationStatus': 'COMPLETE'|'INCOMPLETE',
            'linkDate': datetime(2015, 1, 1),
            'wabaName': 'string',
            'eventDestinations': [
                {
                    'eventDestinationArn': 'string',
                    'roleArn': 'string'
                },
            ],
            'marketingMessagesOnboardingStatus': 'string',
            'datasetId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- linkedAccounts (list) --
  
  A list of WhatsApp Business Accounts linked to your Amazon Web Services account.
  - (dict) --
    
    The details of a linked WhatsApp Business Account.
    - arn (string) --
      
      The ARN of the linked WhatsApp Business Account.
    - id (string) --
      
      The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
    - wabaId (string) --
      
      The WhatsApp Business Account ID provided by Meta.
    - registrationStatus (string) --
      
      The registration status of the linked WhatsApp Business Account.
    - linkDate (datetime) --
      
      The date the WhatsApp Business Account was linked.
    - wabaName (string) --
      
      The name of the linked WhatsApp Business Account.
    - eventDestinations (list) --
      
      The event destinations for the linked WhatsApp Business Account.
      - (dict) --
        
        Contains information on the event destination.
        
        eventDestinationArn (string) --
        
        The ARN of the event destination.
        
        roleArn (string) --
        
        The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.
    - marketingMessagesOnboardingStatus (string) --
      
      The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.
    - datasetId (string) --
      
      The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account.
- nextToken (string) --
  
  The next token for pagination.