EndUserMessagingSocial / Client / get_linked_whatsapp_business_account

get_linked_whatsapp_business_account#

EndUserMessagingSocial.Client.get_linked_whatsapp_business_account(**kwargs)#

Get the details of your linked WhatsApp Business Account.

Request Syntax

response = client.get_linked_whatsapp_business_account(
    id='string'
)

Parameters:

id (string) –

[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.

Return type:

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'
            },
        ],
        'phoneNumbers': [
            {
                'arn': 'string',
                'phoneNumber': 'string',
                'phoneNumberId': 'string',
                'metaPhoneNumberId': 'string',
                'displayPhoneNumberName': 'string',
                'displayPhoneNumber': 'string',
                'qualityRating': '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.
  - 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.

Exceptions

EndUserMessagingSocial.Client.exceptions.ValidationException
EndUserMessagingSocial.Client.exceptions.AccessDeniedException
EndUserMessagingSocial.Client.exceptions.ResourceNotFoundException
EndUserMessagingSocial.Client.exceptions.InvalidParametersException
EndUserMessagingSocial.Client.exceptions.ThrottledRequestException
EndUserMessagingSocial.Client.exceptions.InternalServiceException
EndUserMessagingSocial.Client.exceptions.DependencyException